@imtbl/generated-clients 2.0.0-alpha.0

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

@@ -0,0 +1,111 @@
+/**
+ * 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 { MarketplaceContractType } from './marketplace-contract-type';
+import { NFTMetadataAttribute } from './nftmetadata-attribute';
+/**
+ * Stack
+ * @export
+ * @interface NFTWithStack
+ */
+export interface NFTWithStack {
+    /**
+     * Token id of NFT (uint256 as string)
+     * @type {string}
+     * @memberof NFTWithStack
+     */
+    'token_id': string;
+    /**
+     * Stack ID
+     * @type {string}
+     * @memberof NFTWithStack
+     */
+    'stack_id': string;
+    /**
+     *
+     * @type {Chain}
+     * @memberof NFTWithStack
+     */
+    'chain': Chain;
+    /**
+     * Contract address
+     * @type {string}
+     * @memberof NFTWithStack
+     */
+    'contract_address': string;
+    /**
+     *
+     * @type {MarketplaceContractType}
+     * @memberof NFTWithStack
+     */
+    'contract_type': MarketplaceContractType;
+    /**
+     * When the metadata was created
+     * @type {string}
+     * @memberof NFTWithStack
+     */
+    'created_at': string;
+    /**
+     * When the metadata was last updated
+     * @type {string}
+     * @memberof NFTWithStack
+     */
+    'updated_at': string;
+    /**
+     * The name of the NFT
+     * @type {string}
+     * @memberof NFTWithStack
+     */
+    'name': string | null;
+    /**
+     * The description of the NFT
+     * @type {string}
+     * @memberof NFTWithStack
+     */
+    'description': string | null;
+    /**
+     * The image url of the NFT
+     * @type {string}
+     * @memberof NFTWithStack
+     */
+    'image': string | null;
+    /**
+     * The external website link of NFT
+     * @type {string}
+     * @memberof NFTWithStack
+     */
+    'external_url': string | null;
+    /**
+     * The animation url of the NFT
+     * @type {string}
+     * @memberof NFTWithStack
+     */
+    'animation_url': string | null;
+    /**
+     * The youtube URL of NFT
+     * @type {string}
+     * @memberof NFTWithStack
+     */
+    'youtube_url': string | null;
+    /**
+     * List of Metadata attributes
+     * @type {Array<NFTMetadataAttribute>}
+     * @memberof NFTWithStack
+     */
+    'attributes': Array<NFTMetadataAttribute> | null;
+    /**
+     * Balance of NFT
+     * @type {number}
+     * @memberof NFTWithStack
+     */
+    'balance': number | null;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * 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.
+ */
+/**
+ * Pagination properties
+ * @export
+ * @interface Page
+ */
+export interface Page {
+    /**
+     * First item as an encoded string
+     * @type {string}
+     * @memberof Page
+     */
+    'previous_cursor': string | null;
+    /**
+     * Last item as an encoded string
+     * @type {string}
+     * @memberof Page
+     */
+    'next_cursor': string | null;
+}

package/dist/types/blockchain-data/models/quotes-for-nfts-result.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { NFTQuoteResult } from './nftquote-result';
+import { Page } from './page';
+/**
+ * Quotes for NFTs result
+ * @export
+ * @interface QuotesForNFTsResult
+ */
+export interface QuotesForNFTsResult {
+    /**
+     * List of quotes
+     * @type {Array<NFTQuoteResult>}
+     * @memberof QuotesForNFTsResult
+     */
+    'result': Array<NFTQuoteResult>;
+    /**
+     *
+     * @type {Page}
+     * @memberof QuotesForNFTsResult
+     */
+    'page': Page;
+}

package/dist/types/blockchain-data/models/quotes-for-stacks-result.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { Page } from './page';
+import { StackQuoteResult } from './stack-quote-result';
+/**
+ * Quotes for stacks result
+ * @export
+ * @interface QuotesForStacksResult
+ */
+export interface QuotesForStacksResult {
+    /**
+     * List of quotes
+     * @type {Array<StackQuoteResult>}
+     * @memberof QuotesForStacksResult
+     */
+    'result': Array<StackQuoteResult>;
+    /**
+     *
+     * @type {Page}
+     * @memberof QuotesForStacksResult
+     */
+    'page': Page;
+}

package/dist/types/blockchain-data/models/refresh-collection-metadata-request.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 { CollectionMetadata } from './collection-metadata';
+/**
+ *
+ * @export
+ * @interface RefreshCollectionMetadataRequest
+ */
+export interface RefreshCollectionMetadataRequest {
+    /**
+     *
+     * @type {CollectionMetadata}
+     * @memberof RefreshCollectionMetadataRequest
+     */
+    'collection_metadata': CollectionMetadata;
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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 { CollectionMetadata } from './collection-metadata';
+/**
+ *
+ * @export
+ * @interface RefreshCollectionMetadataResult
+ */
+export interface RefreshCollectionMetadataResult {
+    /**
+     *
+     * @type {string}
+     * @memberof RefreshCollectionMetadataResult
+     */
+    'contract_address': string;
+    /**
+     *
+     * @type {Chain}
+     * @memberof RefreshCollectionMetadataResult
+     */
+    'chain': Chain;
+    /**
+     *
+     * @type {CollectionMetadata}
+     * @memberof RefreshCollectionMetadataResult
+     */
+    'collection_metadata': CollectionMetadata;
+}

package/dist/types/blockchain-data/models/refresh-metadata-by-id.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 { RefreshMetadataByIDAllOf } from './refresh-metadata-by-idall-of';
+import { RefreshableNFTAttributes } from './refreshable-nftattributes';
+/**
+ * @type RefreshMetadataByID
+ * @export
+ */
+export type RefreshMetadataByID = RefreshMetadataByIDAllOf & RefreshableNFTAttributes;

package/dist/types/blockchain-data/models/refresh-metadata-by-idall-of.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.
+ */
+/**
+ *
+ * @export
+ * @interface RefreshMetadataByIDAllOf
+ */
+export interface RefreshMetadataByIDAllOf {
+    /**
+     * Metadata id in UUIDv4 format
+     * @type {string}
+     * @memberof RefreshMetadataByIDAllOf
+     */
+    'metadata_id': string;
+}

package/dist/types/blockchain-data/models/refresh-metadata-by-idrequest.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 { RefreshMetadataByID } from './refresh-metadata-by-id';
+/**
+ * Request body for refreshing metadata by id. Total size of this list should not exceed 228 KiB
+ * @export
+ * @interface RefreshMetadataByIDRequest
+ */
+export interface RefreshMetadataByIDRequest {
+    /**
+     *
+     * @type {Array<RefreshMetadataByID>}
+     * @memberof RefreshMetadataByIDRequest
+     */
+    'metadata': Array<RefreshMetadataByID>;
+}

package/dist/types/blockchain-data/models/refresh-metadata-by-token-id.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 { RefreshMetadataByTokenIDAllOf } from './refresh-metadata-by-token-idall-of';
+import { RefreshableNFTAttributes } from './refreshable-nftattributes';
+/**
+ * @type RefreshMetadataByTokenID
+ * @export
+ */
+export type RefreshMetadataByTokenID = RefreshMetadataByTokenIDAllOf & RefreshableNFTAttributes;

package/dist/types/blockchain-data/models/refresh-metadata-by-token-idall-of.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.
+ */
+/**
+ *
+ * @export
+ * @interface RefreshMetadataByTokenIDAllOf
+ */
+export interface RefreshMetadataByTokenIDAllOf {
+    /**
+     * An `uint256` token id as string
+     * @type {string}
+     * @memberof RefreshMetadataByTokenIDAllOf
+     */
+    'token_id': string;
+}

package/dist/types/blockchain-data/models/refresh-nftmetadata-by-token-idrequest.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 { RefreshMetadataByTokenID } from './refresh-metadata-by-token-id';
+/**
+ *
+ * @export
+ * @interface RefreshNFTMetadataByTokenIDRequest
+ */
+export interface RefreshNFTMetadataByTokenIDRequest {
+    /**
+     * List of nft metadata to be refreshed. Total size of the list should not exceed 228 KiB
+     * @type {Array<RefreshMetadataByTokenID>}
+     * @memberof RefreshNFTMetadataByTokenIDRequest
+     */
+    'nft_metadata': Array<RefreshMetadataByTokenID>;
+}

package/dist/types/blockchain-data/models/refreshable-nftattributes.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.
+ */
+import { NFTMetadataRequest } from './nftmetadata-request';
+/**
+ * @type RefreshableNFTAttributes
+ * @export
+ */
+export type RefreshableNFTAttributes = NFTMetadataRequest;

package/dist/types/blockchain-data/models/sale-fee.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 SaleFee
+ */
+export interface SaleFee {
+    /**
+     * Fee payable to recipient upon settlement
+     * @type {string}
+     * @memberof SaleFee
+     */
+    'amount'?: string;
+    /**
+     * Fee type
+     * @type {string}
+     * @memberof SaleFee
+     */
+    'type'?: SaleFeeTypeEnum;
+    /**
+     * Wallet address of fee recipient
+     * @type {string}
+     * @memberof SaleFee
+     */
+    'recipient'?: string;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum SaleFeeTypeEnum {
+    Royalty = "ROYALTY"
+}

package/dist/types/blockchain-data/models/sale-payment-token.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 { ActivityNativeToken } from './activity-native-token';
+import { ActivityToken } from './activity-token';
+/**
+ * @type SalePaymentToken
+ * The type of payment token
+ * @export
+ */
+export type SalePaymentToken = ActivityNativeToken | ActivityToken;

package/dist/types/blockchain-data/models/sale-payment.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { SaleFee } from './sale-fee';
+import { SalePaymentToken } from './sale-payment-token';
+/**
+ *
+ * @export
+ * @interface SalePayment
+ */
+export interface SalePayment {
+    /**
+     *
+     * @type {SalePaymentToken}
+     * @memberof SalePayment
+     */
+    'token': SalePaymentToken;
+    /**
+     * The base price of the sale not including any fees
+     * @type {string}
+     * @memberof SalePayment
+     */
+    'price_excluding_fees': string;
+    /**
+     * The total price of the sale. Includes the sum of all fees
+     * @type {string}
+     * @memberof SalePayment
+     */
+    'price_including_fees': string;
+    /**
+     * The fees associated with this sale
+     * @type {Array<SaleFee>}
+     * @memberof SalePayment
+     */
+    'fees': Array<SaleFee>;
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 { NFTBundle } from './nftbundle';
+import { Page } from './page';
+/**
+ * Search NFTs result
+ * @export
+ * @interface SearchNFTsResult
+ */
+export interface SearchNFTsResult {
+    /**
+     * List of nft bundles
+     * @type {Array<NFTBundle>}
+     * @memberof SearchNFTsResult
+     */
+    'result': Array<NFTBundle>;
+    /**
+     *
+     * @type {Page}
+     * @memberof SearchNFTsResult
+     */
+    'page': Page;
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 { Page } from './page';
+import { StackBundle } from './stack-bundle';
+/**
+ * Search stacks result
+ * @export
+ * @interface SearchStacksResult
+ */
+export interface SearchStacksResult {
+    /**
+     * List of stack bundles
+     * @type {Array<StackBundle>}
+     * @memberof SearchStacksResult
+     */
+    'result': Array<StackBundle>;
+    /**
+     *
+     * @type {Page}
+     * @memberof SearchStacksResult
+     */
+    'page': Page;
+}

package/dist/types/blockchain-data/models/sign-crafting-request-multi-caller.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 SignCraftingRequestMultiCaller
+ */
+export interface SignCraftingRequestMultiCaller {
+    /**
+     * An Ethereum address
+     * @type {string}
+     * @memberof SignCraftingRequestMultiCaller
+     */
+    'address': string;
+    /**
+     * The name of the multicaller contract
+     * @type {string}
+     * @memberof SignCraftingRequestMultiCaller
+     */
+    'name': string;
+    /**
+     * The version of the multicaller contract
+     * @type {string}
+     * @memberof SignCraftingRequestMultiCaller
+     */
+    'version': string;
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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 { Call } from './call';
+import { SignCraftingRequestMultiCaller } from './sign-crafting-request-multi-caller';
+/**
+ *
+ * @export
+ * @interface SignCraftingRequest
+ */
+export interface SignCraftingRequest {
+    /**
+     *
+     * @type {SignCraftingRequestMultiCaller}
+     * @memberof SignCraftingRequest
+     */
+    'multi_caller': SignCraftingRequestMultiCaller;
+    /**
+     * The id of this request in the system that originates the crafting request, specified as a 32 byte hex string
+     * @type {string}
+     * @memberof SignCraftingRequest
+     */
+    'reference_id': string;
+    /**
+     * The calls to be signed
+     * @type {Array<Call>}
+     * @memberof SignCraftingRequest
+     */
+    'calls': Array<Call>;
+    /**
+     * The expiration time of the request
+     * @type {string}
+     * @memberof SignCraftingRequest
+     */
+    'expires_at': string;
+}