@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/imx/models/get-metadata-refresh-errors-response.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 { MetadataRefreshErrors } from './metadata-refresh-errors';
+/**
+ *
+ * @export
+ * @interface GetMetadataRefreshErrorsResponse
+ */
+export interface GetMetadataRefreshErrorsResponse {
+    /**
+     * Generated cursor returned by previous query
+     * @type {string}
+     * @memberof GetMetadataRefreshErrorsResponse
+     */
+    'cursor': string;
+    /**
+     * Remaining results flag. 1: there are remaining results matching this query, 0: no remaining results
+     * @type {number}
+     * @memberof GetMetadataRefreshErrorsResponse
+     */
+    'remaining': number;
+    /**
+     * Metadata refresh errors matching query parameters
+     * @type {Array<MetadataRefreshErrors>}
+     * @memberof GetMetadataRefreshErrorsResponse
+     */
+    'result': Array<MetadataRefreshErrors>;
+}

package/dist/types/imx/models/get-metadata-refresh-response.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 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 { MetadataRefreshSummary } from './metadata-refresh-summary';
+/**
+ *
+ * @export
+ * @interface GetMetadataRefreshResponse
+ */
+export interface GetMetadataRefreshResponse {
+    /**
+     * The collection address
+     * @type {string}
+     * @memberof GetMetadataRefreshResponse
+     */
+    'collection_address': string;
+    /**
+     * When the metadata refresh completed
+     * @type {string}
+     * @memberof GetMetadataRefreshResponse
+     */
+    'completed_at'?: string | null;
+    /**
+     * The metadata refresh ID
+     * @type {string}
+     * @memberof GetMetadataRefreshResponse
+     */
+    'refresh_id': string;
+    /**
+     * When the metadata refresh started
+     * @type {string}
+     * @memberof GetMetadataRefreshResponse
+     */
+    'started_at': string;
+    /**
+     * The metadata refresh status
+     * @type {string}
+     * @memberof GetMetadataRefreshResponse
+     */
+    'status': GetMetadataRefreshResponseStatusEnum;
+    /**
+     * The current metadata refresh summary. The summary continue to update until metadata refresh is completed
+     * @type {Array<MetadataRefreshSummary>}
+     * @memberof GetMetadataRefreshResponse
+     */
+    'summary': Array<MetadataRefreshSummary>;
+}
+export declare const GetMetadataRefreshResponseStatusEnum: {
+    readonly Queued: "queued";
+    readonly InProgress: "in_progress";
+    readonly Completed: "completed";
+};
+export type GetMetadataRefreshResponseStatusEnum = typeof GetMetadataRefreshResponseStatusEnum[keyof typeof GetMetadataRefreshResponseStatusEnum];

package/dist/types/imx/models/get-metadata-refreshes.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 { MetadataRefreshExcludingSummary } from './metadata-refresh-excluding-summary';
+/**
+ *
+ * @export
+ * @interface GetMetadataRefreshes
+ */
+export interface GetMetadataRefreshes {
+    /**
+     * Generated cursor returned by previous query
+     * @type {string}
+     * @memberof GetMetadataRefreshes
+     */
+    'cursor': string;
+    /**
+     * Remaining results flag. 1: there are remaining results matching this query, 0: no remaining results
+     * @type {number}
+     * @memberof GetMetadataRefreshes
+     */
+    'remaining': number;
+    /**
+     * Metadata refresh errors matching query parameters
+     * @type {Array<MetadataRefreshExcludingSummary>}
+     * @memberof GetMetadataRefreshes
+     */
+    'result': Array<MetadataRefreshExcludingSummary>;
+}

