Class Environments

constructor

• new Environments(options?: SDKOptions): Environments

  Parameters

  • options: SDKOptions = {}

  Returns Environments

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,
      >,
  >

createEnvironment

• createEnvironment(
      body: CreateEnvironmentRequest,
      api_version?: string,
      options?: RequestOptions,
  ): APIPromise<Environment>

  Creates an environment.

  Parameters

  • body: CreateEnvironmentRequest
  • Optionalapi_version: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<Environment>

deleteEnvironment

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

  Deletes an environment.

  Parameters

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

  Returns APIPromise<Empty>

getEnvironment

• getEnvironment(
      id: string,
      params?: GetEnvironmentParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<Environment>

  Gets an environment.

  Parameters

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

  Returns APIPromise<Environment>

listEnvironments

• listEnvironments(
      params?: ListEnvironmentsRequest,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<ListEnvironmentsResponse>

  Lists environments.

  Parameters

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

  Returns APIPromise<ListEnvironmentsResponse>