@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/imx/models/api-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 { ApiOrderV3Buy } from './api-order-v3-buy';
+import { ApiOrderV3MakerFees } from './api-order-v3-maker-fees';
+import { ApiOrderV3Sell } from './api-order-v3-sell';
+import { ApiOrderV3TakerFees } from './api-order-v3-taker-fees';
+import { OrderFeeInfo } from './order-fee-info';
+/**
+ *
+ * @export
+ * @interface ApiOrderV3
+ */
+export interface ApiOrderV3 {
+    /**
+     * Amount of the asset already sold by this order
+     * @type {string}
+     * @memberof ApiOrderV3
+     */
+    'amount_sold': string | null;
+    /**
+     *
+     * @type {ApiOrderV3Buy}
+     * @memberof ApiOrderV3
+     */
+    'buy': ApiOrderV3Buy;
+    /**
+     * Expiration timestamp of this order
+     * @type {string}
+     * @memberof ApiOrderV3
+     */
+    'expiration_timestamp': string | null;
+    /**
+     * Fee information for the order
+     * @type {Array<OrderFeeInfo>}
+     * @memberof ApiOrderV3
+     */
+    'fees'?: Array<OrderFeeInfo>;
+    /**
+     *
+     * @type {ApiOrderV3MakerFees}
+     * @memberof ApiOrderV3
+     */
+    'maker_fees'?: ApiOrderV3MakerFees;
+    /**
+     * MakerTakerType
+     * @type {string}
+     * @memberof ApiOrderV3
+     */
+    'maker_taker_type'?: string;
+    /**
+     * ID of the order
+     * @type {number}
+     * @memberof ApiOrderV3
+     */
+    'order_id': number;
+    /**
+     *
+     * @type {ApiOrderV3Sell}
+     * @memberof ApiOrderV3
+     */
+    'sell': ApiOrderV3Sell;
+    /**
+     * Status of the order
+     * @type {string}
+     * @memberof ApiOrderV3
+     */
+    'status': string;
+    /**
+     *
+     * @type {ApiOrderV3TakerFees}
+     * @memberof ApiOrderV3
+     */
+    'taker_fees'?: ApiOrderV3TakerFees;
+    /**
+     * Timestamp this order was created
+     * @type {string}
+     * @memberof ApiOrderV3
+     */
+    'timestamp': string | null;
+    /**
+     * Updated timestamp of this order
+     * @type {string}
+     * @memberof ApiOrderV3
+     */
+    'updated_timestamp': string | null;
+    /**
+     * Ethereum address of the user who submitted the order
+     * @type {string}
+     * @memberof ApiOrderV3
+     */
+    'user': string;
+}

package/dist/types/imx/models/api-register-passport-user-request.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 ApiRegisterPassportUserRequest
+ */
+export interface ApiRegisterPassportUserRequest {
+    /**
+     * Eth signature
+     * @type {string}
+     * @memberof ApiRegisterPassportUserRequest
+     */
+    'eth_signature': string;
+    /**
+     * The ether key of the user
+     * @type {string}
+     * @memberof ApiRegisterPassportUserRequest
+     */
+    'ether_key': string;
+    /**
+     * Public stark key of the user
+     * @type {string}
+     * @memberof ApiRegisterPassportUserRequest
+     */
+    'stark_key': string;
+    /**
+     * Payload signature
+     * @type {string}
+     * @memberof ApiRegisterPassportUserRequest
+     */
+    'stark_signature': string;
+}

package/dist/types/imx/models/api-sdkversion-check-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 ApiSDKVersionCheckResponse
+ */
+export interface ApiSDKVersionCheckResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof ApiSDKVersionCheckResponse
+     */
+    'message'?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ApiSDKVersionCheckResponse
+     */
+    'ok'?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ApiSDKVersionCheckResponse
+     */
+    'runtimeId'?: string;
+}

package/dist/types/imx/models/api-summarize-collections-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 { SummarizedCollection } from './summarized-collection';
+/**
+ *
+ * @export
+ * @interface ApiSummarizeCollectionsResponse
+ */
+export interface ApiSummarizeCollectionsResponse {
+    /**
+     * Generated cursor returned by previous query
+     * @type {string}
+     * @memberof ApiSummarizeCollectionsResponse
+     */
+    'cursor': string;
+    /**
+     * Remaining results flag. 1: there are remaining results matching this query, 0: no remaining results
+     * @type {number}
+     * @memberof ApiSummarizeCollectionsResponse
+     */
+    'remaining': number;
+    /**
+     * Collections matching query parameters
+     * @type {Array<SummarizedCollection>}
+     * @memberof ApiSummarizeCollectionsResponse
+     */
+    'result': Array<SummarizedCollection>;
+}

