@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/imx/models/optional-exchange-data.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 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 OptionalExchangeData
+ */
+export interface OptionalExchangeData {
+    /**
+     * Provider transaction ID
+     * @type {string}
+     * @memberof OptionalExchangeData
+     */
+    'external_id'?: string;
+    /**
+     * Fees amount
+     * @type {number}
+     * @memberof OptionalExchangeData
+     */
+    'fees_amount'?: number;
+    /**
+     * Amount that was exchanged from
+     * @type {number}
+     * @memberof OptionalExchangeData
+     */
+    'from_amount'?: number;
+    /**
+     * Currency that was exchanged from
+     * @type {string}
+     * @memberof OptionalExchangeData
+     */
+    'from_currency'?: string;
+    /**
+     * Provider wallet address that was used for transferring crypto
+     * @type {string}
+     * @memberof OptionalExchangeData
+     */
+    'provider_wallet_address'?: string;
+    /**
+     * Amount that was exchanged to
+     * @type {number}
+     * @memberof OptionalExchangeData
+     */
+    'to_amount'?: number;
+    /**
+     * Currency that was exchanged to
+     * @type {string}
+     * @memberof OptionalExchangeData
+     */
+    'to_currency'?: string;
+    /**
+     * Transfer ID
+     * @type {string}
+     * @memberof OptionalExchangeData
+     */
+    'transfer_id'?: string;
+}

package/dist/types/imx/models/order-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 OrderBuy
+ * Details of the asset being bought
+ * @export
+ */
+export type OrderBuy = Token;

package/dist/types/imx/models/order-details.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 OrderDetails
+ */
+export interface OrderDetails {
+    /**
+     * Buy orders for this asset
+     * @type {Array<object>}
+     * @memberof OrderDetails
+     */
+    'buy_orders'?: Array<object>;
+    /**
+     * Sell orders for this asset
+     * @type {Array<object>}
+     * @memberof OrderDetails
+     */
+    'sell_orders'?: Array<object>;
+}

package/dist/types/imx/models/order-fee-info-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 { FeeToken } from './fee-token';
+/**
+ * @type OrderFeeInfoToken
+ * Details of the fee currency
+ * @export
+ */
+export type OrderFeeInfoToken = FeeToken;

package/dist/types/imx/models/order-fee-info.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 { OrderFeeInfoToken } from './order-fee-info-token';
+/**
+ *
+ * @export
+ * @interface OrderFeeInfo
+ */
+export interface OrderFeeInfo {
+    /**
+     * Address of the fee recipient
+     * @type {string}
+     * @memberof OrderFeeInfo
+     */
+    'address'?: string;
+    /**
+     * Fee amount
+     * @type {string}
+     * @memberof OrderFeeInfo
+     */
+    'amount'?: string;
+    /**
+     *
+     * @type {OrderFeeInfoToken}
+     * @memberof OrderFeeInfo
+     */
+    'token'?: OrderFeeInfoToken;
+    /**
+     * Fee type
+     * @type {string}
+     * @memberof OrderFeeInfo
+     */
+    'type'?: string;
+}

package/dist/types/imx/models/order-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 OrderSell
+ * Details of the asset being sold
+ * @export
+ */
+export type OrderSell = Token;

package/dist/types/imx/models/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 OrderV3Buy
+ * Details of the asset being bought
+ * @export
+ */
+export type OrderV3Buy = Token;

package/dist/types/imx/models/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 { OrdersMakerTakerFee } from './orders-maker-taker-fee';
+/**
+ * @type OrderV3MakerFees
+ * MakerFees is the information about the fees that needs to be paid by the maker (liquidity)
+ * @export
+ */
+export type OrderV3MakerFees = OrdersMakerTakerFee;

package/dist/types/imx/models/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 OrderV3Sell
+ * Details of the asset being sold
+ * @export
+ */
+export type OrderV3Sell = Token;

package/dist/types/imx/models/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 { OrdersMakerTakerFee } from './orders-maker-taker-fee';
+/**
+ * @type OrderV3TakerFees
+ * TakerFees is the information about the fees that needs to be paid by the taker (liquidity)
+ * @export
+ */
+export type OrderV3TakerFees = OrdersMakerTakerFee;

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

