@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/imx/models/token.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 { TokenDataOAIGen } from './token-data-oaigen';
+/**
+ *
+ * @export
+ * @interface Token
+ */
+export interface Token {
+    /**
+     *
+     * @type {TokenDataOAIGen}
+     * @memberof Token
+     */
+    'data': TokenDataOAIGen;
+    /**
+     * Type of this asset (ETH/ERC20/ERC721)
+     * @type {string}
+     * @memberof Token
+     */
+    'type': string;
+}

package/dist/types/imx/models/trade-a.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 { TradeSide } from './trade-side';
+/**
+ * @type TradeA
+ * Side A of this trade (the buy order)
+ * @export
+ */
+export type TradeA = TradeSide;

package/dist/types/imx/models/trade-b.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 { TradeSide } from './trade-side';
+/**
+ * @type TradeB
+ * Side B of this trade (the sell order)
+ * @export
+ */
+export type TradeB = TradeSide;

package/dist/types/imx/models/trade-side.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 TradeSide
+ */
+export interface TradeSide {
+    /**
+     * The ID of the order involved in the trade
+     * @type {number}
+     * @memberof TradeSide
+     */
+    'order_id': number;
+    /**
+     * The amount of that order\'s asset this trade sold
+     * @type {string}
+     * @memberof TradeSide
+     */
+    'sold': string;
+    /**
+     * The contract address of the token that this trade sold
+     * @type {string}
+     * @memberof TradeSide
+     */
+    'token_address'?: string;
+    /**
+     * The ID of the token that this trade sold
+     * @type {string}
+     * @memberof TradeSide
+     */
+    'token_id'?: string;
+    /**
+     * The type of the token that this trade sold
+     * @type {string}
+     * @memberof TradeSide
+     */
+    'token_type': string;
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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 { TradeA } from './trade-a';
+import { TradeB } from './trade-b';
+/**
+ *
+ * @export
+ * @interface Trade
+ */
+export interface Trade {
+    /**
+     *
+     * @type {TradeA}
+     * @memberof Trade
+     */
+    'a': TradeA;
+    /**
+     *
+     * @type {TradeB}
+     * @memberof Trade
+     */
+    'b': TradeB;
+    /**
+     * Status of this trade
+     * @type {string}
+     * @memberof Trade
+     */
+    'status': string;
+    /**
+     * Time this trade occurred
+     * @type {string}
+     * @memberof Trade
+     */
+    'timestamp': string | null;
+    /**
+     * Sequential ID of this trade within Immutable X
+     * @type {number}
+     * @memberof Trade
+     */
+    'transaction_id': number;
+}

package/dist/types/imx/models/trades-create-trade-request-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 TradesCreateTradeRequestFeeInfo
+ * Fee details
+ * @export
+ */
+export type TradesCreateTradeRequestFeeInfo = FeeInfo;

package/dist/types/imx/models/trades-create-trade-request.d.ts

@@ -0,0 +1,104 @@
+/**
+ * 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 { TradesCreateTradeRequestFeeInfo } from './trades-create-trade-request-fee-info';
+/**
+ *
+ * @export
+ * @interface TradesCreateTradeRequest
+ */
+export interface TradesCreateTradeRequest {
+    /**
+     * Amount to buy
+     * @type {string}
+     * @memberof TradesCreateTradeRequest
+     */
+    'amount_buy': string;
+    /**
+     * Amount to sell
+     * @type {string}
+     * @memberof TradesCreateTradeRequest
+     */
+    'amount_sell': string;
+    /**
+     * ID of the asset to buy
+     * @type {string}
+     * @memberof TradesCreateTradeRequest
+     */
+    'asset_id_buy': string;
+    /**
+     * ID of the asset to sell
+     * @type {string}
+     * @memberof TradesCreateTradeRequest
+     */
+    'asset_id_sell': string;
+    /**
+     * Expiration timestamp for this trade
+     * @type {number}
+     * @memberof TradesCreateTradeRequest
+     */
+    'expiration_timestamp': number;
+    /**
+     *
+     * @type {TradesCreateTradeRequestFeeInfo}
+     * @memberof TradesCreateTradeRequest
+     */
+    'fee_info'?: TradesCreateTradeRequestFeeInfo;
+    /**
+     * Fee information
+     * @type {Array<FeeEntry>}
+     * @memberof TradesCreateTradeRequest
+     */
+    'fees'?: Array<FeeEntry>;
+    /**
+     * [deprecated] All orders include fees since the introduction of protocol fees
+     * @type {boolean}
+     * @memberof TradesCreateTradeRequest
+     */
+    'include_fees'?: boolean;
+    /**
+     * Nonce of the trade
+     * @type {number}
+     * @memberof TradesCreateTradeRequest
+     */
+    'nonce': number;
+    /**
+     * ID of the order
+     * @type {number}
+     * @memberof TradesCreateTradeRequest
+     */
+    'order_id': number;
+    /**
+     * Public stark key of the user creating trade
+     * @type {string}
+     * @memberof TradesCreateTradeRequest
+     */
+    'stark_key': string;
+    /**
+     * Payload signature
+     * @type {string}
+     * @memberof TradesCreateTradeRequest
+     */
+    'stark_signature': string;
+    /**
+     * ID of the vault into which the traded asset will be placed
+     * @type {number}
+     * @memberof TradesCreateTradeRequest
+     */
+    'vault_id_buy': number;
+    /**
+     * ID of the vault to sell from
+     * @type {number}
+     * @memberof TradesCreateTradeRequest
+     */
+    'vault_id_sell': number;
+}

package/dist/types/imx/models/transfer-request.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 TransferRequest
+ */
+export interface TransferRequest {
+    /**
+     * Amount to transfer
+     * @type {string}
+     * @memberof TransferRequest
+     */
+    'amount': string;
+    /**
+     * ID of the asset to transfer
+     * @type {string}
+     * @memberof TransferRequest
+     */
+    'asset_id': string;
+    /**
+     * Expiration timestamp for this transfer
+     * @type {number}
+     * @memberof TransferRequest
+     */
+    'expiration_timestamp': number;
+    /**
+     * Nonce of the transfer
+     * @type {number}
+     * @memberof TransferRequest
+     */
+    'nonce': number;
+    /**
+     * Public stark key of the user receiving the transfer
+     * @type {string}
+     * @memberof TransferRequest
+     */
+    'receiver_stark_key': string;
+    /**
+     * ID of the vault into which the asset will be transferred to
+     * @type {number}
+     * @memberof TransferRequest
+     */
+    'receiver_vault_id': number;
+    /**
+     * ID of the vault into which the asset is from
+     * @type {number}
+     * @memberof TransferRequest
+     */
+    'sender_vault_id': number;
+    /**
+     * Transfer payload signature
+     * @type {string}
+     * @memberof TransferRequest
+     */
+    'stark_signature': string;
+}

package/dist/types/imx/models/transfer-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 { Token } from './token';
+/**
+ * @type TransferToken
+ * Token transferred by the user
+ * @export
+ */
+export type TransferToken = Token;

package/dist/types/imx/models/transfer.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 { TransferToken } from './transfer-token';
+/**
+ *
+ * @export
+ * @interface Transfer
+ */
+export 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;
+}

