@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/multi-rollup/models/operator-allowlist-status.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 status of a contract on the operator allowlist
+ * @export
+ * @enum {string}
+ */
+export declare const OperatorAllowlistStatus: {
+    readonly Requested: "requested";
+    readonly Approved: "approved";
+    readonly Rejected: "rejected";
+    readonly Removed: "removed";
+    readonly Added: "added";
+};
+export type OperatorAllowlistStatus = typeof OperatorAllowlistStatus[keyof typeof OperatorAllowlistStatus];

package/dist/types/multi-rollup/models/order-status-name.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.
+ */
+/**
+ * The Order status
+ * @export
+ * @enum {string}
+ */
+export declare const OrderStatusName: {
+    readonly Pending: "PENDING";
+    readonly Active: "ACTIVE";
+    readonly Inactive: "INACTIVE";
+    readonly Filled: "FILLED";
+    readonly Expired: "EXPIRED";
+    readonly Cancelled: "CANCELLED";
+};
+export type OrderStatusName = typeof OrderStatusName[keyof typeof OrderStatusName];

package/dist/types/multi-rollup/models/order-status.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 { ActiveOrderStatus } from './active-order-status';
+import { CancelledOrderStatus } from './cancelled-order-status';
+import { ExpiredOrderStatus } from './expired-order-status';
+import { FilledOrderStatus } from './filled-order-status';
+import { InactiveOrderStatus } from './inactive-order-status';
+import { PendingOrderStatus } from './pending-order-status';
+/**
+ * @type OrderStatus
+ * The Order status
+ * @export
+ */
+export type OrderStatus = {
+    name: 'ACTIVE';
+} & ActiveOrderStatus | {
+    name: 'CANCELLED';
+} & CancelledOrderStatus | {
+    name: 'EXPIRED';
+} & ExpiredOrderStatus | {
+    name: 'FILLED';
+} & FilledOrderStatus | {
+    name: 'INACTIVE';
+} & InactiveOrderStatus | {
+    name: 'PENDING';
+} & PendingOrderStatus;

package/dist/types/multi-rollup/models/order.d.ts

@@ -0,0 +1,132 @@
+/**
+ * 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 { Fee } from './fee';
+import { FillStatus } from './fill-status';
+import { Item } from './item';
+import { OrderStatus } from './order-status';
+import { ProtocolData } from './protocol-data';
+/**
+ *
+ * @export
+ * @interface Order
+ */
+export interface Order {
+    /**
+     *
+     * @type {string}
+     * @memberof Order
+     */
+    'account_address': string;
+    /**
+     *
+     * @type {Array<Item>}
+     * @memberof Order
+     */
+    'buy': Array<Item>;
+    /**
+     *
+     * @type {Array<Fee>}
+     * @memberof Order
+     */
+    'fees': Array<Fee>;
+    /**
+     *
+     * @type {Chain}
+     * @memberof Order
+     */
+    'chain': Chain;
+    /**
+     * Time the Order is created
+     * @type {string}
+     * @memberof Order
+     */
+    'created_at': string;
+    /**
+     * Time after which the Order is considered expired
+     * @type {string}
+     * @memberof Order
+     */
+    'end_at': string;
+    /**
+     * Global Order identifier
+     * @type {string}
+     * @memberof Order
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Order
+     */
+    'order_hash': string;
+    /**
+     *
+     * @type {ProtocolData}
+     * @memberof Order
+     */
+    'protocol_data': ProtocolData;
+    /**
+     * A random value added to the create Order request
+     * @type {string}
+     * @memberof Order
+     */
+    'salt': string;
+    /**
+     *
+     * @type {Array<Item>}
+     * @memberof Order
+     */
+    'sell': Array<Item>;
+    /**
+     * Digital signature generated by the user for the specific Order
+     * @type {string}
+     * @memberof Order
+     */
+    'signature': string;
+    /**
+     * Time after which Order is considered active
+     * @type {string}
+     * @memberof Order
+     */
+    'start_at': string;
+    /**
+     *
+     * @type {OrderStatus}
+     * @memberof Order
+     */
+    'status': OrderStatus;
+    /**
+     * Order type
+     * @type {string}
+     * @memberof Order
+     */
+    'type': OrderTypeEnum;
+    /**
+     * Time the Order is last updated
+     * @type {string}
+     * @memberof Order
+     */
+    'updated_at': string;
+    /**
+     *
+     * @type {FillStatus}
+     * @memberof Order
+     */
+    'fill_status': FillStatus;
+}
+export declare const OrderTypeEnum: {
+    readonly Listing: "LISTING";
+    readonly Bid: "BID";
+    readonly CollectionBid: "COLLECTION_BID";
+};
+export type OrderTypeEnum = typeof OrderTypeEnum[keyof typeof OrderTypeEnum];

package/dist/types/multi-rollup/models/organisation-tier.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 tier of the organisation
+ * @export
+ * @enum {string}
+ */
+export declare const OrganisationTier: {
+    readonly Common: "common";
+    readonly Uncommon: "uncommon";
+    readonly Rare: "rare";
+    readonly Epic: "epic";
+    readonly Legendary: "legendary";
+};
+export type OrganisationTier = typeof OrganisationTier[keyof typeof OrganisationTier];

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

@@ -0,0 +1,40 @@
+/**
+ * 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 PendingOrderStatus
+ */
+export interface PendingOrderStatus {
+    /**
+     * The order status that indicates the order is yet to be active due to various reasons.
+     * @type {string}
+     * @memberof PendingOrderStatus
+     */
+    'name': PendingOrderStatusNameEnum;
+    /**
+     * Whether the order has been evaluated after its creation
+     * @type {boolean}
+     * @memberof PendingOrderStatus
+     */
+    'evaluated': boolean;
+    /**
+     * Whether the order has reached its specified start time
+     * @type {boolean}
+     * @memberof PendingOrderStatus
+     */
+    'started': boolean;
+}
+export declare const PendingOrderStatusNameEnum: {
+    readonly Pending: "PENDING";
+};
+export type PendingOrderStatusNameEnum = typeof PendingOrderStatusNameEnum[keyof typeof PendingOrderStatusNameEnum];

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

@@ -0,0 +1,53 @@
+/**
+ * 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 ProtocolData
+ */
+export interface ProtocolData {
+    /**
+     * Seaport order type. Orders containing ERC721 tokens will need to pass in the order type as FULL_RESTRICTED while orders with ERC1155 tokens will need to pass in the order_type as PARTIAL_RESTRICTED
+     * @type {string}
+     * @memberof ProtocolData
+     */
+    'order_type': ProtocolDataOrderTypeEnum;
+    /**
+     * big.Int or uint256 string for order counter
+     * @type {string}
+     * @memberof ProtocolData
+     */
+    'counter': string;
+    /**
+     * Immutable zone address
+     * @type {string}
+     * @memberof ProtocolData
+     */
+    'zone_address': string;
+    /**
+     * Immutable Seaport contract address
+     * @type {string}
+     * @memberof ProtocolData
+     */
+    'seaport_address': string;
+    /**
+     * Immutable Seaport contract version
+     * @type {string}
+     * @memberof ProtocolData
+     */
+    'seaport_version': string;
+}
+export declare const ProtocolDataOrderTypeEnum: {
+    readonly FullRestricted: "FULL_RESTRICTED";
+    readonly PartialRestricted: "PARTIAL_RESTRICTED";
+};
+export type ProtocolDataOrderTypeEnum = typeof ProtocolDataOrderTypeEnum[keyof typeof ProtocolDataOrderTypeEnum];

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