@@ -0,0 +1,101 @@
+/**
+ * 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 { OrderFeeInfo } from './order-fee-info';
+import { OrderV3Buy } from './order-v3-buy';
+import { OrderV3MakerFees } from './order-v3-maker-fees';
+import { OrderV3Sell } from './order-v3-sell';
+import { OrderV3TakerFees } from './order-v3-taker-fees';
+/**
+ *
+ * @export
+ * @interface OrderV3
+ */
+export interface OrderV3 {
+    /**
+     * Amount of the asset already sold by this order
+     * @type {string}
+     * @memberof OrderV3
+     */
+    'amount_sold': string | null;
+    /**
+     *
+     * @type {OrderV3Buy}
+     * @memberof OrderV3
+     */
+    'buy': OrderV3Buy;
+    /**
+     * Expiration timestamp of this order
+     * @type {string}
+     * @memberof OrderV3
+     */
+    'expiration_timestamp': string | null;
+    /**
+     * [DEPRECATED] Fee information for the order. Replaced by maker_fees / taker_fees depending on the type of order. Refer https://docs.x.immutable.com/docs/maker-taker-fees/#new-maker-taker-fields-and-the-deprecation-of-quantity_with_fees-in-buy-and-sell.
+     * @type {Array<OrderFeeInfo>}
+     * @memberof OrderV3
+     */
+    'fees'?: Array<OrderFeeInfo>;
+    /**
+     *
+     * @type {OrderV3MakerFees}
+     * @memberof OrderV3
+     */
+    'maker_fees'?: OrderV3MakerFees;
+    /**
+     * MakerTakerType
+     * @type {string}
+     * @memberof OrderV3
+     */
+    'maker_taker_type'?: string;
+    /**
+     * ID of the order
+     * @type {number}
+     * @memberof OrderV3
+     */
+    'order_id': number;
+    /**
+     *
+     * @type {OrderV3Sell}
+     * @memberof OrderV3
+     */
+    'sell': OrderV3Sell;
+    /**
+     * Status of the order
+     * @type {string}
+     * @memberof OrderV3
+     */
+    'status': string;
+    /**
+     *
+     * @type {OrderV3TakerFees}
+     * @memberof OrderV3
+     */
+    'taker_fees'?: OrderV3TakerFees;
+    /**
+     * Timestamp this order was created
+     * @type {string}
+     * @memberof OrderV3
+     */
+    'timestamp': string | null;
+    /**
+     * Updated timestamp of this order
+     * @type {string}
+     * @memberof OrderV3
+     */
+    'updated_timestamp': string | null;
+    /**
+     * Ethereum address of the user who submitted the order
+     * @type {string}
+     * @memberof OrderV3
+     */
+    'user': string;
+}

package/dist/types/imx/models/order.d.ts

@@ -0,0 +1,81 @@
+/**
+ * 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 { OrderBuy } from './order-buy';
+import { OrderFeeInfo } from './order-fee-info';
+import { OrderSell } from './order-sell';
+/**
+ *
+ * @export
+ * @interface Order
+ */
+export interface Order {
+    /**
+     * Amount of the asset already sold by this order
+     * @type {string}
+     * @memberof Order
+     */
+    'amount_sold': string | null;
+    /**
+     *
+     * @type {OrderBuy}
+     * @memberof Order
+     */
+    'buy': OrderBuy;
+    /**
+     * Expiration timestamp of this order
+     * @type {string}
+     * @memberof Order
+     */
+    'expiration_timestamp': string | null;
+    /**
+     * Fee information for the order
+     * @type {Array<OrderFeeInfo>}
+     * @memberof Order
+     */
+    'fees'?: Array<OrderFeeInfo>;
+    /**
+     * ID of the order
+     * @type {number}
+     * @memberof Order
+     */
+    'order_id': number;
+    /**
+     *
+     * @type {OrderSell}
+     * @memberof Order
+     */
+    'sell': OrderSell;
+    /**
+     * Status of the order
+     * @type {string}
+     * @memberof Order
+     */
+    'status': string;
+    /**
+     * Timestamp this order was created
+     * @type {string}
+     * @memberof Order
+     */
+    'timestamp': string | null;
+    /**
+     * Updated timestamp of this order
+     * @type {string}
+     * @memberof Order
+     */
+    'updated_timestamp': string | null;
+    /**
+     * Ethereum address of the user who submitted the order
+     * @type {string}
+     * @memberof Order
+     */
+    'user': string;
+}