package/dist/types/imx/models/update-collection-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 UpdateCollectionRequest
+ */
+export interface UpdateCollectionRequest {
+    /**
+     * URL of the tile image for this collection
+     * @type {string}
+     * @memberof UpdateCollectionRequest
+     */
+    'collection_image_url'?: string;
+    /**
+     * Description of the collection
+     * @type {string}
+     * @memberof UpdateCollectionRequest
+     */
+    'description'?: string;
+    /**
+     * URL of the icon for this collection
+     * @type {string}
+     * @memberof UpdateCollectionRequest
+     */
+    'icon_url'?: string;
+    /**
+     * URL of the metadata for this collection
+     * @type {string}
+     * @memberof UpdateCollectionRequest
+     */
+    'metadata_api_url'?: string;
+    /**
+     * Name of the collection
+     * @type {string}
+     * @memberof UpdateCollectionRequest
+     */
+    'name'?: string;
+}

package/dist/types/imx/models/widget-params.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 WidgetParams
+ */
+export interface WidgetParams {
+    /**
+     * Amount that will be prefilled in the widget
+     * @type {string}
+     * @memberof WidgetParams
+     */
+    'amount'?: string;
+    /**
+     * Currencies that will be available in the widget. If not defined all available currencies will be shown
+     * @type {Array<string>}
+     * @memberof WidgetParams
+     */
+    'supported_currencies'?: Array<string>;
+    /**
+     * Widget theme dark by default
+     * @type {string}
+     * @memberof WidgetParams
+     */
+    'theme'?: string;
+}

package/dist/types/imx/models/withdrawal-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 { Token } from './token';
+/**
+ * @type WithdrawalToken
+ * Details of the asset this user is withdrawing
+ * @export
+ */
+export type WithdrawalToken = Token;

package/dist/types/imx/models/withdrawal.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 { WithdrawalToken } from './withdrawal-token';
+/**
+ *
+ * @export
+ * @interface Withdrawal
+ */
+export interface Withdrawal {
+    /**
+     * Status of the on-chain batch confirmation for this withdrawal
+     * @type {string}
+     * @memberof Withdrawal
+     */
+    'rollup_status': string;
+    /**
+     * Ethereum address of the user who requested this withdrawal
+     * @type {string}
+     * @memberof Withdrawal
+     */
+    'sender': string;
+    /**
+     * Status of this withdrawal
+     * @type {string}
+     * @memberof Withdrawal
+     */
+    'status': string;
+    /**
+     * Time when this withdrawal was initiated
+     * @type {string}
+     * @memberof Withdrawal
+     */
+    'timestamp': string;
+    /**
+     *
+     * @type {WithdrawalToken}
+     * @memberof Withdrawal
+     */
+    'token': WithdrawalToken;
+    /**
+     * Sequential ID of this transaction
+     * @type {number}
+     * @memberof Withdrawal
+     */
+    'transaction_id': number;
+    /**
+     * Withdrawal has been transferred to user\'s Layer 1 wallet
+     * @type {boolean}
+     * @memberof Withdrawal
+     */
+    'withdrawn_to_wallet': boolean;
+}

package/dist/types/imx-api-clents.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/imx-api-clients.d.ts

@@ -0,0 +1,23 @@
+import { DepositsApi, MintsApi, OrdersApi, TokensApi, TradesApi, TransfersApi, UsersApi, WithdrawalsApi, BalancesApi, AssetsApi, CollectionsApi, MetadataApi, ProjectsApi, MetadataRefreshesApi, ExchangesApi, NftCheckoutPrimaryApi, EncodingApi } from './imx';
+import { ImmutableAPIConfiguration } from './config';
+export declare class ImxApiClients {
+    config: ImmutableAPIConfiguration;
+    assetApi: AssetsApi;
+    balanceApi: BalancesApi;
+    collectionApi: CollectionsApi;
+    depositsApi: DepositsApi;
+    encodingApi: EncodingApi;
+    exchangeApi: ExchangesApi;
+    metadataApi: MetadataApi;
+    metadataRefreshesApi: MetadataRefreshesApi;
+    mintsApi: MintsApi;
+    nftCheckoutPrimaryApi: NftCheckoutPrimaryApi;
+    ordersApi: OrdersApi;
+    projectsApi: ProjectsApi;
+    tokensApi: TokensApi;
+    tradesApi: TradesApi;
+    transfersApi: TransfersApi;
+    usersApi: UsersApi;
+    withdrawalsApi: WithdrawalsApi;
+    constructor(config: ImmutableAPIConfiguration);
+}

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+export * as imx from './imx';
+export * as mr from './multi-rollup';
+export * as BlockchainData from './blockchain-data/index';
+export { ImxApiClients } from './imx-api-clients';
+export { MultiRollupApiClients } from './mr-api-clients';
+export { imxApiConfig, multiRollupConfig, createConfig, } from './config';
+export type { ImmutableAPIConfiguration, MultiRollupAPIConfiguration } from './config';

package/dist/types/mr-api-clents.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/mr-api-clients.d.ts

@@ -0,0 +1,15 @@
+import { ActivitiesApi, ChainsApi, CollectionsApi, NftOwnersApi, NftsApi, OrdersApi, PassportApi, PassportProfileApi, GuardianApi } from './multi-rollup';
+import { MultiRollupAPIConfiguration } from './config';
+export declare class MultiRollupApiClients {
+    config: MultiRollupAPIConfiguration;
+    activitiesApi: ActivitiesApi;
+    chainsApi: ChainsApi;
+    collectionApi: CollectionsApi;
+    nftOwnersApi: NftOwnersApi;
+    nftsApi: NftsApi;
+    ordersApi: OrdersApi;
+    passportApi: PassportApi;
+    passportProfileApi: PassportProfileApi;
+    guardianApi: GuardianApi;
+    constructor(config: MultiRollupAPIConfiguration);
+}

package/dist/types/multi-rollup/api.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.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 * from './domain/activities-api';
+export * from './domain/chains-api';
+export * from './domain/collections-api';
+export * from './domain/crafting-api';
+export * from './domain/guardian-api';
+export * from './domain/metadata-api';
+export * from './domain/metadata-search-api';
+export * from './domain/nft-owners-api';
+export * from './domain/nfts-api';
+export * from './domain/orders-api';
+export * from './domain/passport-api';
+export * from './domain/passport-profile-api';
+export * from './domain/pricing-api';
+export * from './domain/tokens-api';