@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/imx/models/create-order-request.d.ts

@@ -0,0 +1,91 @@
+/**
+ * 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 { FeeEntry } from './fee-entry';
+/**
+ *
+ * @export
+ * @interface CreateOrderRequest
+ */
+export interface CreateOrderRequest {
+    /**
+     * Amount to buy
+     * @type {string}
+     * @memberof CreateOrderRequest
+     */
+    'amount_buy': string;
+    /**
+     * Amount to sell
+     * @type {string}
+     * @memberof CreateOrderRequest
+     */
+    'amount_sell': string;
+    /**
+     * ID of the asset to buy
+     * @type {string}
+     * @memberof CreateOrderRequest
+     */
+    'asset_id_buy': string;
+    /**
+     * ID of the asset to sell
+     * @type {string}
+     * @memberof CreateOrderRequest
+     */
+    'asset_id_sell': string;
+    /**
+     * Expiration timestamp for this order
+     * @type {number}
+     * @memberof CreateOrderRequest
+     */
+    'expiration_timestamp': number;
+    /**
+     * Fee information
+     * @type {Array<FeeEntry>}
+     * @memberof CreateOrderRequest
+     */
+    'fees'?: Array<FeeEntry>;
+    /**
+     * Whether to include fees in order
+     * @type {boolean}
+     * @memberof CreateOrderRequest
+     */
+    'include_fees'?: boolean;
+    /**
+     * Nonce of the order
+     * @type {number}
+     * @memberof CreateOrderRequest
+     */
+    'nonce': number;
+    /**
+     * Public stark key of the user creating order
+     * @type {string}
+     * @memberof CreateOrderRequest
+     */
+    'stark_key': string;
+    /**
+     * Payload signature
+     * @type {string}
+     * @memberof CreateOrderRequest
+     */
+    'stark_signature': string;
+    /**
+     * ID of the vault into which the bought asset will be placed
+     * @type {number}
+     * @memberof CreateOrderRequest
+     */
+    'vault_id_buy': number;
+    /**
+     * ID of the vault to sell from
+     * @type {number}
+     * @memberof CreateOrderRequest
+     */
+    'vault_id_sell': number;
+}

package/dist/types/imx/models/create-order-response.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 CreateOrderResponse
+ */
+export interface CreateOrderResponse {
+    /**
+     * ID of the created order
+     * @type {number}
+     * @memberof CreateOrderResponse
+     */
+    'order_id': number;
+    /**
+     * Request ID as a reference for an asynchronous order creation request
+     * @type {string}
+     * @memberof CreateOrderResponse
+     */
+    'request_id'?: string;
+    /**
+     * Status of the created order
+     * @type {string}
+     * @memberof CreateOrderResponse
+     */
+    'status': string;
+    /**
+     * Timestamp of the created order
+     * @type {number}
+     * @memberof CreateOrderResponse
+     */
+    'time': number;
+}

package/dist/types/imx/models/create-project-apikey-response.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 CreateProjectAPIKeyResponse
+ */
+export interface CreateProjectAPIKeyResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateProjectAPIKeyResponse
+     */
+    'key': string;
+}

package/dist/types/imx/models/create-project-group-request.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 CreateProjectGroupRequest
+ */
+export interface CreateProjectGroupRequest {
+    /**
+     * The chain type
+     * @type {string}
+     * @memberof CreateProjectGroupRequest
+     */
+    'chain_type': CreateProjectGroupRequestChainTypeEnum;
+    /**
+     * The project group name
+     * @type {string}
+     * @memberof CreateProjectGroupRequest
+     */
+    'name': string;
+}
+export declare const CreateProjectGroupRequestChainTypeEnum: {
+    readonly Starkex: "starkex";
+    readonly Zkevm: "zkevm";
+};
+export type CreateProjectGroupRequestChainTypeEnum = typeof CreateProjectGroupRequestChainTypeEnum[keyof typeof CreateProjectGroupRequestChainTypeEnum];

package/dist/types/imx/models/create-project-request.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 CreateProjectRequest
+ */
+export interface CreateProjectRequest {
+    /**
+     * The company name
+     * @type {string}
+     * @memberof CreateProjectRequest
+     */
+    'company_name': string;
+    /**
+     * The project contact email (must be registered as a developer account with Immutable at https://hub.immutable.com)
+     * @type {string}
+     * @memberof CreateProjectRequest
+     */
+    'contact_email': string;
+    /**
+     * The project name
+     * @type {string}
+     * @memberof CreateProjectRequest
+     */
+    'name': string;
+}

