@imtbl/sdk 1.43.3 → 1.43.4

package/dist/transfer.d-87728423.d.ts

@@ -0,0 +1,898 @@
+/**
+ * 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 CollectionDetails
+ */
+interface CollectionDetails {
+    /**
+     * URL of the icon of the collection
+     * @type {string}
+     * @memberof CollectionDetails
+     */
+    'icon_url': string | null;
+    /**
+     * Name of the collection
+     * @type {string}
+     * @memberof CollectionDetails
+     */
+    'name': string;
+}
+
+/**
+ * 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.
+ */
+
+/**
+ * @type AssetPropertiesCollection
+ * Details of this asset\'s collection
+ * @export
+ */
+type AssetPropertiesCollection = CollectionDetails;
+
+/**
+ * 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 AssetProperties
+ */
+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;
+}
+
+/**
+ * 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.
+ */
+
+/**
+ * @type TokenDataProperties
+ * Properties of this asset
+ * @export
+ */
+type TokenDataProperties = AssetProperties;
+
+/**
+ * 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 TokenData
+ */
+interface TokenData {
+    /**
+     * Number of decimals supported by this asset
+     * @type {number}
+     * @memberof TokenData
+     */
+    'decimals'?: number;
+    /**
+     * [DEPRECATED] Internal Immutable X Token ID
+     * @type {string}
+     * @memberof TokenData
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {TokenDataProperties}
+     * @memberof TokenData
+     */
+    'properties'?: TokenDataProperties;
+    /**
+     * Quantity of this asset - inclusive of fees for buy order in v1 API and exclusive of fees in v3 API
+     * @type {string}
+     * @memberof TokenData
+     */
+    'quantity': string;
+    /**
+     * [DEPRECATED for v3 endpoints] Quantity of this asset with the sum of all fees applied to the asset. Replaced by quantity_with_fees in 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 {string}
+     * @memberof TokenData
+     */
+    'quantity_with_fees': string;
+    /**
+     * Symbol of a token
+     * @type {string}
+     * @memberof TokenData
+     */
+    'symbol'?: string;
+    /**
+     * Address of ERC721/ERC20 contract
+     * @type {string}
+     * @memberof TokenData
+     */
+    'token_address'?: string;
+    /**
+     * ERC721 Token ID
+     * @type {string}
+     * @memberof TokenData
+     */
+    'token_id'?: string;
+}
+
+/**
+ * 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.
+ */
+
+/**
+ * @type TokenDataOAIGen
+ * Token details of this asset
+ * @export
+ */
+type TokenDataOAIGen = TokenData;
+
+/**
+ * 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 Token
+ */
+interface Token {
+    /**
+     *
+     * @type {TokenDataOAIGen}
+     * @memberof Token
+     */
+    'data': TokenDataOAIGen;
+    /**
+     * Type of this asset (ETH/ERC20/ERC721)
+     * @type {string}
+     * @memberof Token
+     */
+    'type': string;
+}
+
+/**
+ * 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 FeeData
+ */
+interface FeeData {
+    /**
+     * Address of ERC721/ERC20 contract
+     * @type {string}
+     * @memberof FeeData
+     */
+    'contract_address'?: string;
+    /**
+     * Number of decimals supported by this asset
+     * @type {number}
+     * @memberof FeeData
+     */
+    'decimals'?: number;
+}
+
+/**
+ * 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.
+ */
+
+/**
+ * @type FeeTokenData
+ * Fee token data details
+ * @export
+ */
+type FeeTokenData = FeeData;
+
+/**
+ * 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 FeeToken
+ */
+interface FeeToken {
+    /**
+     *
+     * @type {FeeTokenData}
+     * @memberof FeeToken
+     */
+    'data'?: FeeTokenData;
+    /**
+     * Fee token type. One of ETH/ERC20
+     * @type {string}
+     * @memberof FeeToken
+     */
+    'type'?: FeeTokenTypeEnum;
+}
+declare const FeeTokenTypeEnum: {
+    readonly Eth: "ETH";
+    readonly Erc20: "ERC20";
+};
+type FeeTokenTypeEnum = typeof FeeTokenTypeEnum[keyof typeof FeeTokenTypeEnum];
+
+/**
+ * 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.
+ */
+
+/**
+ * @type OrderFeeInfoToken
+ * Details of the fee currency
+ * @export
+ */
+type OrderFeeInfoToken = FeeToken;
+
+/**
+ * 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 OrderFeeInfo
+ */
+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;
+}
+
+/**
+ * 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.
+ */
+
+/**
+ * @type AssetCollection
+ * Information about the collection to which this asset belongs
+ * @export
+ */
+type AssetCollection = CollectionDetails;
+
+/**
+ * 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
+ */
+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>;
+}
+
+/**
+ * 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.
+ */
+
+/**
+ * @type AssetOrders
+ * [DEPRECATED] Open orders for this asset will always return empty. Use GET /orders
+ * @export
+ */
+type AssetOrders = OrderDetails;
+
+/**
+ * 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 Fee
+ */
+interface Fee {
+    /**
+     * Wallet address
+     * @type {string}
+     * @memberof Fee
+     */
+    'address': string;
+    /**
+     * The percentage of fee
+     * @type {number}
+     * @memberof Fee
+     */
+    'percentage': number;
+    /**
+     * Type of fee. Examples: `royalty`, `maker`, `taker` or `protocol`
+     * @type {string}
+     * @memberof Fee
+     */
+    'type': string;
+}
+
+/**
+ * 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 Asset
+ */
+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;
+}
+
+/**
+ * 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.
+ */
+
+/**
+ * @type OrderV3Buy
+ * Details of the asset being bought
+ * @export
+ */
+type OrderV3Buy = Token;
+
+/**
+ * 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 OrdersMakerTakerFee
+ */
+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;
+}
+
+/**
+ * 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.
+ */
+
+/**
+ * @type OrderV3MakerFees
+ * MakerFees is the information about the fees that needs to be paid by the maker (liquidity)
+ * @export
+ */
+type OrderV3MakerFees = OrdersMakerTakerFee;
+
+/**
+ * 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.
+ */
+
+/**
+ * @type OrderV3Sell
+ * Details of the asset being sold
+ * @export
+ */
+type OrderV3Sell = Token;
+
+/**
+ * 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.
+ */
+
+/**
+ * @type OrderV3TakerFees
+ * TakerFees is the information about the fees that needs to be paid by the taker (liquidity)
+ * @export
+ */
+type OrderV3TakerFees = OrdersMakerTakerFee;
+
+/**
+ * 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 OrderV3
+ */
+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;
+}
+
+/**
+ * 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.
+ */
+
+/**
+ * @type TransferToken
+ * Token transferred by the user
+ * @export
+ */
+type TransferToken = Token;
+
+/**
+ * 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 Transfer
+ */
+interface Transfer {
+    /**
+     * Ethereum address of the user who received this transfer
+     * @type {string}
+     * @memberof Transfer
+     */
+    'receiver': string;
+    /**
+     * Status of the transaction
+     * @type {string}
+     * @memberof Transfer
+     */
+    'status': string;
+    /**
+     * Timestamp of the transfer
+     * @type {string}
+     * @memberof Transfer
+     */
+    'timestamp': string | null;
+    /**
+     *
+     * @type {TransferToken}
+     * @memberof Transfer
+     */
+    'token': TransferToken;
+    /**
+     * Sequential transaction ID
+     * @type {number}
+     * @memberof Transfer
+     */
+    'transaction_id': number;
+    /**
+     * Ethereum address of the user  who submitted this transfer
+     * @type {string}
+     * @memberof Transfer
+     */
+    'user': string;
+}
+
+export { Asset as A, CollectionDetails as C, Fee as F, OrderV3 as O, Transfer as T, OrderDetails as a, Token as b };