Class DomainApi

DomainApi - object-oriented interface

Export

DomainApi

Hierarchy

BaseAPI
- DomainApi

Index

Constructors

Properties

axios basePath configuration

Methods

domainControllerCreate domainControllerGetOne domainControllerGetToken domainControllerRemove domainControllerSearch domainControllerUpdate

Constructors

constructor

new DomainApi(configuration?, basePath?, axios?): 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?, options?): Promise<AxiosResponse<DomainCreateOutputDTOAPI, any>>
Parameters
- OptionaldomainCreateInputDTO: DomainCreateInputDTO
  DomainCreateInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DomainCreateOutputDTOAPI, any>>
Summary
Create

Throws
Memberof
DomainApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12729

domainControllerGetOne

domainControllerGetOne(id, options?): Promise<AxiosResponse<DomainOutputDTOAPI, any>>
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DomainOutputDTOAPI, any>>
Summary
Get one

Throws
Memberof
DomainApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12743

domainControllerGetToken

domainControllerGetToken(tokenInputDTO?, options?): Promise<AxiosResponse<TokenOutputDTOAPI, any>>
Parameters
- OptionaltokenInputDTO: TokenInputDTO
  TokenInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TokenOutputDTOAPI, any>>
Summary
Get token

Throws
Memberof
DomainApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12757

domainControllerRemove

domainControllerRemove(id, options?): Promise<AxiosResponse<APIOutput, any>>
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Remove

Throws
Memberof
DomainApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12771

domainControllerSearch

domainControllerSearch(domainSearchInputDTO?, options?): Promise<AxiosResponse<DomainOutputArrayDTOAPI, any>>
Parameters
- OptionaldomainSearchInputDTO: DomainSearchInputDTO
  DomainSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DomainOutputArrayDTOAPI, any>>
Summary
Search

Throws
Memberof
DomainApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12785

domainControllerUpdate

domainControllerUpdate(id, domainUpdateInputDTO?, options?): Promise<AxiosResponse<DomainOutputDTOAPI, any>>
Parameters
- id: string
- OptionaldomainUpdateInputDTO: DomainUpdateInputDTO
  DomainUpdateInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DomainOutputDTOAPI, any>>
Summary
Update

Throws
Memberof
DomainApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12800