@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/multi-rollup/models/meta-transaction-data.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 MetaTransactionData
+ * @export
+ */
+export type MetaTransactionData = Array<number> | string;

package/dist/types/multi-rollup/models/meta-transaction.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 { MetaTransactionData } from './meta-transaction-data';
+/**
+ *
+ * @export
+ * @interface MetaTransaction
+ */
+export interface MetaTransaction {
+    /**
+     * Whether the transaction is a delegate call
+     * @type {boolean}
+     * @memberof MetaTransaction
+     */
+    'delegateCall': boolean;
+    /**
+     * Whether to revert on error
+     * @type {boolean}
+     * @memberof MetaTransaction
+     */
+    'revertOnError': boolean;
+    /**
+     * The gas limit for the transaction
+     * @type {string}
+     * @memberof MetaTransaction
+     */
+    'gasLimit': string;
+    /**
+     * The SM target address of the transaction
+     * @type {string}
+     * @memberof MetaTransaction
+     */
+    'target': string;
+    /**
+     * The value of the transaction
+     * @type {string}
+     * @memberof MetaTransaction
+     */
+    'value': string;
+    /**
+     *
+     * @type {MetaTransactionData}
+     * @memberof MetaTransaction
+     */
+    'data': MetaTransactionData;
+}

package/dist/types/multi-rollup/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/multi-rollup/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/multi-rollup/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/multi-rollup/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/multi-rollup/models/mint-request-status.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 const MintRequestStatus: {
+    readonly Pending: "pending";
+    readonly Succeeded: "succeeded";
+    readonly Failed: "failed";
+};
+export type MintRequestStatus = typeof MintRequestStatus[keyof typeof MintRequestStatus];

package/dist/types/multi-rollup/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;
+}

package/dist/types/multi-rollup/models/native-item.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.
+ */
+/**
+ *
+ * @export
+ * @interface NativeItem
+ */
+export interface NativeItem {
+    /**
+     * Token type user is offering, which in this case is the native IMX token
+     * @type {string}
+     * @memberof NativeItem
+     */
+    'type': NativeItemTypeEnum;
+    /**
+     * A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).
+     * @type {string}
+     * @memberof NativeItem
+     */
+    'amount': string;
+}
+export declare const NativeItemTypeEnum: {
+    readonly Native: "NATIVE";
+    readonly Erc20: "ERC20";
+    readonly Erc721: "ERC721";
+    readonly Erc1155: "ERC1155";
+    readonly Erc721Collection: "ERC721_COLLECTION";
+    readonly Erc1155Collection: "ERC1155_COLLECTION";
+};
+export type NativeItemTypeEnum = typeof NativeItemTypeEnum[keyof typeof NativeItemTypeEnum];

package/dist/types/multi-rollup/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/multi-rollup/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/multi-rollup/models/nftcontract-type.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 contract type for an NFT
+ * @export
+ * @enum {string}
+ */
+export declare const NFTContractType: {
+    readonly Erc721: "ERC721";
+    readonly Erc1155: "ERC1155";
+};
+export type NFTContractType = typeof NFTContractType[keyof typeof NFTContractType];

package/dist/types/multi-rollup/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/multi-rollup/models/nftmetadata-attribute.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 { 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 declare const NFTMetadataAttributeDisplayTypeEnum: {
+    readonly Number: "number";
+    readonly BoostPercentage: "boost_percentage";
+    readonly BoostNumber: "boost_number";
+    readonly Date: "date";
+};
+export type NFTMetadataAttributeDisplayTypeEnum = typeof NFTMetadataAttributeDisplayTypeEnum[keyof typeof NFTMetadataAttributeDisplayTypeEnum];

package/dist/types/multi-rollup/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;
+}