package/dist/types/imx/models/api-summarized-collection.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 { Collection } from './collection';
+/**
+ *
+ * @export
+ * @interface ApiSummarizedCollection
+ */
+export interface ApiSummarizedCollection {
+    /**
+     *
+     * @type {Collection}
+     * @memberof ApiSummarizedCollection
+     */
+    'collection': Collection;
+    /**
+     *
+     * @type {number}
+     * @memberof ApiSummarizedCollection
+     */
+    'owned_token_count': number;
+}

package/dist/types/imx/models/apierror.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 APIError
+ */
+export interface APIError {
+    /**
+     * The error code
+     * @type {string}
+     * @memberof APIError
+     */
+    'code': string;
+    /**
+     * The error details
+     * @type {string}
+     * @memberof APIError
+     */
+    'details'?: string;
+    /**
+     * The error message
+     * @type {string}
+     * @memberof APIError
+     */
+    'message': string;
+}

package/dist/types/imx/models/asset-collection.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 { CollectionDetails } from './collection-details';
+/**
+ * @type AssetCollection
+ * Information about the collection to which this asset belongs
+ * @export
+ */
+export type AssetCollection = CollectionDetails;

package/dist/types/imx/models/asset-orders.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 { OrderDetails } from './order-details';
+/**
+ * @type AssetOrders
+ * [DEPRECATED] Open orders for this asset will always return empty. Use GET /orders
+ * @export
+ */
+export type AssetOrders = OrderDetails;

package/dist/types/imx/models/asset-properties-collection.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 { CollectionDetails } from './collection-details';
+/**
+ * @type AssetPropertiesCollection
+ * Details of this asset\'s collection
+ * @export
+ */
+export type AssetPropertiesCollection = CollectionDetails;

package/dist/types/imx/models/asset-properties.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 { AssetPropertiesCollection } from './asset-properties-collection';
+/**
+ *
+ * @export
+ * @interface AssetProperties
+ */
+export interface AssetProperties {
+    /**
+     *
+     * @type {AssetPropertiesCollection}
+     * @memberof AssetProperties
+     */
+    'collection'?: AssetPropertiesCollection;
+    /**
+     * Image URL of this asset
+     * @type {string}
+     * @memberof AssetProperties
+     */
+    'image_url'?: string;
+    /**
+     * Name of this asset
+     * @type {string}
+     * @memberof AssetProperties
+     */
+    'name'?: string;
+}

package/dist/types/imx/models/asset-with-orders-collection.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 { CollectionDetails } from './collection-details';
+/**
+ * @type AssetWithOrdersCollection
+ * Information about the collection to which this asset belongs
+ * @export
+ */
+export type AssetWithOrdersCollection = CollectionDetails;

package/dist/types/imx/models/asset-with-orders-orders.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 { OrderDetails } from './order-details';
+/**
+ * @type AssetWithOrdersOrders
+ * Open orders for this asset
+ * @export
+ */
+export type AssetWithOrdersOrders = OrderDetails;

package/dist/types/imx/models/asset-with-orders.d.ts

@@ -0,0 +1,111 @@
+/**
+ * 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 { AssetWithOrdersCollection } from './asset-with-orders-collection';
+import { AssetWithOrdersOrders } from './asset-with-orders-orders';
+import { Fee } from './fee';
+/**
+ *
+ * @export
+ * @interface AssetWithOrders
+ */
+export interface AssetWithOrders {
+    /**
+     *
+     * @type {AssetWithOrdersCollection}
+     * @memberof AssetWithOrders
+     */
+    'collection': AssetWithOrdersCollection;
+    /**
+     * Timestamp of when the asset was created
+     * @type {string}
+     * @memberof AssetWithOrders
+     */
+    'created_at': string | null;
+    /**
+     * Description of this asset
+     * @type {string}
+     * @memberof AssetWithOrders
+     */
+    'description': string | null;
+    /**
+     * Royalties to pay on this asset operations
+     * @type {Array<Fee>}
+     * @memberof AssetWithOrders
+     */
+    'fees'?: Array<Fee>;
+    /**
+     * [DEPRECATED] Internal Immutable X Token ID
+     * @type {string}
+     * @memberof AssetWithOrders
+     */
+    'id'?: string;
+    /**
+     * URL of the image which should be used for this asset
+     * @type {string}
+     * @memberof AssetWithOrders
+     */
+    'image_url': string | null;
+    /**
+     * Metadata of this asset
+     * @type {object}
+     * @memberof AssetWithOrders
+     */
+    'metadata': object | null;
+    /**
+     * Name of this asset
+     * @type {string}
+     * @memberof AssetWithOrders
+     */
+    'name': string | null;
+    /**
+     *
+     * @type {AssetWithOrdersOrders}
+     * @memberof AssetWithOrders
+     */
+    'orders'?: AssetWithOrdersOrders;
+    /**
+     * Status of this asset (where it is in the system)
+     * @type {string}
+     * @memberof AssetWithOrders
+     */
+    'status': string;
+    /**
+     * Address of the ERC721 contract
+     * @type {string}
+     * @memberof AssetWithOrders
+     */
+    'token_address': string;
+    /**
+     * ERC721 Token ID of this asset
+     * @type {string}
+     * @memberof AssetWithOrders
+     */
+    'token_id': string;
+    /**
+     * Timestamp of when the asset was updated
+     * @type {string}
+     * @memberof AssetWithOrders
+     */
+    'updated_at': string | null;
+    /**
+     * URI to access this asset externally to Immutable X
+     * @type {string}
+     * @memberof AssetWithOrders
+     */
+    'uri': string | null;
+    /**
+     * Ethereum address of the user who owns this asset
+     * @type {string}
+     * @memberof AssetWithOrders
+     */
+    'user': string;
+}

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

