Class ApplicationsApi

ApplicationsApi - object-oriented interface

export

Hierarchy

BaseAPI
- ApplicationsApi

Index

Constructors

constructor

Methods

Constructors

constructor

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

Inherited from BaseAPI.constructor
- Defined in base.ts:51
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ApplicationsApi

Methods

createApplication

createApplication(requestParameters: ApplicationsApiCreateApplicationRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<CreatedApplication, any>>

- Defined in api.ts:7267
Create an OAuth2 application.

throws
{RequiredError}

memberof
ApplicationsApi

Parameters
- requestParameters: ApplicationsApiCreateApplicationRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<CreatedApplication, any>>

deleteApplication

deleteApplication(requestParameters: ApplicationsApiDeleteApplicationRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<void, any>>

- Defined in api.ts:7283
Delete an application.

throws
{RequiredError}

memberof
ApplicationsApi

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

getApplication

getApplication(requestParameters: ApplicationsApiGetApplicationRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<Application, any>>

- Defined in api.ts:7299
Get an application.

throws
{RequiredError}

memberof
ApplicationsApi

Parameters
- requestParameters: ApplicationsApiGetApplicationRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<Application, any>>

getApplications

getApplications(requestParameters?: ApplicationsApiGetApplicationsRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<ApplicationList, any>>

- Defined in api.ts:7315
Get applications.

throws
{RequiredError}

memberof
ApplicationsApi

Parameters
- requestParameters: ApplicationsApiGetApplicationsRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<ApplicationList, any>>

updateApplication

updateApplication(requestParameters: ApplicationsApiUpdateApplicationRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<Application, any>>

- Defined in api.ts:7335
Update an application.

throws
{RequiredError}

memberof
ApplicationsApi

Parameters
- requestParameters: ApplicationsApiUpdateApplicationRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<Application, any>>