@imtbl/generated-clients 2.0.0-alpha.0

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

@@ -0,0 +1,124 @@
+/**
+ * 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 { NFTContractType } from './nftcontract-type';
+import { NFTMetadataAttribute } from './nftmetadata-attribute';
+/**
+ *
+ * @export
+ * @interface NFT
+ */
+export interface NFT {
+    /**
+     *
+     * @type {Chain}
+     * @memberof NFT
+     */
+    'chain': Chain;
+    /**
+     * An `uint256` token id as string
+     * @type {string}
+     * @memberof NFT
+     */
+    'token_id': string;
+    /**
+     * The contract address of the NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'contract_address': string;
+    /**
+     *
+     * @type {NFTContractType}
+     * @memberof NFT
+     */
+    'contract_type': NFTContractType;
+    /**
+     * When the NFT was first indexed
+     * @type {string}
+     * @memberof NFT
+     */
+    'indexed_at': string;
+    /**
+     * When the NFT owner was last updated
+     * @type {string}
+     * @memberof NFT
+     */
+    'updated_at': string;
+    /**
+     * When NFT metadata was last synced
+     * @type {string}
+     * @memberof NFT
+     */
+    'metadata_synced_at': string | null;
+    /**
+     * The id of the metadata of this NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'metadata_id'?: string | null;
+    /**
+     * The name of the NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'name': string | null;
+    /**
+     * The description of the NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'description': string | null;
+    /**
+     * The image url of the NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'image': string | null;
+    /**
+     * (deprecated - use external_url instead) The external website link of NFT
+     * @type {string}
+     * @memberof NFT
+     * @deprecated
+     */
+    'external_link': string | null;
+    /**
+     * The external website link of NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'external_url': string | null;
+    /**
+     * The animation url of the NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'animation_url': string | null;
+    /**
+     * The youtube URL of NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'youtube_url': string | null;
+    /**
+     * List of NFT Metadata attributes
+     * @type {Array<NFTMetadataAttribute>}
+     * @memberof NFT
+     */
+    'attributes': Array<NFTMetadataAttribute>;
+    /**
+     * The total supply of NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'total_supply'?: string | null;
+}

package/dist/types/blockchain-data/models/nftbundle.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.
+ */
+import { Bid } from './bid';
+import { Listing } from './listing';
+import { Market } from './market';
+import { NFTWithStack } from './nftwith-stack';
+/**
+ * NFT bundle includes NFT with stack, markets and listings
+ * @export
+ * @interface NFTBundle
+ */
+export interface NFTBundle {
+    /**
+     *
+     * @type {NFTWithStack}
+     * @memberof NFTBundle
+     */
+    'nft_with_stack': NFTWithStack;
+    /**
+     *
+     * @type {Market}
+     * @memberof NFTBundle
+     */
+    'market': Market | null;
+    /**
+     * List of open listings for the NFT.
+     * @type {Array<Listing>}
+     * @memberof NFTBundle
+     */
+    'listings': Array<Listing>;
+    /**
+     * List of open bids for the NFT.
+     * @type {Array<Bid>}
+     * @memberof NFTBundle
+     */
+    'bids': Array<Bid>;
+}

package/dist/types/blockchain-data/models/nftcontract-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 an NFT
+ * @export
+ * @enum {string}
+ */
+export declare enum NFTContractType {
+    Erc721 = "ERC721",
+    Erc1155 = "ERC1155"
+}

package/dist/types/blockchain-data/models/nftmetadata-attribute-value.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+/**
+ * @type NFTMetadataAttributeValue
+ * The metadata trait value
+ * @export
+ */
+export type NFTMetadataAttributeValue = boolean | number | string;

package/dist/types/blockchain-data/models/nftmetadata-attribute.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 { NFTMetadataAttributeValue } from './nftmetadata-attribute-value';
+/**
+ *
+ * @export
+ * @interface NFTMetadataAttribute
+ */
+export interface NFTMetadataAttribute {
+    /**
+     * Display type for this attribute
+     * @type {string}
+     * @memberof NFTMetadataAttribute
+     */
+    'display_type'?: NFTMetadataAttributeDisplayTypeEnum;
+    /**
+     * The metadata trait type
+     * @type {string}
+     * @memberof NFTMetadataAttribute
+     */
+    'trait_type': string;
+    /**
+     *
+     * @type {NFTMetadataAttributeValue}
+     * @memberof NFTMetadataAttribute
+     */
+    'value': NFTMetadataAttributeValue;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum NFTMetadataAttributeDisplayTypeEnum {
+    Number = "number",
+    BoostPercentage = "boost_percentage",
+    BoostNumber = "boost_number",
+    Date = "date"
+}

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

@@ -0,0 +1,61 @@
+/**
+ * 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 { NFTMetadataAttribute } from './nftmetadata-attribute';
+/**
+ * The NFT metadata. Total size of this object should not exceed 16 KiB
+ * @export
+ * @interface NFTMetadataRequest
+ */
+export interface NFTMetadataRequest {
+    /**
+     * The name of the NFT
+     * @type {string}
+     * @memberof NFTMetadataRequest
+     */
+    'name'?: string | null;
+    /**
+     * The description of the NFT
+     * @type {string}
+     * @memberof NFTMetadataRequest
+     */
+    'description'?: string | null;
+    /**
+     * The image url of the NFT
+     * @type {string}
+     * @memberof NFTMetadataRequest
+     */
+    'image'?: string | null;
+    /**
+     * The external link of the NFT
+     * @type {string}
+     * @memberof NFTMetadataRequest
+     */
+    'external_url'?: string | null;
+    /**
+     * The animation url of the NFT
+     * @type {string}
+     * @memberof NFTMetadataRequest
+     */
+    'animation_url'?: string | null;
+    /**
+     * The youtube link of the NFT
+     * @type {string}
+     * @memberof NFTMetadataRequest
+     */
+    'youtube_url'?: string | null;
+    /**
+     * List of Metadata attributes
+     * @type {Array<NFTMetadataAttribute>}
+     * @memberof NFTMetadataRequest
+     */
+    'attributes'?: Array<NFTMetadataAttribute> | null;
+}

package/dist/types/blockchain-data/models/nftowner.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 { Chain } from './chain';
+/**
+ *
+ * @export
+ * @interface NFTOwner
+ */
+export interface NFTOwner {
+    /**
+     *
+     * @type {Chain}
+     * @memberof NFTOwner
+     */
+    'chain': Chain;
+    /**
+     * The address of NFT contract
+     * @type {string}
+     * @memberof NFTOwner
+     */
+    'contract_address': string;
+    /**
+     * An `uint256` token id as string
+     * @type {string}
+     * @memberof NFTOwner
+     */
+    'token_id': string;
+    /**
+     * The account address of the owner of the NFT
+     * @type {string}
+     * @memberof NFTOwner
+     */
+    'account_address': string;
+    /**
+     * The amount of owned tokens (uint256 as string)
+     * @type {string}
+     * @memberof NFTOwner
+     */
+    'balance': string;
+    /**
+     * When the NFT owner was last updated
+     * @type {string}
+     * @memberof NFTOwner
+     */
+    'updated_at'?: string;
+}

package/dist/types/blockchain-data/models/nftquote-result.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { Market } from './market';
+import { MarketNft } from './market-nft';
+/**
+ * NFT quote result
+ * @export
+ * @interface NFTQuoteResult
+ */
+export interface NFTQuoteResult {
+    /**
+     *
+     * @type {Chain}
+     * @memberof NFTQuoteResult
+     */
+    'chain': Chain;
+    /**
+     * Token id of NFT (uint256 as string)
+     * @type {string}
+     * @memberof NFTQuoteResult
+     */
+    'token_id': string;
+    /**
+     *
+     * @type {Market}
+     * @memberof NFTQuoteResult
+     */
+    'market_stack': Market;
+    /**
+     *
+     * @type {MarketNft}
+     * @memberof NFTQuoteResult
+     */
+    'market_nft': MarketNft;
+    /**
+     *
+     * @type {Market}
+     * @memberof NFTQuoteResult
+     */
+    'market_collection': Market;
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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 { ActivityNFT } from './activity-nft';
+import { SalePayment } from './sale-payment';
+/**
+ * The NFT Sale activity details
+ * @export
+ * @interface NFTSale
+ */
+export interface NFTSale {
+    /**
+     * The id of order
+     * @type {string}
+     * @memberof NFTSale
+     */
+    'order_id': string;
+    /**
+     * The account address of buyer
+     * @type {string}
+     * @memberof NFTSale
+     */
+    'to': string;
+    /**
+     * The account address of seller
+     * @type {string}
+     * @memberof NFTSale
+     */
+    'from': string;
+    /**
+     *
+     * @type {Array<ActivityNFT>}
+     * @memberof NFTSale
+     */
+    'asset': Array<ActivityNFT>;
+    /**
+     *
+     * @type {SalePayment}
+     * @memberof NFTSale
+     */
+    'payment': SalePayment;
+}

package/dist/types/blockchain-data/models/nftwith-balance.d.ts

@@ -0,0 +1,117 @@
+/**
+ * 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 { NFTContractType } from './nftcontract-type';
+import { NFTMetadataAttribute } from './nftmetadata-attribute';
+/**
+ *
+ * @export
+ * @interface NFTWithBalance
+ */
+export interface NFTWithBalance {
+    /**
+     *
+     * @type {Chain}
+     * @memberof NFTWithBalance
+     */
+    'chain': Chain;
+    /**
+     * An `uint256` token id as string
+     * @type {string}
+     * @memberof NFTWithBalance
+     */
+    'token_id': string;
+    /**
+     * The contract address of the NFT
+     * @type {string}
+     * @memberof NFTWithBalance
+     */
+    'contract_address': string;
+    /**
+     *
+     * @type {NFTContractType}
+     * @memberof NFTWithBalance
+     */
+    'contract_type': NFTContractType;
+    /**
+     * When the NFT was first indexed
+     * @type {string}
+     * @memberof NFTWithBalance
+     */
+    'indexed_at': string;
+    /**
+     * When the NFT owner was last updated
+     * @type {string}
+     * @memberof NFTWithBalance
+     */
+    'updated_at': string;
+    /**
+     * When NFT metadata was last synced
+     * @type {string}
+     * @memberof NFTWithBalance
+     */
+    'metadata_synced_at': string | null;
+    /**
+     * The id of the metadata of this NFT
+     * @type {string}
+     * @memberof NFTWithBalance
+     */
+    'metadata_id'?: string | null;
+    /**
+     * The name of the NFT
+     * @type {string}
+     * @memberof NFTWithBalance
+     */
+    'name': string | null;
+    /**
+     * The description of the NFT
+     * @type {string}
+     * @memberof NFTWithBalance
+     */
+    'description': string | null;
+    /**
+     * The image url of the NFT
+     * @type {string}
+     * @memberof NFTWithBalance
+     */
+    'image': string | null;
+    /**
+     * The external website link of NFT
+     * @type {string}
+     * @memberof NFTWithBalance
+     */
+    'external_link': string | null;
+    /**
+     * The animation url of the NFT
+     * @type {string}
+     * @memberof NFTWithBalance
+     */
+    'animation_url': string | null;
+    /**
+     * The youtube URL of NFT
+     * @type {string}
+     * @memberof NFTWithBalance
+     */
+    'youtube_url': string | null;
+    /**
+     * List of Metadata attributes
+     * @type {Array<NFTMetadataAttribute>}
+     * @memberof NFTWithBalance
+     */
+    'attributes': Array<NFTMetadataAttribute>;
+    /**
+     * The amount of this NFT this account owns
+     * @type {string}
+     * @memberof NFTWithBalance
+     */
+    'balance': string;
+}

package/dist/types/blockchain-data/models/nftwith-owner.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 { Chain } from './chain';
+/**
+ *
+ * @export
+ * @interface NFTWithOwner
+ */
+export interface NFTWithOwner {
+    /**
+     *
+     * @type {Chain}
+     * @memberof NFTWithOwner
+     */
+    'chain': Chain;
+    /**
+     * The address of NFT contract
+     * @type {string}
+     * @memberof NFTWithOwner
+     */
+    'contract_address': string;
+    /**
+     * An `uint256` token id as string
+     * @type {string}
+     * @memberof NFTWithOwner
+     */
+    'token_id': string;
+    /**
+     * The account address of the owner of the NFT
+     * @type {string}
+     * @memberof NFTWithOwner
+     */
+    'account_address': string;
+    /**
+     * The amount of owned tokens (uint256 as string)
+     * @type {string}
+     * @memberof NFTWithOwner
+     */
+    'balance': string;
+    /**
+     * When the owner last changed for the given NFT
+     * @type {string}
+     * @memberof NFTWithOwner
+     */
+    'updated_at': string;
+}