package/dist/types/imx/models/create-project-response.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 CreateProjectResponse
+ */
+export interface CreateProjectResponse {
+    /**
+     * The environment ID
+     * @type {string}
+     * @memberof CreateProjectResponse
+     */
+    'environment_id': string;
+    /**
+     * The project ID
+     * @type {number}
+     * @memberof CreateProjectResponse
+     */
+    'id': number;
+}

package/dist/types/imx/models/create-trade-request-v1-fee-info.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 { FeeInfo } from './fee-info';
+/**
+ * @type CreateTradeRequestV1FeeInfo
+ * Fee details
+ * @export
+ */
+export type CreateTradeRequestV1FeeInfo = FeeInfo;

package/dist/types/imx/models/create-trade-request-v1.d.ts

@@ -0,0 +1,104 @@
+/**
+ * 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 { CreateTradeRequestV1FeeInfo } from './create-trade-request-v1-fee-info';
+import { FeeEntry } from './fee-entry';
+/**
+ *
+ * @export
+ * @interface CreateTradeRequestV1
+ */
+export interface CreateTradeRequestV1 {
+    /**
+     * Amount to buy
+     * @type {string}
+     * @memberof CreateTradeRequestV1
+     */
+    'amount_buy': string;
+    /**
+     * Amount to sell
+     * @type {string}
+     * @memberof CreateTradeRequestV1
+     */
+    'amount_sell': string;
+    /**
+     * ID of the asset to buy
+     * @type {string}
+     * @memberof CreateTradeRequestV1
+     */
+    'asset_id_buy': string;
+    /**
+     * ID of the asset to sell
+     * @type {string}
+     * @memberof CreateTradeRequestV1
+     */
+    'asset_id_sell': string;
+    /**
+     * Expiration timestamp for this trade
+     * @type {number}
+     * @memberof CreateTradeRequestV1
+     */
+    'expiration_timestamp': number;
+    /**
+     *
+     * @type {CreateTradeRequestV1FeeInfo}
+     * @memberof CreateTradeRequestV1
+     */
+    'fee_info'?: CreateTradeRequestV1FeeInfo;
+    /**
+     * Fee information
+     * @type {Array<FeeEntry>}
+     * @memberof CreateTradeRequestV1
+     */
+    'fees'?: Array<FeeEntry>;
+    /**
+     * [deprecated] All orders include fees since the introduction of protocol fees
+     * @type {boolean}
+     * @memberof CreateTradeRequestV1
+     */
+    'include_fees'?: boolean;
+    /**
+     * Nonce of the trade
+     * @type {number}
+     * @memberof CreateTradeRequestV1
+     */
+    'nonce': number;
+    /**
+     * ID of the order
+     * @type {number}
+     * @memberof CreateTradeRequestV1
+     */
+    'order_id': number;
+    /**
+     * Public stark key of the user creating trade
+     * @type {string}
+     * @memberof CreateTradeRequestV1
+     */
+    'stark_key': string;
+    /**
+     * Payload signature
+     * @type {string}
+     * @memberof CreateTradeRequestV1
+     */
+    'stark_signature': string;
+    /**
+     * ID of the vault into which the traded asset will be placed
+     * @type {number}
+     * @memberof CreateTradeRequestV1
+     */
+    'vault_id_buy': number;
+    /**
+     * ID of the vault to sell from
+     * @type {number}
+     * @memberof CreateTradeRequestV1
+     */
+    'vault_id_sell': number;
+}

package/dist/types/imx/models/create-trade-response.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 CreateTradeResponse
+ */
+export interface CreateTradeResponse {
+    /**
+     * Request ID as a reference for an asynchronous trade creation request
+     * @type {string}
+     * @memberof CreateTradeResponse
+     */
+    'request_id'?: string;
+    /**
+     * [DEPRECATED] Unused field that always returns an empty string. The presence of a trade_id signifies that a trade was successful.
+     * @type {string}
+     * @memberof CreateTradeResponse
+     */
+    'status': string;
+    /**
+     * ID of trade within Immutable X
+     * @type {number}
+     * @memberof CreateTradeResponse
+     */
+    'trade_id': number;
+}

package/dist/types/imx/models/create-transfer-request-v1.d.ts

