Class PlatformFeesApi

PlatformFeesApi - object-oriented interface

Export

Hierarchy

BaseAPI
- PlatformFeesApi

Index

Constructors

Properties

axios basePath configuration

Methods

getPlatformFee listPlatformFees

Constructors

constructor

new PlatformFeesApi(configuration?, basePath?, axios?): PlatformFeesApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PlatformFeesApi
Inherited from BaseAPI.constructor
- Defined in base.ts:56

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

getPlatformFee

getPlatformFee(requestParameters, options?): Promise<AxiosResponse<PlatformFee, any>>
Retrieves the details of a collected Platform Fee.

Summary
Get a Platform Fee

Throws

Memberof
PlatformFeesApi
Parameters
- requestParameters: PlatformFeesApiGetPlatformFeeRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PlatformFee, any>>
- Defined in api/platform-fees-api.ts:315

listPlatformFees

listPlatformFees(requestParameters, options?): Promise<AxiosResponse<ListPlatformFees200Response, any>>
Returns a list of Platform Fees. The Platform Fees are sorted with the most recently created appearing first.

Summary
List all Platform Fees

Throws

Memberof
PlatformFeesApi
Parameters
- requestParameters: PlatformFeesApiListPlatformFeesRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<ListPlatformFees200Response, any>>
- Defined in api/platform-fees-api.ts:327

Generated using TypeDoc