Class ExchangeTransfers

ExchangeTransfers - object-oriented interface

export

Hierarchy

BaseAPI
- ExchangeTransfers

Index

Constructors

constructor

Methods

Constructors

constructor

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

Inherited from BaseAPI.constructor
- Defined in src/openapi/base.ts:52
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ExchangeTransfers

Methods

commit

commit(exchangeTransferId: string, options?: any): Promise<AxiosResponse<ExchangeTransferResult>>

- Defined in src/openapi/api.ts:4307
summary
Commit an exchange transfer

throws
{RequiredError}

memberof
ExchangeTransfers

Parameters
- exchangeTransferId: string
  
  Exchange transfer ID
- Optional options: any
Returns Promise<AxiosResponse<ExchangeTransferResult>>

create

create(exchangeTransferParams: ExchangeTransferParams, options?: any): Promise<AxiosResponse<ExchangeTransferResult>>

- Defined in src/openapi/api.ts:4319
summary
Create an exchange transfer

throws
{RequiredError}

memberof
ExchangeTransfers

Parameters
- exchangeTransferParams: ExchangeTransferParams
- Optional options: any
Returns Promise<AxiosResponse<ExchangeTransferResult>>

retrieve

retrieve(exchangeTransferId: string, options?: any): Promise<AxiosResponse<ExchangeTransferResult>>

- Defined in src/openapi/api.ts:4331
summary
Retrieve an exchange transfer

throws
{RequiredError}

memberof
ExchangeTransfers

Parameters
- exchangeTransferId: string
  
  Exchange transfer ID
- Optional options: any
Returns Promise<AxiosResponse<ExchangeTransferResult>>

Generated using TypeDoc