package/dist/types/imx/models/orders-maker-taker-fee.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 { OrderFeeInfo } from './order-fee-info';
+/**
+ *
+ * @export
+ * @interface OrdersMakerTakerFee
+ */
+export interface OrdersMakerTakerFee {
+    /**
+     * Number of Decimals supported the fee token
+     * @type {number}
+     * @memberof OrdersMakerTakerFee
+     */
+    'decimals'?: number;
+    /**
+     * Fees
+     * @type {Array<OrderFeeInfo>}
+     * @memberof OrdersMakerTakerFee
+     */
+    'fees'?: Array<OrderFeeInfo>;
+    /**
+     * Quantity of this asset with the sum of all fees applied to the asset
+     * @type {string}
+     * @memberof OrdersMakerTakerFee
+     */
+    'quantity_with_fees': string;
+    /**
+     * Symbol of the fee token
+     * @type {string}
+     * @memberof OrdersMakerTakerFee
+     */
+    'symbol'?: string;
+    /**
+     * Address of the ERC20 contract for the fee token
+     * @type {string}
+     * @memberof OrdersMakerTakerFee
+     */
+    'token_address'?: string;
+    /**
+     * Type of the fee token (ETH/ERC20)
+     * @type {string}
+     * @memberof OrdersMakerTakerFee
+     */
+    'token_type'?: string;
+}

package/dist/types/imx/models/project.d.ts

@@ -0,0 +1,126 @@
+/**
+ * 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 Project
+ */
+export interface Project {
+    /**
+     * API key for the project. This is only for zkevm project. This API is not for increasing rate limit yet.
+     * @type {string}
+     * @memberof Project
+     */
+    'api_key'?: string;
+    /**
+     * The project ChainType
+     * @type {string}
+     * @memberof Project
+     */
+    'chain_type'?: string;
+    /**
+     * The current period expiry date for collection limit
+     * @type {string}
+     * @memberof Project
+     */
+    'collection_limit_expires_at': string;
+    /**
+     * The total monthly collection limit
+     * @type {number}
+     * @memberof Project
+     */
+    'collection_monthly_limit': number;
+    /**
+     * The number of collection remaining in the current period
+     * @type {number}
+     * @memberof Project
+     */
+    'collection_remaining': number;
+    /**
+     * The company name
+     * @type {string}
+     * @memberof Project
+     */
+    'company_name': string;
+    /**
+     * The project contact email (must be registered as a developer account with Immutable at https://hub.immutable.com)
+     * @type {string}
+     * @memberof Project
+     */
+    'contact_email': string;
+    /**
+     * The environment ID
+     * @type {string}
+     * @memberof Project
+     */
+    'environment_id'?: string;
+    /**
+     * The user environment name correlating to this project
+     * @type {string}
+     * @memberof Project
+     */
+    'environment_name'?: string;
+    /**
+     * The project ID
+     * @type {number}
+     * @memberof Project
+     */
+    'id': number;
+    /**
+     * The current period expiry date for mint operation limit
+     * @type {string}
+     * @memberof Project
+     */
+    'mint_limit_expires_at': string;
+    /**
+     * The total monthly mint operation limit
+     * @type {number}
+     * @memberof Project
+     */
+    'mint_monthly_limit': number;
+    /**
+     * The number of mint operation remaining in the current period
+     * @type {number}
+     * @memberof Project
+     */
+    'mint_remaining': number;
+    /**
+     * The project name
+     * @type {string}
+     * @memberof Project
+     */
+    'name': string;
+    /**
+     * The organisation ID that the project belongs to
+     * @type {string}
+     * @memberof Project
+     */
+    'org_id'?: string;
+    /**
+     * Project group id
+     * @type {string}
+     * @memberof Project
+     */
+    'project_group_id'?: string;
+    /**
+     * The public publishable_key for the project
+     * @type {string}
+     * @memberof Project
+     */
+    'publishable_key'?: string;
+    /**
+     * The public publishable_key created time
+     * @type {string}
+     * @memberof Project
+     */
+    'publishable_key_created_at'?: string;
+}

package/dist/types/imx/models/range.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 Range
+ */
+export interface Range {
+    /**
+     * Maximum value
+     * @type {number}
+     * @memberof Range
+     */
+    'max'?: number;
+    /**
+     * Minimum value
+     * @type {number}
+     * @memberof Range
+     */
+    'min'?: number;
+}