package/dist/types/imx/models/get-projects-response.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 { Project } from './project';
+/**
+ *
+ * @export
+ * @interface GetProjectsResponse
+ */
+export interface GetProjectsResponse {
+    /**
+     * Generated cursor returned by previous query
+     * @type {string}
+     * @memberof GetProjectsResponse
+     */
+    'cursor': string;
+    /**
+     * Remaining results flag. 1: there are remaining results matching this query, 0: no remaining results
+     * @type {number}
+     * @memberof GetProjectsResponse
+     */
+    'remaining': number;
+    /**
+     * Projects matching query parameters
+     * @type {Array<Project>}
+     * @memberof GetProjectsResponse
+     */
+    'result': Array<Project>;
+}

package/dist/types/imx/models/get-signable-cancel-order-request.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 GetSignableCancelOrderRequest
+ */
+export interface GetSignableCancelOrderRequest {
+    /**
+     * ID of the order to be cancelled
+     * @type {number}
+     * @memberof GetSignableCancelOrderRequest
+     */
+    'order_id': number;
+}

package/dist/types/imx/models/get-signable-cancel-order-response.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 GetSignableCancelOrderResponse
+ */
+export interface GetSignableCancelOrderResponse {
+    /**
+     * ID of the order to be cancelled
+     * @type {number}
+     * @memberof GetSignableCancelOrderResponse
+     */
+    'order_id': number;
+    /**
+     * Hash of the payload to be signed for cancel order
+     * @type {string}
+     * @memberof GetSignableCancelOrderResponse
+     */
+    'payload_hash': string;
+    /**
+     * EIP-712 encoding of the StarkEx cancel order request to be displayed to the user
+     * @type {string}
+     * @memberof GetSignableCancelOrderResponse
+     */
+    'readable_transaction': string;
+    /**
+     * Message to sign from wallet to confirm cancel order
+     * @type {string}
+     * @memberof GetSignableCancelOrderResponse
+     */
+    'signable_message': string;
+    /**
+     * IMX signed readable_transaction and payload_hash
+     * @type {string}
+     * @memberof GetSignableCancelOrderResponse
+     */
+    'verification_signature': string;
+}

package/dist/types/imx/models/get-signable-deposit-request-token.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 { SignableToken } from './signable-token';
+/**
+ * @type GetSignableDepositRequestToken
+ * Details of the token the user is depositing
+ * @export
+ */
+export type GetSignableDepositRequestToken = SignableToken;

package/dist/types/imx/models/get-signable-deposit-request.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 { GetSignableDepositRequestToken } from './get-signable-deposit-request-token';
+/**
+ *
+ * @export
+ * @interface GetSignableDepositRequest
+ */
+export interface GetSignableDepositRequest {
+    /**
+     * Amount of the token the user is depositing
+     * @type {string}
+     * @memberof GetSignableDepositRequest
+     */
+    'amount': string;
+    /**
+     *
+     * @type {GetSignableDepositRequestToken}
+     * @memberof GetSignableDepositRequest
+     */
+    'token': GetSignableDepositRequestToken;
+    /**
+     * User who is depositing
+     * @type {string}
+     * @memberof GetSignableDepositRequest
+     */
+    'user': string;
+}

package/dist/types/imx/models/get-signable-deposit-response.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 GetSignableDepositResponse
+ */
+export interface GetSignableDepositResponse {
+    /**
+     * Amount this user is depositing
+     * @type {string}
+     * @memberof GetSignableDepositResponse
+     */
+    'amount': string;
+    /**
+     * ID of the asset this user is depositing
+     * @type {string}
+     * @memberof GetSignableDepositResponse
+     */
+    'asset_id': string;
+    /**
+     * Nonce of the deposit
+     * @type {number}
+     * @memberof GetSignableDepositResponse
+     */
+    'nonce': number;
+    /**
+     * Public stark key of the depositing user
+     * @type {string}
+     * @memberof GetSignableDepositResponse
+     */
+    'stark_key': string;
+    /**
+     * ID of the vault this user is depositing to
+     * @type {number}
+     * @memberof GetSignableDepositResponse
+     */
+    'vault_id': number;
+}

