@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/imx/domain/withdrawals-api.d.ts

@@ -0,0 +1,513 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateWithdrawalRequest } from '../models';
+import { CreateWithdrawalRequestV2 } from '../models';
+import { CreateWithdrawalResponse } from '../models';
+import { GetSignableWithdrawalRequest } from '../models';
+import { GetSignableWithdrawalResponse } from '../models';
+import { GetSignableWithdrawalResponseV2 } from '../models';
+import { ListWithdrawalsResponse } from '../models';
+import { Withdrawal } from '../models';
+/**
+ * WithdrawalsApi - axios parameter creator
+ * @export
+ */
+export declare const WithdrawalsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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.
+     * @summary Creates a withdrawal
+     * @param {string} xImxEthAddress eth address
+     * @param {string} xImxEthSignature eth signature
+     * @param {CreateWithdrawalRequest} createWithdrawalRequest create a withdrawal
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createWithdrawal: (xImxEthAddress: string, xImxEthSignature: string, createWithdrawalRequest: CreateWithdrawalRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Creates a withdrawal. Use https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2 to get request body params.
+     * @summary Creates a withdrawal of a token for when StarkEx contract that is higher than v3
+     * @param {string} xImxEthAddress eth address
+     * @param {string} xImxEthSignature eth signature
+     * @param {CreateWithdrawalRequestV2} createWithdrawalRequestV2 create a withdrawal
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createWithdrawalV2: (xImxEthAddress: string, xImxEthSignature: string, createWithdrawalRequestV2: CreateWithdrawalRequestV2, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Gets details of a signable withdrawal
+     * @param {GetSignableWithdrawalRequest} getSignableWithdrawalRequest get details of signable withdrawal
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignableWithdrawal: (getSignableWithdrawalRequest: GetSignableWithdrawalRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Gets details of a signable withdrawal
+     * @summary Gets details of a signable withdrawal for starkex contracts that are higher than v3
+     * @param {GetSignableWithdrawalRequest} getSignableWithdrawalRequest get details of signable withdrawal
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignableWithdrawalV2: (getSignableWithdrawalRequest: GetSignableWithdrawalRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Gets details of withdrawal with the given ID
+     * @summary Gets details of withdrawal with the given ID
+     * @param {string} id Withdrawal ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWithdrawal: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a list of withdrawals
+     * @summary Get a list of withdrawals
+     * @param {boolean} [withdrawnToWallet] Withdrawal has been transferred to user\&#39;s Layer 1 wallet
+     * @param {string} [rollupStatus] Status of the on-chain batch confirmation for this withdrawal
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {string} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {string} [user] Ethereum address of the user who submitted this withdrawal
+     * @param {string} [status] Status of this withdrawal
+     * @param {string} [minTimestamp] Minimum timestamp for this deposit, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [maxTimestamp] Maximum timestamp for this deposit, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [tokenType] Token type of the withdrawn asset
+     * @param {string} [tokenId] ERC721 Token ID of the minted asset
+     * @param {string} [assetId] Internal IMX ID of the minted asset
+     * @param {string} [tokenAddress] Token address of the withdrawn asset
+     * @param {string} [tokenName] Token name of the withdrawn asset
+     * @param {string} [minQuantity] Min quantity for the withdrawn asset
+     * @param {string} [maxQuantity] Max quantity for the withdrawn asset
+     * @param {string} [metadata] JSON-encoded metadata filters for the withdrawn asset
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listWithdrawals: (withdrawnToWallet?: boolean, rollupStatus?: string, pageSize?: number, cursor?: string, orderBy?: string, direction?: string, user?: string, status?: string, minTimestamp?: string, maxTimestamp?: string, tokenType?: string, tokenId?: string, assetId?: string, tokenAddress?: string, tokenName?: string, minQuantity?: string, maxQuantity?: string, metadata?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * WithdrawalsApi - functional programming interface
+ * @export
+ */
+export declare const WithdrawalsApiFp: (configuration?: Configuration) => {
+    /**
+     * 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.
+     * @summary Creates a withdrawal
+     * @param {string} xImxEthAddress eth address
+     * @param {string} xImxEthSignature eth signature
+     * @param {CreateWithdrawalRequest} createWithdrawalRequest create a withdrawal
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createWithdrawal(xImxEthAddress: string, xImxEthSignature: string, createWithdrawalRequest: CreateWithdrawalRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateWithdrawalResponse>>;
+    /**
+     * Creates a withdrawal. Use https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2 to get request body params.
+     * @summary Creates a withdrawal of a token for when StarkEx contract that is higher than v3
+     * @param {string} xImxEthAddress eth address
+     * @param {string} xImxEthSignature eth signature
+     * @param {CreateWithdrawalRequestV2} createWithdrawalRequestV2 create a withdrawal
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createWithdrawalV2(xImxEthAddress: string, xImxEthSignature: string, createWithdrawalRequestV2: CreateWithdrawalRequestV2, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateWithdrawalResponse>>;
+    /**
+     * 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.
+     * @summary Gets details of a signable withdrawal
+     * @param {GetSignableWithdrawalRequest} getSignableWithdrawalRequest get details of signable withdrawal
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignableWithdrawal(getSignableWithdrawalRequest: GetSignableWithdrawalRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSignableWithdrawalResponse>>;
+    /**
+     * Gets details of a signable withdrawal
+     * @summary Gets details of a signable withdrawal for starkex contracts that are higher than v3
+     * @param {GetSignableWithdrawalRequest} getSignableWithdrawalRequest get details of signable withdrawal
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignableWithdrawalV2(getSignableWithdrawalRequest: GetSignableWithdrawalRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSignableWithdrawalResponseV2>>;
+    /**
+     * Gets details of withdrawal with the given ID
+     * @summary Gets details of withdrawal with the given ID
+     * @param {string} id Withdrawal ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWithdrawal(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Withdrawal>>;
+    /**
+     * Get a list of withdrawals
+     * @summary Get a list of withdrawals
+     * @param {boolean} [withdrawnToWallet] Withdrawal has been transferred to user\&#39;s Layer 1 wallet
+     * @param {string} [rollupStatus] Status of the on-chain batch confirmation for this withdrawal
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {string} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {string} [user] Ethereum address of the user who submitted this withdrawal
+     * @param {string} [status] Status of this withdrawal
+     * @param {string} [minTimestamp] Minimum timestamp for this deposit, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [maxTimestamp] Maximum timestamp for this deposit, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [tokenType] Token type of the withdrawn asset
+     * @param {string} [tokenId] ERC721 Token ID of the minted asset
+     * @param {string} [assetId] Internal IMX ID of the minted asset
+     * @param {string} [tokenAddress] Token address of the withdrawn asset
+     * @param {string} [tokenName] Token name of the withdrawn asset
+     * @param {string} [minQuantity] Min quantity for the withdrawn asset
+     * @param {string} [maxQuantity] Max quantity for the withdrawn asset
+     * @param {string} [metadata] JSON-encoded metadata filters for the withdrawn asset
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listWithdrawals(withdrawnToWallet?: boolean, rollupStatus?: string, pageSize?: number, cursor?: string, orderBy?: string, direction?: string, user?: string, status?: string, minTimestamp?: string, maxTimestamp?: string, tokenType?: string, tokenId?: string, assetId?: string, tokenAddress?: string, tokenName?: string, minQuantity?: string, maxQuantity?: string, metadata?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWithdrawalsResponse>>;
+};
+/**
+ * WithdrawalsApi - factory interface
+ * @export
+ */
+export declare const WithdrawalsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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.
+     * @summary Creates a withdrawal
+     * @param {string} xImxEthAddress eth address
+     * @param {string} xImxEthSignature eth signature
+     * @param {CreateWithdrawalRequest} createWithdrawalRequest create a withdrawal
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createWithdrawal(xImxEthAddress: string, xImxEthSignature: string, createWithdrawalRequest: CreateWithdrawalRequest, options?: any): AxiosPromise<CreateWithdrawalResponse>;
+    /**
+     * Creates a withdrawal. Use https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2 to get request body params.
+     * @summary Creates a withdrawal of a token for when StarkEx contract that is higher than v3
+     * @param {string} xImxEthAddress eth address
+     * @param {string} xImxEthSignature eth signature
+     * @param {CreateWithdrawalRequestV2} createWithdrawalRequestV2 create a withdrawal
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createWithdrawalV2(xImxEthAddress: string, xImxEthSignature: string, createWithdrawalRequestV2: CreateWithdrawalRequestV2, options?: any): AxiosPromise<CreateWithdrawalResponse>;
+    /**
+     * 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.
+     * @summary Gets details of a signable withdrawal
+     * @param {GetSignableWithdrawalRequest} getSignableWithdrawalRequest get details of signable withdrawal
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignableWithdrawal(getSignableWithdrawalRequest: GetSignableWithdrawalRequest, options?: any): AxiosPromise<GetSignableWithdrawalResponse>;
+    /**
+     * Gets details of a signable withdrawal
+     * @summary Gets details of a signable withdrawal for starkex contracts that are higher than v3
+     * @param {GetSignableWithdrawalRequest} getSignableWithdrawalRequest get details of signable withdrawal
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignableWithdrawalV2(getSignableWithdrawalRequest: GetSignableWithdrawalRequest, options?: any): AxiosPromise<GetSignableWithdrawalResponseV2>;
+    /**
+     * Gets details of withdrawal with the given ID
+     * @summary Gets details of withdrawal with the given ID
+     * @param {string} id Withdrawal ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWithdrawal(id: string, options?: any): AxiosPromise<Withdrawal>;
+    /**
+     * Get a list of withdrawals
+     * @summary Get a list of withdrawals
+     * @param {boolean} [withdrawnToWallet] Withdrawal has been transferred to user\&#39;s Layer 1 wallet
+     * @param {string} [rollupStatus] Status of the on-chain batch confirmation for this withdrawal
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {string} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {string} [user] Ethereum address of the user who submitted this withdrawal
+     * @param {string} [status] Status of this withdrawal
+     * @param {string} [minTimestamp] Minimum timestamp for this deposit, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [maxTimestamp] Maximum timestamp for this deposit, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [tokenType] Token type of the withdrawn asset
+     * @param {string} [tokenId] ERC721 Token ID of the minted asset
+     * @param {string} [assetId] Internal IMX ID of the minted asset
+     * @param {string} [tokenAddress] Token address of the withdrawn asset
+     * @param {string} [tokenName] Token name of the withdrawn asset
+     * @param {string} [minQuantity] Min quantity for the withdrawn asset
+     * @param {string} [maxQuantity] Max quantity for the withdrawn asset
+     * @param {string} [metadata] JSON-encoded metadata filters for the withdrawn asset
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listWithdrawals(withdrawnToWallet?: boolean, rollupStatus?: string, pageSize?: number, cursor?: string, orderBy?: string, direction?: string, user?: string, status?: string, minTimestamp?: string, maxTimestamp?: string, tokenType?: string, tokenId?: string, assetId?: string, tokenAddress?: string, tokenName?: string, minQuantity?: string, maxQuantity?: string, metadata?: string, options?: any): AxiosPromise<ListWithdrawalsResponse>;
+};
+/**
+ * Request parameters for createWithdrawal operation in WithdrawalsApi.
+ * @export
+ * @interface WithdrawalsApiCreateWithdrawalRequest
+ */
+export interface WithdrawalsApiCreateWithdrawalRequest {
+    /**
+     * eth address
+     * @type {string}
+     * @memberof WithdrawalsApiCreateWithdrawal
+     */
+    readonly xImxEthAddress: string;
+    /**
+     * eth signature
+     * @type {string}
+     * @memberof WithdrawalsApiCreateWithdrawal
+     */
+    readonly xImxEthSignature: string;
+    /**
+     * create a withdrawal
+     * @type {CreateWithdrawalRequest}
+     * @memberof WithdrawalsApiCreateWithdrawal
+     */
+    readonly createWithdrawalRequest: CreateWithdrawalRequest;
+}
+/**
+ * Request parameters for createWithdrawalV2 operation in WithdrawalsApi.
+ * @export
+ * @interface WithdrawalsApiCreateWithdrawalV2Request
+ */
+export interface WithdrawalsApiCreateWithdrawalV2Request {
+    /**
+     * eth address
+     * @type {string}
+     * @memberof WithdrawalsApiCreateWithdrawalV2
+     */
+    readonly xImxEthAddress: string;
+    /**
+     * eth signature
+     * @type {string}
+     * @memberof WithdrawalsApiCreateWithdrawalV2
+     */
+    readonly xImxEthSignature: string;
+    /**
+     * create a withdrawal
+     * @type {CreateWithdrawalRequestV2}
+     * @memberof WithdrawalsApiCreateWithdrawalV2
+     */
+    readonly createWithdrawalRequestV2: CreateWithdrawalRequestV2;
+}
+/**
+ * Request parameters for getSignableWithdrawal operation in WithdrawalsApi.
+ * @export
+ * @interface WithdrawalsApiGetSignableWithdrawalRequest
+ */
+export interface WithdrawalsApiGetSignableWithdrawalRequest {
+    /**
+     * get details of signable withdrawal
+     * @type {GetSignableWithdrawalRequest}
+     * @memberof WithdrawalsApiGetSignableWithdrawal
+     */
+    readonly getSignableWithdrawalRequest: GetSignableWithdrawalRequest;
+}
+/**
+ * Request parameters for getSignableWithdrawalV2 operation in WithdrawalsApi.
+ * @export
+ * @interface WithdrawalsApiGetSignableWithdrawalV2Request
+ */
+export interface WithdrawalsApiGetSignableWithdrawalV2Request {
+    /**
+     * get details of signable withdrawal
+     * @type {GetSignableWithdrawalRequest}
+     * @memberof WithdrawalsApiGetSignableWithdrawalV2
+     */
+    readonly getSignableWithdrawalRequest: GetSignableWithdrawalRequest;
+}
+/**
+ * Request parameters for getWithdrawal operation in WithdrawalsApi.
+ * @export
+ * @interface WithdrawalsApiGetWithdrawalRequest
+ */
+export interface WithdrawalsApiGetWithdrawalRequest {
+    /**
+     * Withdrawal ID
+     * @type {string}
+     * @memberof WithdrawalsApiGetWithdrawal
+     */
+    readonly id: string;
+}
+/**
+ * Request parameters for listWithdrawals operation in WithdrawalsApi.
+ * @export
+ * @interface WithdrawalsApiListWithdrawalsRequest
+ */
+export interface WithdrawalsApiListWithdrawalsRequest {
+    /**
+     * Withdrawal has been transferred to user\&#39;s Layer 1 wallet
+     * @type {boolean}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly withdrawnToWallet?: boolean;
+    /**
+     * Status of the on-chain batch confirmation for this withdrawal
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly rollupStatus?: string;
+    /**
+     * Page size of the result
+     * @type {number}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly pageSize?: number;
+    /**
+     * Cursor
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly cursor?: string;
+    /**
+     * Property to sort by
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly orderBy?: string;
+    /**
+     * Direction to sort (asc/desc)
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly direction?: string;
+    /**
+     * Ethereum address of the user who submitted this withdrawal
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly user?: string;
+    /**
+     * Status of this withdrawal
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly status?: string;
+    /**
+     * Minimum timestamp for this deposit, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly minTimestamp?: string;
+    /**
+     * Maximum timestamp for this deposit, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly maxTimestamp?: string;
+    /**
+     * Token type of the withdrawn asset
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly tokenType?: string;
+    /**
+     * ERC721 Token ID of the minted asset
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly tokenId?: string;
+    /**
+     * Internal IMX ID of the minted asset
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly assetId?: string;
+    /**
+     * Token address of the withdrawn asset
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly tokenAddress?: string;
+    /**
+     * Token name of the withdrawn asset
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly tokenName?: string;
+    /**
+     * Min quantity for the withdrawn asset
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly minQuantity?: string;
+    /**
+     * Max quantity for the withdrawn asset
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly maxQuantity?: string;
+    /**
+     * JSON-encoded metadata filters for the withdrawn asset
+     * @type {string}
+     * @memberof WithdrawalsApiListWithdrawals
+     */
+    readonly metadata?: string;
+}
+/**
+ * WithdrawalsApi - object-oriented interface
+ * @export
+ * @class WithdrawalsApi
+ * @extends {BaseAPI}
+ */
+export declare class WithdrawalsApi extends BaseAPI {
+    /**
+     * 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.
+     * @summary Creates a withdrawal
+     * @param {WithdrawalsApiCreateWithdrawalRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WithdrawalsApi
+     */
+    createWithdrawal(requestParameters: WithdrawalsApiCreateWithdrawalRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWithdrawalResponse, any>>;
+    /**
+     * Creates a withdrawal. Use https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2 to get request body params.
+     * @summary Creates a withdrawal of a token for when StarkEx contract that is higher than v3
+     * @param {WithdrawalsApiCreateWithdrawalV2Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WithdrawalsApi
+     */
+    createWithdrawalV2(requestParameters: WithdrawalsApiCreateWithdrawalV2Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWithdrawalResponse, 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.
+     * @summary Gets details of a signable withdrawal
+     * @param {WithdrawalsApiGetSignableWithdrawalRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WithdrawalsApi
+     */
+    getSignableWithdrawal(requestParameters: WithdrawalsApiGetSignableWithdrawalRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSignableWithdrawalResponse, any>>;
+    /**
+     * Gets details of a signable withdrawal
+     * @summary Gets details of a signable withdrawal for starkex contracts that are higher than v3
+     * @param {WithdrawalsApiGetSignableWithdrawalV2Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WithdrawalsApi
+     */
+    getSignableWithdrawalV2(requestParameters: WithdrawalsApiGetSignableWithdrawalV2Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSignableWithdrawalResponseV2, any>>;
+    /**
+     * Gets details of withdrawal with the given ID
+     * @summary Gets details of withdrawal with the given ID
+     * @param {WithdrawalsApiGetWithdrawalRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WithdrawalsApi
+     */
+    getWithdrawal(requestParameters: WithdrawalsApiGetWithdrawalRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Withdrawal, any>>;
+    /**
+     * Get a list of withdrawals
+     * @summary Get a list of withdrawals
+     * @param {WithdrawalsApiListWithdrawalsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WithdrawalsApi
+     */
+    listWithdrawals(requestParameters?: WithdrawalsApiListWithdrawalsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWithdrawalsResponse, any>>;
+}

package/dist/types/imx/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";
+export * from "./models";

package/dist/types/imx/models/add-metadata-schema-to-collection-request.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { MetadataSchemaRequest } from './metadata-schema-request';
+/**
+ *
+ * @export
+ * @interface AddMetadataSchemaToCollectionRequest
+ */
+export interface AddMetadataSchemaToCollectionRequest {
+    /**
+     * Not required from API user
+     * @type {string}
+     * @memberof AddMetadataSchemaToCollectionRequest
+     */
+    'contract_address'?: string;
+    /**
+     * The metadata container
+     * @type {Array<MetadataSchemaRequest>}
+     * @memberof AddMetadataSchemaToCollectionRequest
+     */
+    'metadata': Array<MetadataSchemaRequest>;
+}

package/dist/types/imx/models/aggregate-limit.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface AggregateLimit
+ */
+export interface AggregateLimit {
+    /**
+     * Max transaction amount
+     * @type {number}
+     * @memberof AggregateLimit
+     */
+    'max_amount'?: number;
+    /**
+     * Min transaction amount
+     * @type {number}
+     * @memberof AggregateLimit
+     */
+    'min_amount'?: number;
+}

package/dist/types/imx/models/api-order-v3-buy.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Token } from './token';
+/**
+ * @type ApiOrderV3Buy
+ * Details of the asset being bought
+ * @export
+ */
+export type ApiOrderV3Buy = Token;

package/dist/types/imx/models/api-order-v3-maker-fees.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { StoreMakerTakerFee } from './store-maker-taker-fee';
+/**
+ * @type ApiOrderV3MakerFees
+ * MakerFees is the information about the fees that needs to be paid by the maker (liquidity)
+ * @export
+ */
+export type ApiOrderV3MakerFees = StoreMakerTakerFee;

package/dist/types/imx/models/api-order-v3-sell.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Token } from './token';
+/**
+ * @type ApiOrderV3Sell
+ * Details of the asset being sold
+ * @export
+ */
+export type ApiOrderV3Sell = Token;

package/dist/types/imx/models/api-order-v3-taker-fees.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { StoreMakerTakerFee } from './store-maker-taker-fee';
+/**
+ * @type ApiOrderV3TakerFees
+ * TakerFees is the information about the fees that needs to be paid by the taker (liquidity)
+ * @export
+ */
+export type ApiOrderV3TakerFees = StoreMakerTakerFee;