Class DepositsApi

Hierarchy

DepositsApi
- DepositsApi

Index

Constructors

Properties

basePath axios configuration

Methods

getDeposit getSignableDeposit listDeposits

Constructors

constructor

new DepositsApi(configuration?, basePath?, axios?): DepositsApi
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns DepositsApi
Inherited from imx.DepositsApi.constructor
- Defined in packages/internal/generated-clients/dist/imx/base.d.ts:43

Properties

`Protected`basePath

basePath: string

`Protected`axios

axios: AxiosInstance

`Protected`configuration

configuration: undefined | Configuration

Methods

getDeposit

getDeposit(requestParameters, options?): Promise<AxiosResponse<Deposit, any>>
Get details of a deposit with the given ID
Parameters
- requestParameters: DepositsApiGetDepositRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<Deposit, any>>
Summary
Get details of a deposit with the given ID

Throws
Memberof
DepositsApi
Inherited from imx.DepositsApi.getDeposit
- Defined in packages/internal/generated-clients/dist/imx/domain/deposits-api.d.ts:298

getSignableDeposit

getSignableDeposit(requestParameters, options?): Promise<AxiosResponse<GetSignableDepositResponse, any>>
Gets details of a signable deposit
Parameters
- requestParameters: DepositsApiGetSignableDepositRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<GetSignableDepositResponse, any>>
Summary
Gets details of a signable deposit

Throws
Memberof
DepositsApi
Inherited from imx.DepositsApi.getSignableDeposit
- Defined in packages/internal/generated-clients/dist/imx/domain/deposits-api.d.ts:307

listDeposits

listDeposits(requestParameters?, options?): Promise<AxiosResponse<ListDepositsResponse, any>>
Get a list of deposits
Parameters
- OptionalrequestParameters: DepositsApiListDepositsRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<ListDepositsResponse, any>>
Summary
Get a list of deposits

Throws
Memberof
DepositsApi
Inherited from imx.DepositsApi.listDeposits
- Defined in packages/internal/generated-clients/dist/imx/domain/deposits-api.d.ts:316