Class ClientsApi

ClientsApi - object-oriented interface

export

Hierarchy

BaseAPI
- ClientsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ClientsApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): ClientsApi

Inherited from BaseAPI.constructor
- Defined in api/base.ts:50
Parameters
- Optional configuration: Configuration
- basePath: string = ...
- axios: AxiosInstance = ...
Returns ClientsApi

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

addClient

addClient(requestParameters: ClientsApiAddClientRequest, options?: any): Promise<AxiosResponse<ClientsResponse>>

- Defined in api/api.ts:6224
Create an API client.

summary

add_client

throws

{RequiredError}

memberof

ClientsApi

Parameters
- requestParameters: ClientsApiAddClientRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<ClientsResponse>>

deleteClient

deleteClient(requestParameters: ClientsApiDeleteClientRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:6236
Delete a registered client, specified by client ID.

summary

delete_client

throws

{RequiredError}

memberof

ClientsApi

Parameters
- requestParameters: ClientsApiDeleteClientRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<void>>

getClientById

getClientById(requestParameters: ClientsApiGetClientByIdRequest, options?: any): Promise<AxiosResponse<ClientsResponse>>

- Defined in api/api.ts:6248
Get information about a specific registered client, specified by the client ID returned in the GET response.

summary

get_client_by_id

throws

{RequiredError}

memberof

ClientsApi

Parameters
- requestParameters: ClientsApiGetClientByIdRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<ClientsResponse>>

getClients

getClients(options?: any): Promise<AxiosResponse<ClientsResponse[]>>

- Defined in api/api.ts:6259
Get a listing of clients currently registered to use the Aspera on Cloud API.

summary

get_clients

throws

{RequiredError}

memberof

ClientsApi

Parameters
- Optional options: any
Returns Promise<AxiosResponse<ClientsResponse[]>>

updateClient

updateClient(requestParameters: ClientsApiUpdateClientRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:6271
Update a registered client. For example, change the redirect URI and the admin node token retrieval parameters.

summary

update_client

throws

{RequiredError}

memberof

ClientsApi

Parameters
- requestParameters: ClientsApiUpdateClientRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<void>>