Class Certificates

Hierarchy (View Summary)

BaseAPI
- Certificates

Index

Constructors

Properties

Accessors

Methods

create delete get getAll request update

Constructors

constructor

new Certificates(token: string, baseUrl?: string): Certificates
Parameters
- token: string
- OptionalbaseUrl: string
Returns Certificates
Inherited from BaseAPI.constructor
- Defined in base.ts:7

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Accessors

actions

get actions(): CertificateActions
Returns CertificateActions
- Defined in security/certificates.ts:96

Methods

create

create(
    params: CreateCertificateParams,
): Promise<
    | { response: Certificate; success: true }
    | { response: APIError; success: false },
>
Create a new certificate
Parameters
- params: CreateCertificateParams
  Parameters for creating the certificate
Returns Promise<
| { response: Certificate; success: true }
| { response: APIError; success: false },
>
- Defined in security/certificates.ts:60

delete

delete(
    id: number,
): Promise<
    | { response: null; success: true }
    | { response: APIError; success: false },
>
Delete a certificate
Parameters
- id: number
  The certificate ID
Returns Promise<
| { response: null; success: true }
| { response: APIError; success: false },
>
- Defined in security/certificates.ts:88

get

get(
    id: number,
): Promise<
    | { response: Certificate; success: true }
    | { response: APIError; success: false },
>
Get a specific certificate by ID
Parameters
- id: number
  The certificate ID
Returns Promise<
| { response: Certificate; success: true }
| { response: APIError; success: false },
>
- Defined in security/certificates.ts:50

getAll

getAll(
    params?: ListCertificatesParams,
): Promise<
    | { response: CertificatesResponse; success: true }
    | { response: APIError; success: false },
>
List all certificates with optional filtering and pagination
Parameters
- Optionalparams: ListCertificatesParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: CertificatesResponse; success: true }
| { response: APIError; success: false },
>
- Defined in security/certificates.ts:26

request

request<T>(
    endpoint: string,
    options?: RequestInit,
): Promise<
    { response: T; success: true }
    | { response: APIError; success: false },
>
Type Parameters
- T
Parameters
- endpoint: string
- options: RequestInit = {}
Returns Promise<{ response: T; success: true } | { response: APIError; success: false }>
Inherited from BaseAPI.request
- Defined in base.ts:12

update

update(
    id: number,
    params: UpdateCertificateParams,
): Promise<
    | { response: Certificate; success: true }
    | { response: APIError; success: false },
>
Update a certificate's properties
Parameters
- id: number
  The certificate ID
- params: UpdateCertificateParams
  Parameters to update
Returns Promise<
| { response: Certificate; success: true }
| { response: APIError; success: false },
>
- Defined in security/certificates.ts:74