Class Agents

constructor

• new Agents(options?: SDKOptions): Agents

  Parameters

  • options: SDKOptions = {}

  Returns Agents

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: CreateAgentParams, options?: RequestOptions): APIPromise<Agent>

  Creates a new Agent (Typed version for SDK).

  Parameters

  • params: CreateAgentParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<Agent>

delete

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

  Deletes an Agent.

  Parameters

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

  Returns APIPromise<Empty>

get

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

  Gets a specific Agent.

  Parameters

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

  Returns APIPromise<Agent>

list

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

  Lists all Agents.

  Parameters

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

  Returns APIPromise<AgentListResponse>