Class WithdrawalsApi

Hierarchy

WithdrawalsApi
- WithdrawalsApi

Index

Constructors

constructor

new WithdrawalsApi(configuration?, basePath?, axios?): WithdrawalsApi
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns WithdrawalsApi
Inherited from imx.WithdrawalsApi.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

createWithdrawal

createWithdrawal(requestParameters, options?): Promise<AxiosResponse<CreateWithdrawalResponse, any>>
Creates a withdrawal. Use https://docs.x.immutable.com/reference/#/operations/getSignableWithdrawal to get request body params. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/createWithdrawalV2.
Parameters
- requestParameters: WithdrawalsApiCreateWithdrawalRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<CreateWithdrawalResponse, any>>
Summary
Creates a withdrawal

Throws
Memberof
WithdrawalsApi
Inherited from imx.WithdrawalsApi.createWithdrawal
- Defined in packages/internal/generated-clients/dist/imx/domain/withdrawals-api.d.ts:467

createWithdrawalV2

createWithdrawalV2(requestParameters, options?): Promise<AxiosResponse<CreateWithdrawalResponse, any>>
Creates a withdrawal. Use https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2 to get request body params.
Parameters
- requestParameters: WithdrawalsApiCreateWithdrawalV2Request
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<CreateWithdrawalResponse, any>>
Summary
Creates a withdrawal of a token for when StarkEx contract that is higher than v3

Throws
Memberof
WithdrawalsApi
Inherited from imx.WithdrawalsApi.createWithdrawalV2
- Defined in packages/internal/generated-clients/dist/imx/domain/withdrawals-api.d.ts:476

getSignableWithdrawal

getSignableWithdrawal(requestParameters, options?): Promise<AxiosResponse<GetSignableWithdrawalResponse, any>>
Gets details of a signable withdrawal. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2.
Parameters
- requestParameters: WithdrawalsApiGetSignableWithdrawalRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<GetSignableWithdrawalResponse, any>>
Summary
Gets details of a signable withdrawal

Throws
Memberof
WithdrawalsApi
Inherited from imx.WithdrawalsApi.getSignableWithdrawal
- Defined in packages/internal/generated-clients/dist/imx/domain/withdrawals-api.d.ts:485

getSignableWithdrawalV2

getSignableWithdrawalV2(requestParameters, options?): Promise<AxiosResponse<GetSignableWithdrawalResponseV2, any>>
Gets details of a signable withdrawal
Parameters
- requestParameters: WithdrawalsApiGetSignableWithdrawalV2Request
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<GetSignableWithdrawalResponseV2, any>>
Summary
Gets details of a signable withdrawal for starkex contracts that are higher than v3

Throws
Memberof
WithdrawalsApi
Inherited from imx.WithdrawalsApi.getSignableWithdrawalV2
- Defined in packages/internal/generated-clients/dist/imx/domain/withdrawals-api.d.ts:494

getWithdrawal

getWithdrawal(requestParameters, options?): Promise<AxiosResponse<Withdrawal, any>>
Gets details of withdrawal with the given ID
Parameters
- requestParameters: WithdrawalsApiGetWithdrawalRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<Withdrawal, any>>
Summary
Gets details of withdrawal with the given ID

Throws
Memberof
WithdrawalsApi
Inherited from imx.WithdrawalsApi.getWithdrawal
- Defined in packages/internal/generated-clients/dist/imx/domain/withdrawals-api.d.ts:503

listWithdrawals

listWithdrawals(requestParameters?, options?): Promise<AxiosResponse<ListWithdrawalsResponse, any>>
Get a list of withdrawals
Parameters
- OptionalrequestParameters: WithdrawalsApiListWithdrawalsRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<ListWithdrawalsResponse, any>>
Summary
Get a list of withdrawals

Throws
Memberof
WithdrawalsApi
Inherited from imx.WithdrawalsApi.listWithdrawals
- Defined in packages/internal/generated-clients/dist/imx/domain/withdrawals-api.d.ts:512

Class WithdrawalsApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WithdrawalsApi

Properties

ProtectedbasePath

Protectedaxios

Protectedconfiguration

Methods

createWithdrawal

Parameters

Returns Promise<AxiosResponse<CreateWithdrawalResponse, any>>

Summary

Throws

Memberof

createWithdrawalV2

Parameters

Returns Promise<AxiosResponse<CreateWithdrawalResponse, any>>

Summary

Throws

Memberof

getSignableWithdrawal

Parameters

Returns Promise<AxiosResponse<GetSignableWithdrawalResponse, any>>

Summary

Throws

Memberof

getSignableWithdrawalV2

Parameters

Returns Promise<AxiosResponse<GetSignableWithdrawalResponseV2, any>>

Summary

Throws

Memberof

getWithdrawal

Parameters

Returns Promise<AxiosResponse<Withdrawal, any>>

Summary

Throws

Memberof

listWithdrawals

Parameters

Returns Promise<AxiosResponse<ListWithdrawalsResponse, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`basePath

`Protected`axios

`Protected`configuration