Class QuickConnectApi

QuickConnectApi - object-oriented interface

Export

QuickConnectApi

Hierarchy

BaseAPI
- QuickConnectApi

Index

Constructors

Properties

axios basePath configuration

Methods

authorizeQuickConnect getQuickConnectEnabled getQuickConnectState initiateQuickConnect

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

authorizeQuickConnect

authorizeQuickConnect(
requestParameters: QuickConnectApiAuthorizeQuickConnectRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<boolean, any, {}>>
Parameters
- requestParameters: QuickConnectApiAuthorizeQuickConnectRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<boolean, any, {}>>
Throws
Memberof
QuickConnectApi
- Defined in generated-client/api/quick-connect-api.ts:337

getQuickConnectEnabled

getQuickConnectEnabled(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<boolean, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<boolean, any, {}>>
Throws
Memberof
QuickConnectApi
- Defined in generated-client/api/quick-connect-api.ts:348

getQuickConnectState

getQuickConnectState(
requestParameters: QuickConnectApiGetQuickConnectStateRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<QuickConnectResult, any, {}>>
Parameters
- requestParameters: QuickConnectApiGetQuickConnectStateRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<QuickConnectResult, any, {}>>
Throws
Memberof
QuickConnectApi
- Defined in generated-client/api/quick-connect-api.ts:360

initiateQuickConnect

initiateQuickConnect(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<QuickConnectResult, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<QuickConnectResult, any, {}>>
Throws
Memberof
QuickConnectApi
- Defined in generated-client/api/quick-connect-api.ts:371