Class Credentials

constructor

• new Credentials(options?: SDKOptions): Credentials

  Parameters

  • options: SDKOptions = {}

  Returns Credentials

Readonly_baseURL

Readonly_hooks

Readonly_httpClient

Optional Readonly_logger

Readonly_options

_createRequest

• _createRequest(
      context: HookContext,
      conf: RequestConfig,
      options?: RequestOptions,
  ): Result<Request, UnexpectedClientError | InvalidRequestError>

  Parameters

  • context: HookContext
  • conf: RequestConfig
  • Optionaloptions: RequestOptions

  Returns Result<Request, UnexpectedClientError | InvalidRequestError>

_do

• _do(
      request: Request,
      options: {
          context: HookContext;
          isErrorStatusCode: (statusCode: number) => boolean;
          retryCodes: string[];
          retryConfig: RetryConfig;
      },
  ): Promise<
      Result<
          Response,
          | UnexpectedClientError
          | RequestAbortedError
          | RequestTimeoutError
          | ConnectionError,
      >,
  >

  Parameters

  • request: Request
  • options: {
        context: HookContext;
        isErrorStatusCode: (statusCode: number) => boolean;
        retryCodes: string[];
        retryConfig: RetryConfig;
    }

  Returns Promise<
      Result<
          Response,
          | UnexpectedClientError
          | RequestAbortedError
          | RequestTimeoutError
          | ConnectionError,
      >,
  >

create

• create(
      params: CreateCredentialParams,
      options?: RequestOptions,
  ): APIPromise<Credential>

  Creates a new credential.

  Parameters

  • params: CreateCredentialParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<Credential>

delete

• delete(
      id: string,
      params?: DeleteCredentialParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<Empty>

  Deletes a credential.

  Parameters

  • id: string
  • Optionalparams: DeleteCredentialParams
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<Empty>

get

• get(
      id: string,
      params?: GetCredentialParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<Credential>

  Gets a credential by ID.

  Parameters

  • id: string
  • Optionalparams: GetCredentialParams
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<Credential>

list

• list(
      params?: ListCredentialsRequest,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<CredentialListResponse>

  Lists credentials.

  Parameters

  • Optionalparams: ListCredentialsRequest
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<CredentialListResponse>

update

• update(
      id: string,
      params: UpdateCredentialParams,
      options?: RequestOptions,
  ): APIPromise<Credential>

  Updates a credential.

  Parameters

  • id: string
  • params: UpdateCredentialParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<Credential>