@@ -0,0 +1,72 @@
+/**
+ * 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 CreateTransferRequestV1
+ */
+export interface CreateTransferRequestV1 {
+    /**
+     * Amount to transfer
+     * @type {string}
+     * @memberof CreateTransferRequestV1
+     */
+    'amount': string;
+    /**
+     * ID of the asset to transfer
+     * @type {string}
+     * @memberof CreateTransferRequestV1
+     */
+    'asset_id': string;
+    /**
+     * Expiration timestamp for this transfer
+     * @type {number}
+     * @memberof CreateTransferRequestV1
+     */
+    'expiration_timestamp': number;
+    /**
+     * Nonce of the transfer
+     * @type {number}
+     * @memberof CreateTransferRequestV1
+     */
+    'nonce': number;
+    /**
+     * Public stark key of the user receiving the transfer
+     * @type {string}
+     * @memberof CreateTransferRequestV1
+     */
+    'receiver_stark_key': string;
+    /**
+     * ID of the vault into which the asset will be transferred to
+     * @type {number}
+     * @memberof CreateTransferRequestV1
+     */
+    'receiver_vault_id': number;
+    /**
+     * Public stark key of the user sending the transfer
+     * @type {string}
+     * @memberof CreateTransferRequestV1
+     */
+    'sender_stark_key': string;
+    /**
+     * ID of the vault into which the asset is from
+     * @type {number}
+     * @memberof CreateTransferRequestV1
+     */
+    'sender_vault_id': number;
+    /**
+     * Transfer payload signature
+     * @type {string}
+     * @memberof CreateTransferRequestV1
+     */
+    'stark_signature': string;
+}

package/dist/types/imx/models/create-transfer-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 { TransferRequest } from './transfer-request';
+/**
+ *
+ * @export
+ * @interface CreateTransferRequest
+ */
+export interface CreateTransferRequest {
+    /**
+     * List of transfers
+     * @type {Array<TransferRequest>}
+     * @memberof CreateTransferRequest
+     */
+    'requests': Array<TransferRequest>;
+    /**
+     * Public stark key of the user sending the transfer
+     * @type {string}
+     * @memberof CreateTransferRequest
+     */
+    'sender_stark_key': string;
+}

package/dist/types/imx/models/create-transfer-response-v1.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 CreateTransferResponseV1
+ */
+export interface CreateTransferResponseV1 {
+    /**
+     * [deprecated] Sent signature
+     * @type {string}
+     * @memberof CreateTransferResponseV1
+     */
+    'sent_signature': string;
+    /**
+     * [deprecated] The status of transfer
+     * @type {string}
+     * @memberof CreateTransferResponseV1
+     */
+    'status': string;
+    /**
+     * [deprecated] Time of the transfer
+     * @type {number}
+     * @memberof CreateTransferResponseV1
+     */
+    'time': number;
+    /**
+     * ID of the transfer
+     * @type {number}
+     * @memberof CreateTransferResponseV1
+     */
+    'transfer_id': number;
+}

package/dist/types/imx/models/create-transfer-response-v2.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 CreateTransferResponseV2
+ */
+export interface CreateTransferResponseV2 {
+    /**
+     * List of transfer IDs
+     * @type {Array<number>}
+     * @memberof CreateTransferResponseV2
+     */
+    'transfer_ids': Array<number>;
+}

package/dist/types/imx/models/create-transfer-response.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 CreateTransferResponse
+ */
+export interface CreateTransferResponse {
+    /**
+     * List of transfer IDs
+     * @type {Array<number>}
+     * @memberof CreateTransferResponse
+     */
+    'transfer_ids': Array<number>;
+}

package/dist/types/imx/models/create-withdrawal-request-v2.d.ts

@@ -0,0 +1,72 @@
+/**
+ * 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 CreateWithdrawalRequestV2
+ */
+export interface CreateWithdrawalRequestV2 {
+    /**
+     * Amount to withdraw
+     * @type {string}
+     * @memberof CreateWithdrawalRequestV2
+     */
+    'amount': string;
+    /**
+     * ID of the asset to withdraw
+     * @type {string}
+     * @memberof CreateWithdrawalRequestV2
+     */
+    'asset_id': string;
+    /**
+     * Expiration timestamp for this withdrawal
+     * @type {number}
+     * @memberof CreateWithdrawalRequestV2
+     */
+    'expiration_timestamp': number;
+    /**
+     * Nonce of the withdrawal
+     * @type {number}
+     * @memberof CreateWithdrawalRequestV2
+     */
+    'nonce': number;
+    /**
+     * Public stark key of the user receiving the withdrawal
+     * @type {string}
+     * @memberof CreateWithdrawalRequestV2
+     */
+    'receiver_stark_key': string;
+    /**
+     * ID of the vault into which the asset will be withdrawn
+     * @type {number}
+     * @memberof CreateWithdrawalRequestV2
+     */
+    'receiver_vault_id'?: number;
+    /**
+     * Public stark key of the withdrawing user
+     * @type {string}
+     * @memberof CreateWithdrawalRequestV2
+     */
+    'sender_stark_key': string;
+    /**
+     * ID of the vault into which the asset is from
+     * @type {number}
+     * @memberof CreateWithdrawalRequestV2
+     */
+    'sender_vault_id': number;
+    /**
+     * Withdrawal payload signature
+     * @type {string}
+     * @memberof CreateWithdrawalRequestV2
+     */
+    'stark_signature': string;
+}