@imtbl/generated-clients 2.0.0-alpha.0

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

package/dist/types/imx/models/register-passport-user-result.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 RegisterPassportUserResult
+ */
+export interface RegisterPassportUserResult {
+    /**
+     * The ether key of the user
+     * @type {string}
+     * @memberof RegisterPassportUserResult
+     */
+    'ether_key'?: string;
+    /**
+     * The stark key of the user
+     * @type {string}
+     * @memberof RegisterPassportUserResult
+     */
+    'stark_key'?: string;
+    /**
+     * The admin key of the user
+     * @type {string}
+     * @memberof RegisterPassportUserResult
+     */
+    'user_admin_key'?: string;
+}

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

package/dist/types/imx/models/register-user-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 RegisterUserResponse
+ */
+export interface RegisterUserResponse {
+    /**
+     * Immutable signature authorising registration
+     * @type {string}
+     * @memberof RegisterUserResponse
+     */
+    'tx_hash': string;
+}

package/dist/types/imx/models/signable-token.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 SignableToken
+ */
+export interface SignableToken {
+    /**
+     * Token data. See https://docs.x.immutable.com/docs/token-data-object
+     * @type {object}
+     * @memberof SignableToken
+     */
+    'data'?: object;
+    /**
+     * Type of token
+     * @type {string}
+     * @memberof SignableToken
+     */
+    'type'?: string;
+}

package/dist/types/imx/models/signable-transfer-details-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 SignableTransferDetailsToken
+ * Token to transfer
+ * @export
+ */
+export type SignableTransferDetailsToken = SignableToken;

package/dist/types/imx/models/signable-transfer-details-v2-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 SignableTransferDetailsV2Token
+ * Token to transfer
+ * @export
+ */
+export type SignableTransferDetailsV2Token = SignableToken;

package/dist/types/imx/models/signable-transfer-details-v2.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 { SignableTransferDetailsV2Token } from './signable-transfer-details-v2-token';
+/**
+ *
+ * @export
+ * @interface SignableTransferDetailsV2
+ */
+export interface SignableTransferDetailsV2 {
+    /**
+     * Amount of the token to transfer
+     * @type {string}
+     * @memberof SignableTransferDetailsV2
+     */
+    'amount': string;
+    /**
+     * Ethereum address of the receiving user
+     * @type {string}
+     * @memberof SignableTransferDetailsV2
+     */
+    'receiver': string;
+    /**
+     *
+     * @type {SignableTransferDetailsV2Token}
+     * @memberof SignableTransferDetailsV2
+     */
+    'token': SignableTransferDetailsV2Token;
+}

package/dist/types/imx/models/signable-transfer-details.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 { SignableTransferDetailsToken } from './signable-transfer-details-token';
+/**
+ *
+ * @export
+ * @interface SignableTransferDetails
+ */
+export interface SignableTransferDetails {
+    /**
+     * Amount of the token to transfer
+     * @type {string}
+     * @memberof SignableTransferDetails
+     */
+    'amount': string;
+    /**
+     * Ethereum address of the receiving user
+     * @type {string}
+     * @memberof SignableTransferDetails
+     */
+    'receiver': string;
+    /**
+     *
+     * @type {SignableTransferDetailsToken}
+     * @memberof SignableTransferDetails
+     */
+    'token': SignableTransferDetailsToken;
+}

package/dist/types/imx/models/signable-transfer-response-details-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 SignableTransferResponseDetailsToken
+ * Token in request to match in SDK implementation
+ * @export
+ */
+export type SignableTransferResponseDetailsToken = SignableToken;

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

