Class SupportApi

SupportApi - object-oriented interface

Hierarchy (View Summary)

BaseAPI
- SupportApi
  - SupportApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

getCase listCases listContacts

Constructors

constructor

new SupportApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): SupportApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SupportApi
Inherited from BaseAPI.constructor
- Defined in api-model/base.ts:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getCase

getCase(
requestParameters: SupportApiGetCaseRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<Case, any, {}, any>>
Retrieve a specific support case.
Parameters
- requestParameters: SupportApiGetCaseRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Case, any, {}, any>>

Throws
- Defined in api-model/api/support-api.ts:296

listCases

listCases(
requestParameters: SupportApiListCasesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ListCasesResult, any, {}, any>>
Retrieve support cases for a selling partner.
Parameters
- requestParameters: SupportApiListCasesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ListCasesResult, any, {}, any>>

Throws
- Defined in api-model/api/support-api.ts:306

listContacts

listContacts(
requestParameters: SupportApiListContactsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ListContactsResult, any, {}, any>>
Retrieve contacts for a specific support case.
Parameters
- requestParameters: SupportApiListContactsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ListContactsResult, any, {}, any>>

Throws
- Defined in api-model/api/support-api.ts:316