AgentApi

AgentApi - object-oriented interface

Export

AgentApi

Extends

  • BaseAPI

Constructors

new AgentApi()

new AgentApi(configuration?, basePath?, axios?): AgentApi

Parameters

configuration?

basePath?

string = BASE_PATH

axios?

AxiosInstance = globalAxios

Returns

Inherited from

BaseAPI.constructor

Properties

axios

protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios


basePath

protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath


configuration

protected configuration: undefined | Configuration

Inherited from

BaseAPI.configuration

Methods

apiV1AgentsGet()

apiV1AgentsGet(hiddenState?, skip?, take?, options?): Promise<AxiosResponse<AgentResponseDTO[]>>

Parameters

hiddenState?

skip?

number

take?

number

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<AgentResponseDTO[]>>

Throws

Memberof

AgentApi


apiV1AgentsIdGet()

apiV1AgentsIdGet(id, options?): Promise<AxiosResponse<AgentResponseDTO>>

Parameters

id

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<AgentResponseDTO>>

Throws

Memberof

AgentApi


apiV1AgentsIdPatch()

apiV1AgentsIdPatch(id, agentUpdateDTO?, options?): Promise<AxiosResponse<AgentResponseDTO>>

Parameters

id

string

agentUpdateDTO?

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<AgentResponseDTO>>

Throws

Memberof

AgentApi


apiV1AgentsPost()

apiV1AgentsPost(agentCreateRequestDTO?, options?): Promise<AxiosResponse<AgentResponseDTO>>

Parameters

agentCreateRequestDTO?

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<AgentResponseDTO>>

Throws

Memberof

AgentApi

Found a mistake? Let us know.

Enroll in beta

Request invite to our private Beta program for developers to join the waitlist. No spam, we promise.