Class DomainApi

DomainApi - object-oriented interface

Export

DomainApi

Hierarchy

BaseAPI
- DomainApi

Index

Constructors

constructor

new DomainApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): DomainApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns DomainApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

domainControllerCreate

domainControllerCreate(
domainCreateInputDTO?: DomainCreateInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<DomainCreateOutputDTOAPI>>
OperationId: DomainControllerCreate
Parameters
- OptionaldomainCreateInputDTO: DomainCreateInputDTO
  DomainCreateInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DomainCreateOutputDTOAPI>>
Throws
Memberof
DomainApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12881

domainControllerGetOne

domainControllerGetOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<DomainOutputDTOAPI>>
OperationId: DomainControllerGetOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DomainOutputDTOAPI>>
Throws
Memberof
DomainApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12895

domainControllerGetToken

domainControllerGetToken(
tokenInputDTO?: TokenInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<TokenOutputDTOAPI>>
OperationId: DomainControllerGetToken
Parameters
- OptionaltokenInputDTO: TokenInputDTO
  TokenInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TokenOutputDTOAPI>>
Throws
Memberof
DomainApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12909

domainControllerRemove

domainControllerRemove(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
OperationId: DomainControllerRemove
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Throws
Memberof
DomainApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12923

domainControllerSearch

domainControllerSearch(
domainSearchInputDTO?: DomainSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<DomainOutputArrayDTOAPI>>
OperationId: DomainControllerSearch
Parameters
- OptionaldomainSearchInputDTO: DomainSearchInputDTO
  DomainSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DomainOutputArrayDTOAPI>>
Throws
Memberof
DomainApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12937

domainControllerUpdate

domainControllerUpdate(
    id: string,
    domainUpdateInputDTO?: DomainUpdateInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<DomainOutputDTOAPI>>
OperationId: DomainControllerUpdate
Parameters
- id: string
- OptionaldomainUpdateInputDTO: DomainUpdateInputDTO
  DomainUpdateInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DomainOutputDTOAPI>>
Throws
Memberof
DomainApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12952

Class DomainApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DomainApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

domainControllerCreate

Parameters

Returns Promise<AxiosResponse<DomainCreateOutputDTOAPI>>

Throws

Memberof

domainControllerGetOne

Parameters

Returns Promise<AxiosResponse<DomainOutputDTOAPI>>

Throws

Memberof

domainControllerGetToken

Parameters

Returns Promise<AxiosResponse<TokenOutputDTOAPI>>

Throws

Memberof

domainControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput>>

Throws

Memberof

domainControllerSearch

Parameters

Returns Promise<AxiosResponse<DomainOutputArrayDTOAPI>>

Throws

Memberof

domainControllerUpdate

Parameters

Returns Promise<AxiosResponse<DomainOutputDTOAPI>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration