@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/blockchain-data/models/listing.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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.
+ */
+import { MarketPriceDetails } from './market-price-details';
+/**
+ *
+ * @export
+ * @interface Listing
+ */
+export interface Listing {
+    /**
+     * Global Order identifier
+     * @type {string}
+     * @memberof Listing
+     */
+    'listing_id': string;
+    /**
+     *
+     * @type {MarketPriceDetails}
+     * @memberof Listing
+     */
+    'price_details': MarketPriceDetails;
+    /**
+     * Token ID
+     * @type {string}
+     * @memberof Listing
+     */
+    'token_id': string;
+    /**
+     * ETH Address of collection that the asset belongs to
+     * @type {string}
+     * @memberof Listing
+     */
+    'contract_address': string;
+    /**
+     * ETH Address of listing creator
+     * @type {string}
+     * @memberof Listing
+     */
+    'creator': string;
+    /**
+     * Amount of token included in the listing
+     * @type {string}
+     * @memberof Listing
+     */
+    'amount': string;
+}

package/dist/types/blockchain-data/models/market-floor-listing.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+import { Listing } from './listing';
+/**
+ * @type MarketFloorListing
+ * Cheapest active listing
+ * @export
+ */
+export type MarketFloorListing = Listing;

package/dist/types/blockchain-data/models/market-nft.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.
+ */
+import { LastTrade } from './last-trade';
+/**
+ * NFT market data
+ * @export
+ * @interface MarketNft
+ */
+export interface MarketNft {
+    /**
+     *
+     * @type {LastTrade}
+     * @memberof MarketNft
+     */
+    'last_trade': LastTrade | null;
+}

package/dist/types/blockchain-data/models/market-price-details-token.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ */
+import { MarketPriceERC20Token } from './market-price-erc20-token';
+import { MarketPriceNativeToken } from './market-price-native-token';
+/**
+ * @type MarketPriceDetailsToken
+ * Token details
+ * @export
+ */
+export type MarketPriceDetailsToken = {
+    type: 'ERC20';
+} & MarketPriceERC20Token | {
+    type: 'NATIVE';
+} & MarketPriceNativeToken;

package/dist/types/blockchain-data/models/market-price-details.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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.
+ */
+import { MarketPriceDetailsToken } from './market-price-details-token';
+import { MarketPriceFees } from './market-price-fees';
+/**
+ * Market Price details
+ * @export
+ * @interface MarketPriceDetails
+ */
+export interface MarketPriceDetails {
+    /**
+     *
+     * @type {MarketPriceDetailsToken}
+     * @memberof MarketPriceDetails
+     */
+    'token': MarketPriceDetailsToken;
+    /**
+     * The token amount value. This value is provided in the smallest unit of the token (e.g. wei for ETH)
+     * @type {string}
+     * @memberof MarketPriceDetails
+     */
+    'amount': string;
+    /**
+     * The token amount value. This value is provided in the smallest unit of the token (e.g. wei for ETH)
+     * @type {string}
+     * @memberof MarketPriceDetails
+     */
+    'fee_inclusive_amount': string;
+    /**
+     *
+     * @type {Array<MarketPriceFees>}
+     * @memberof MarketPriceDetails
+     */
+    'fees': Array<MarketPriceFees>;
+    /**
+     * A mapping of converted prices for major currencies such as ETH, USD. All converted prices are fee-inclusive.
+     * @type {{ [key: string]: string; }}
+     * @memberof MarketPriceDetails
+     */
+    'converted_prices': {
+        [key: string]: string;
+    } | null;
+}

package/dist/types/blockchain-data/models/market-price-erc20-token.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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
+ * @interface MarketPriceERC20Token
+ */
+export interface MarketPriceERC20Token {
+    /**
+     * Token type user is offering, which in this case is ERC20
+     * @type {string}
+     * @memberof MarketPriceERC20Token
+     */
+    'type': MarketPriceERC20TokenTypeEnum;
+    /**
+     * Address of ERC20 token
+     * @type {string}
+     * @memberof MarketPriceERC20Token
+     */
+    'contract_address': string;
+    /**
+     * The symbol of token
+     * @type {string}
+     * @memberof MarketPriceERC20Token
+     */
+    'symbol': string | null;
+    /**
+     * The decimals of token
+     * @type {number}
+     * @memberof MarketPriceERC20Token
+     */
+    'decimals': number | null;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum MarketPriceERC20TokenTypeEnum {
+    Erc20 = "ERC20"
+}

package/dist/types/blockchain-data/models/market-price-fees.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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
+ * @interface MarketPriceFees
+ */
+export interface MarketPriceFees {
+    /**
+     * Fee in the payment currency
+     * @type {string}
+     * @memberof MarketPriceFees
+     */
+    'amount': string;
+    /**
+     * Fee type
+     * @type {string}
+     * @memberof MarketPriceFees
+     */
+    'type': MarketPriceFeesTypeEnum;
+    /**
+     * Wallet address of fee recipient
+     * @type {string}
+     * @memberof MarketPriceFees
+     */
+    'recipient_address': string;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum MarketPriceFeesTypeEnum {
+    Royalty = "ROYALTY",
+    MakerEcosystem = "MAKER_ECOSYSTEM",
+    TakerEcosystem = "TAKER_ECOSYSTEM",
+    Protocol = "PROTOCOL"
+}

package/dist/types/blockchain-data/models/market-price-native-token.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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
+ * @interface MarketPriceNativeToken
+ */
+export interface MarketPriceNativeToken {
+    /**
+     * Token type user is offering, which in this case is the native IMX token
+     * @type {string}
+     * @memberof MarketPriceNativeToken
+     */
+    'type': MarketPriceNativeTokenTypeEnum;
+    /**
+     * The symbol of token
+     * @type {string}
+     * @memberof MarketPriceNativeToken
+     */
+    'symbol': string | null;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum MarketPriceNativeTokenTypeEnum {
+    Native = "NATIVE"
+}

package/dist/types/blockchain-data/models/market-top-bid.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+import { Bid } from './bid';
+/**
+ * @type MarketTopBid
+ * Highest active big
+ * @export
+ */
+export type MarketTopBid = Bid;

package/dist/types/blockchain-data/models/market.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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.
+ */
+import { LastTrade } from './last-trade';
+import { MarketFloorListing } from './market-floor-listing';
+import { MarketTopBid } from './market-top-bid';
+/**
+ * Market data
+ * @export
+ * @interface Market
+ */
+export interface Market {
+    /**
+     *
+     * @type {MarketFloorListing}
+     * @memberof Market
+     */
+    'floor_listing': MarketFloorListing | null;
+    /**
+     *
+     * @type {MarketTopBid}
+     * @memberof Market
+     */
+    'top_bid': MarketTopBid | null;
+    /**
+     *
+     * @type {LastTrade}
+     * @memberof Market
+     */
+    'last_trade': LastTrade | null;
+}

package/dist/types/blockchain-data/models/marketplace-contract-type.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+/**
+ * The contract type for a collection
+ * @export
+ * @enum {string}
+ */
+export declare enum MarketplaceContractType {
+    Erc721 = "ERC721",
+    Erc1155 = "ERC1155"
+}

package/dist/types/blockchain-data/models/metadata-refresh-rate-limit-result.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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
+ * @interface MetadataRefreshRateLimitResult
+ */
+export interface MetadataRefreshRateLimitResult {
+    /**
+     *
+     * @type {string}
+     * @memberof MetadataRefreshRateLimitResult
+     */
+    'imx_refreshes_limit': string;
+    /**
+     *
+     * @type {string}
+     * @memberof MetadataRefreshRateLimitResult
+     */
+    'imx_refresh_limit_reset': string;
+    /**
+     *
+     * @type {string}
+     * @memberof MetadataRefreshRateLimitResult
+     */
+    'imx_remaining_refreshes': string;
+    /**
+     *
+     * @type {string}
+     * @memberof MetadataRefreshRateLimitResult
+     */
+    'retry_after': string;
+}

package/dist/types/blockchain-data/models/metadata.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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.
+ */
+import { Chain } from './chain';
+import { NFTMetadataAttribute } from './nftmetadata-attribute';
+/**
+ *
+ * @export
+ * @interface Metadata
+ */
+export interface Metadata {
+    /**
+     * Metadata id in UUIDv4 format
+     * @type {string}
+     * @memberof Metadata
+     */
+    'id': string;
+    /**
+     *
+     * @type {Chain}
+     * @memberof Metadata
+     */
+    'chain': Chain;
+    /**
+     * The contract address of the metadata
+     * @type {string}
+     * @memberof Metadata
+     */
+    'contract_address': string;
+    /**
+     * When the metadata was created
+     * @type {string}
+     * @memberof Metadata
+     */
+    'created_at': string;
+    /**
+     * When the metadata was last updated
+     * @type {string}
+     * @memberof Metadata
+     */
+    'updated_at': string | null;
+    /**
+     * The name of the NFT
+     * @type {string}
+     * @memberof Metadata
+     */
+    'name': string | null;
+    /**
+     * The description of the NFT
+     * @type {string}
+     * @memberof Metadata
+     */
+    'description': string | null;
+    /**
+     * The image url of the NFT
+     * @type {string}
+     * @memberof Metadata
+     */
+    'image': string | null;
+    /**
+     * The external website link of NFT
+     * @type {string}
+     * @memberof Metadata
+     */
+    'external_url'?: string | null;
+    /**
+     * The animation url of the NFT
+     * @type {string}
+     * @memberof Metadata
+     */
+    'animation_url': string | null;
+    /**
+     * The youtube URL of NFT
+     * @type {string}
+     * @memberof Metadata
+     */
+    'youtube_url': string | null;
+    /**
+     * List of Metadata attributes
+     * @type {Array<NFTMetadataAttribute>}
+     * @memberof Metadata
+     */
+    'attributes': Array<NFTMetadataAttribute> | null;
+}

package/dist/types/blockchain-data/models/mint-asset.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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.
+ */
+import { NFTMetadataRequest } from './nftmetadata-request';
+/**
+ *
+ * @export
+ * @interface MintAsset
+ */
+export interface MintAsset {
+    /**
+     * The id of this asset in the system that originates the mint request
+     * @type {string}
+     * @memberof MintAsset
+     */
+    'reference_id': string;
+    /**
+     * The address of the receiver
+     * @type {string}
+     * @memberof MintAsset
+     */
+    'owner_address': string;
+    /**
+     * An optional `uint256` token id as string. Required for ERC1155 collections.
+     * @type {string}
+     * @memberof MintAsset
+     */
+    'token_id'?: string | null;
+    /**
+     * Optional mount of tokens to mint. Required for ERC1155 collections. ERC712 collections can omit this field or set it to 1
+     * @type {string}
+     * @memberof MintAsset
+     */
+    'amount'?: string | null;
+    /**
+     *
+     * @type {NFTMetadataRequest}
+     * @memberof MintAsset
+     */
+    'metadata'?: NFTMetadataRequest;
+}

package/dist/types/blockchain-data/models/mint-request-error-message.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ * The error details in case the mint request fails
+ * @export
+ * @interface MintRequestErrorMessage
+ */
+export interface MintRequestErrorMessage {
+    /**
+     * An error message in case the mint request fails
+     * @type {string}
+     * @memberof MintRequestErrorMessage
+     */
+    'message'?: string;
+}

package/dist/types/blockchain-data/models/mint-request-status.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+/**
+ * The status of the mint request
+ * @export
+ * @enum {string}
+ */
+export declare enum MintRequestStatus {
+    Pending = "pending",
+    Succeeded = "succeeded",
+    Failed = "failed"
+}

package/dist/types/blockchain-data/models/mint.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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.
+ */
+import { ActivityAsset } from './activity-asset';
+/**
+ * The mint activity details
+ * @export
+ * @interface Mint
+ */
+export interface Mint {
+    /**
+     * The account address the asset was minted to
+     * @type {string}
+     * @memberof Mint
+     */
+    'to': string;
+    /**
+     * The minted amount
+     * @type {string}
+     * @memberof Mint
+     */
+    'amount': string;
+    /**
+     *
+     * @type {ActivityAsset}
+     * @memberof Mint
+     */
+    'asset': ActivityAsset;
+}