@@ -0,0 +1,85 @@
+/**
+ * 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 { SignableTransferResponseDetailsToken } from './signable-transfer-response-details-token';
+/**
+ *
+ * @export
+ * @interface SignableTransferResponseDetails
+ */
+export interface SignableTransferResponseDetails {
+    /**
+     * Amount of the asset being transferred
+     * @type {string}
+     * @memberof SignableTransferResponseDetails
+     */
+    'amount': string;
+    /**
+     * ID of the asset being transferred
+     * @type {string}
+     * @memberof SignableTransferResponseDetails
+     */
+    'asset_id': string;
+    /**
+     * Timestamp when this transfer will expire
+     * @type {number}
+     * @memberof SignableTransferResponseDetails
+     */
+    'expiration_timestamp': number;
+    /**
+     * Nonce of the transfer
+     * @type {number}
+     * @memberof SignableTransferResponseDetails
+     */
+    'nonce': number;
+    /**
+     * Hash of the payload to be signed for transfer
+     * @type {string}
+     * @memberof SignableTransferResponseDetails
+     */
+    'payload_hash': string;
+    /**
+     * EIP-712 encoding of the StarkEx transfer request to be displayed to the user
+     * @type {string}
+     * @memberof SignableTransferResponseDetails
+     */
+    'readable_transaction': string;
+    /**
+     * Receiver of the transfer
+     * @type {string}
+     * @memberof SignableTransferResponseDetails
+     */
+    'receiver_stark_key': string;
+    /**
+     * ID of the vault being transferred to
+     * @type {number}
+     * @memberof SignableTransferResponseDetails
+     */
+    'receiver_vault_id': number;
+    /**
+     * ID of the vault being transferred from
+     * @type {number}
+     * @memberof SignableTransferResponseDetails
+     */
+    'sender_vault_id': number;
+    /**
+     *
+     * @type {SignableTransferResponseDetailsToken}
+     * @memberof SignableTransferResponseDetails
+     */
+    'token': SignableTransferResponseDetailsToken;
+    /**
+     * IMX signed readable_transaction and payload_hash
+     * @type {string}
+     * @memberof SignableTransferResponseDetails
+     */
+    'verification_signature': string;
+}

package/dist/types/imx/models/store-maker-taker-fee.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 { OrderFeeInfo } from './order-fee-info';
+/**
+ *
+ * @export
+ * @interface StoreMakerTakerFee
+ */
+export interface StoreMakerTakerFee {
+    /**
+     * Fees
+     * @type {Array<OrderFeeInfo>}
+     * @memberof StoreMakerTakerFee
+     */
+    'fees'?: Array<OrderFeeInfo>;
+    /**
+     * Quantity of this asset with the sum of all fees applied to the asset
+     * @type {string}
+     * @memberof StoreMakerTakerFee
+     */
+    'quantity_with_fees': string;
+}

package/dist/types/imx/models/success-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 SuccessResponse
+ */
+export interface SuccessResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof SuccessResponse
+     */
+    'result': string;
+}

package/dist/types/imx/models/summarized-collection-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 { Collection } from './collection';
+/**
+ * @type SummarizedCollectionCollection
+ * Collection and it\'s metadata
+ * @export
+ */
+export type SummarizedCollectionCollection = Collection;

package/dist/types/imx/models/summarized-collection.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 { SummarizedCollectionCollection } from './summarized-collection-collection';
+/**
+ *
+ * @export
+ * @interface SummarizedCollection
+ */
+export interface SummarizedCollection {
+    /**
+     *
+     * @type {SummarizedCollectionCollection}
+     * @memberof SummarizedCollection
+     */
+    'collection': SummarizedCollectionCollection;
+    /**
+     * Combined amount of tokens owned by the provided wallets
+     * @type {number}
+     * @memberof SummarizedCollection
+     */
+    'owned_token_count': number;
+    /**
+     * Subset of the provided wallets that own at least one token in this collection
+     * @type {Array<string>}
+     * @memberof SummarizedCollection
+     */
+    'owners': Array<string>;
+}

package/dist/types/imx/models/token-data-oaigen.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 { TokenData } from './token-data';
+/**
+ * @type TokenDataOAIGen
+ * Token details of this asset
+ * @export
+ */
+export type TokenDataOAIGen = TokenData;

package/dist/types/imx/models/token-data-properties.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 { AssetProperties } from './asset-properties';
+/**
+ * @type TokenDataProperties
+ * Properties of this asset
+ * @export
+ */
+export type TokenDataProperties = AssetProperties;

package/dist/types/imx/models/token-data.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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 { TokenDataProperties } from './token-data-properties';
+/**
+ *
+ * @export
+ * @interface TokenData
+ */
+export 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;
+}

package/dist/types/imx/models/token-details.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 TokenDetails
+ */
+export interface TokenDetails {
+    /**
+     * Number of decimals for token
+     * @type {string}
+     * @memberof TokenDetails
+     */
+    'decimals': string;
+    /**
+     * Url for the icon of the token
+     * @type {string}
+     * @memberof TokenDetails
+     */
+    'image_url': string;
+    /**
+     * Full name of the token (e.g. Ether)
+     * @type {string}
+     * @memberof TokenDetails
+     */
+    'name': string;
+    /**
+     * Quantum for token
+     * @type {string}
+     * @memberof TokenDetails
+     */
+    'quantum': string;
+    /**
+     * Ticker symbol for token (e.g. ETH/USDC/IMX)
+     * @type {string}
+     * @memberof TokenDetails
+     */
+    'symbol': string;
+    /**
+     * Address of the ERC20 contract
+     * @type {string}
+     * @memberof TokenDetails
+     */
+    'token_address': string;
+}