package/dist/types/imx/models/get-signable-order-request-token-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 { SignableToken } from './signable-token';
+/**
+ * @type GetSignableOrderRequestTokenBuy
+ * Token to buy
+ * @export
+ */
+export type GetSignableOrderRequestTokenBuy = SignableToken;

package/dist/types/imx/models/get-signable-order-request-token-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 { SignableToken } from './signable-token';
+/**
+ * @type GetSignableOrderRequestTokenSell
+ * Token to sell
+ * @export
+ */
+export type GetSignableOrderRequestTokenSell = SignableToken;

package/dist/types/imx/models/get-signable-order-request-v3-token-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 { SignableToken } from './signable-token';
+/**
+ * @type GetSignableOrderRequestV3TokenBuy
+ * Token to buy
+ * @export
+ */
+export type GetSignableOrderRequestV3TokenBuy = SignableToken;

package/dist/types/imx/models/get-signable-order-request-v3-token-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 { SignableToken } from './signable-token';
+/**
+ * @type GetSignableOrderRequestV3TokenSell
+ * Token to sell
+ * @export
+ */
+export type GetSignableOrderRequestV3TokenSell = SignableToken;

package/dist/types/imx/models/get-signable-order-request-v3.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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';
+import { GetSignableOrderRequestV3TokenBuy } from './get-signable-order-request-v3-token-buy';
+import { GetSignableOrderRequestV3TokenSell } from './get-signable-order-request-v3-token-sell';
+/**
+ *
+ * @export
+ * @interface GetSignableOrderRequestV3
+ */
+export interface GetSignableOrderRequestV3 {
+    /**
+     * Fee-exclusive amount to buy the asset
+     * @type {string}
+     * @memberof GetSignableOrderRequestV3
+     */
+    'amount_buy': string;
+    /**
+     * Amount to sell (quantity)
+     * @type {string}
+     * @memberof GetSignableOrderRequestV3
+     */
+    'amount_sell': string;
+    /**
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
+     * @type {number}
+     * @memberof GetSignableOrderRequestV3
+     */
+    'expiration_timestamp'?: number;
+    /**
+     * Inclusion of either maker or taker fees
+     * @type {Array<FeeEntry>}
+     * @memberof GetSignableOrderRequestV3
+     */
+    'fees'?: Array<FeeEntry>;
+    /**
+     * SplitFees is a deprecated field. It\'s value is ignored.
+     * @type {boolean}
+     * @memberof GetSignableOrderRequestV3
+     */
+    'split_fees'?: boolean;
+    /**
+     *
+     * @type {GetSignableOrderRequestV3TokenBuy}
+     * @memberof GetSignableOrderRequestV3
+     */
+    'token_buy': GetSignableOrderRequestV3TokenBuy;
+    /**
+     *
+     * @type {GetSignableOrderRequestV3TokenSell}
+     * @memberof GetSignableOrderRequestV3
+     */
+    'token_sell': GetSignableOrderRequestV3TokenSell;
+    /**
+     * Ethereum address of the submitting user
+     * @type {string}
+     * @memberof GetSignableOrderRequestV3
+     */
+    'user': string;
+}

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