@@ -0,0 +1,111 @@
+/**
+ * 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 { AssetCollection } from './asset-collection';
+import { AssetOrders } from './asset-orders';
+import { Fee } from './fee';
+/**
+ *
+ * @export
+ * @interface Asset
+ */
+export interface Asset {
+    /**
+     *
+     * @type {AssetCollection}
+     * @memberof Asset
+     */
+    'collection': AssetCollection;
+    /**
+     * Timestamp of when the asset was created
+     * @type {string}
+     * @memberof Asset
+     */
+    'created_at': string | null;
+    /**
+     * Description of this asset
+     * @type {string}
+     * @memberof Asset
+     */
+    'description': string | null;
+    /**
+     * Royalties to pay on this asset operations
+     * @type {Array<Fee>}
+     * @memberof Asset
+     */
+    'fees'?: Array<Fee>;
+    /**
+     * [DEPRECATED] Internal Immutable X Token ID
+     * @type {string}
+     * @memberof Asset
+     */
+    'id'?: string;
+    /**
+     * URL of the image which should be used for this asset
+     * @type {string}
+     * @memberof Asset
+     */
+    'image_url': string | null;
+    /**
+     * Metadata of this asset
+     * @type {object}
+     * @memberof Asset
+     */
+    'metadata': object | null;
+    /**
+     * Name of this asset
+     * @type {string}
+     * @memberof Asset
+     */
+    'name': string | null;
+    /**
+     *
+     * @type {AssetOrders}
+     * @memberof Asset
+     */
+    'orders'?: AssetOrders;
+    /**
+     * Status of this asset (where it is in the system)
+     * @type {string}
+     * @memberof Asset
+     */
+    'status': string;
+    /**
+     * Address of the ERC721 contract
+     * @type {string}
+     * @memberof Asset
+     */
+    'token_address': string;
+    /**
+     * ERC721 Token ID of this asset
+     * @type {string}
+     * @memberof Asset
+     */
+    'token_id': string;
+    /**
+     * Timestamp of when the asset was updated
+     * @type {string}
+     * @memberof Asset
+     */
+    'updated_at': string | null;
+    /**
+     * URI to access this asset externally to Immutable X
+     * @type {string}
+     * @memberof Asset
+     */
+    'uri': string | null;
+    /**
+     * Ethereum address of the user who owns this asset
+     * @type {string}
+     * @memberof Asset
+     */
+    'user': string;
+}

package/dist/types/imx/models/balance.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 Balance
+ */
+export interface Balance {
+    /**
+     * Amount which is currently inside the exchange
+     * @type {string}
+     * @memberof Balance
+     */
+    'balance': string;
+    /**
+     * Amount which is currently preparing withdrawal from the exchange
+     * @type {string}
+     * @memberof Balance
+     */
+    'preparing_withdrawal': string;
+    /**
+     * Symbol of the token (e.g. ETH, IMX)
+     * @type {string}
+     * @memberof Balance
+     */
+    'symbol': string;
+    /**
+     * Address of the contract that represents this ERC20 token or empty for ETH
+     * @type {string}
+     * @memberof Balance
+     */
+    'token_address': string;
+    /**
+     * Amount which is currently withdrawable from the exchange
+     * @type {string}
+     * @memberof Balance
+     */
+    'withdrawable': string;
+}