@@ -0,0 +1,69 @@
+/**
+ * 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';
+import { GetSignableOrderRequestTokenBuy } from './get-signable-order-request-token-buy';
+import { GetSignableOrderRequestTokenSell } from './get-signable-order-request-token-sell';
+/**
+ *
+ * @export
+ * @interface GetSignableOrderRequest
+ */
+export interface GetSignableOrderRequest {
+    /**
+     * Fee-exclusive amount to buy the asset
+     * @type {string}
+     * @memberof GetSignableOrderRequest
+     */
+    'amount_buy': string;
+    /**
+     * Amount to sell (quantity)
+     * @type {string}
+     * @memberof GetSignableOrderRequest
+     */
+    'amount_sell': string;
+    /**
+     * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
+     * @type {number}
+     * @memberof GetSignableOrderRequest
+     */
+    'expiration_timestamp'?: number;
+    /**
+     * Inclusion of either maker or taker fees
+     * @type {Array<FeeEntry>}
+     * @memberof GetSignableOrderRequest
+     */
+    'fees'?: Array<FeeEntry>;
+    /**
+     * SplitFees dictates whether fees will be split between maker & taker, set split_fees to true when submitting signing to v3 endpoints and vice versa for v1
+     * @type {boolean}
+     * @memberof GetSignableOrderRequest
+     */
+    'split_fees'?: boolean;
+    /**
+     *
+     * @type {GetSignableOrderRequestTokenBuy}
+     * @memberof GetSignableOrderRequest
+     */
+    'token_buy': GetSignableOrderRequestTokenBuy;
+    /**
+     *
+     * @type {GetSignableOrderRequestTokenSell}
+     * @memberof GetSignableOrderRequest
+     */
+    'token_sell': GetSignableOrderRequestTokenSell;
+    /**
+     * Ethereum address of the submitting user
+     * @type {string}
+     * @memberof GetSignableOrderRequest
+     */
+    'user': string;
+}

package/dist/types/imx/models/get-signable-order-response-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 GetSignableOrderResponseFeeInfo
+ * Fee information
+ * @export
+ */
+export type GetSignableOrderResponseFeeInfo = FeeInfo;

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

@@ -0,0 +1,103 @@
+/**
+ * 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 { GetSignableOrderResponseFeeInfo } from './get-signable-order-response-fee-info';
+/**
+ *
+ * @export
+ * @interface GetSignableOrderResponse
+ */
+export interface GetSignableOrderResponse {
+    /**
+     * Fee-exclusive amount to buy
+     * @type {string}
+     * @memberof GetSignableOrderResponse
+     */
+    'amount_buy': string;
+    /**
+     * Amount to sell
+     * @type {string}
+     * @memberof GetSignableOrderResponse
+     */
+    'amount_sell': string;
+    /**
+     * ID of the asset to buy
+     * @type {string}
+     * @memberof GetSignableOrderResponse
+     */
+    'asset_id_buy': string;
+    /**
+     * ID of the asset to sell
+     * @type {string}
+     * @memberof GetSignableOrderResponse
+     */
+    'asset_id_sell': string;
+    /**
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
+     * @type {number}
+     * @memberof GetSignableOrderResponse
+     */
+    'expiration_timestamp': number;
+    /**
+     *
+     * @type {GetSignableOrderResponseFeeInfo}
+     * @memberof GetSignableOrderResponse
+     */
+    'fee_info'?: GetSignableOrderResponseFeeInfo;
+    /**
+     * Nonce of the order
+     * @type {number}
+     * @memberof GetSignableOrderResponse
+     */
+    'nonce': number;
+    /**
+     * Hash of the payload to be signed for signable order
+     * @type {string}
+     * @memberof GetSignableOrderResponse
+     */
+    'payload_hash': string;
+    /**
+     * EIP-712 encoding of the StarkEx order transaction to be displayed to the user
+     * @type {string}
+     * @memberof GetSignableOrderResponse
+     */
+    'readable_transaction': string;
+    /**
+     * Message to sign with L1 wallet to confirm order request
+     * @type {string}
+     * @memberof GetSignableOrderResponse
+     */
+    'signable_message': string;
+    /**
+     * Public stark key of the created user
+     * @type {string}
+     * @memberof GetSignableOrderResponse
+     */
+    'stark_key': string;
+    /**
+     * ID of the vault into which the bought asset will be placed
+     * @type {number}
+     * @memberof GetSignableOrderResponse
+     */
+    'vault_id_buy': number;
+    /**
+     * ID of the vault to sell from
+     * @type {number}
+     * @memberof GetSignableOrderResponse
+     */
+    'vault_id_sell': number;
+    /**
+     * IMX signed readable_transaction and payload_hash
+     * @type {string}
+     * @memberof GetSignableOrderResponse
+     */
+    'verification_signature': string;
+}