@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/multi-rollup/models/cancelled-order-status.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 CancelledOrderStatus
+ */
+export interface CancelledOrderStatus {
+    /**
+     * The order status indicating a order is has been cancelled or about to be cancelled.
+     * @type {string}
+     * @memberof CancelledOrderStatus
+     */
+    'name': CancelledOrderStatusNameEnum;
+    /**
+     * Whether the cancellation of the order is pending
+     * @type {boolean}
+     * @memberof CancelledOrderStatus
+     */
+    'pending': boolean;
+    /**
+     * Whether the cancellation was done on-chain or off-chain or as a result of an underfunded account
+     * @type {string}
+     * @memberof CancelledOrderStatus
+     */
+    'cancellation_type': CancelledOrderStatusCancellationTypeEnum;
+}
+export declare const CancelledOrderStatusNameEnum: {
+    readonly Cancelled: "CANCELLED";
+};
+export type CancelledOrderStatusNameEnum = typeof CancelledOrderStatusNameEnum[keyof typeof CancelledOrderStatusNameEnum];
+export declare const CancelledOrderStatusCancellationTypeEnum: {
+    readonly OnChain: "ON_CHAIN";
+    readonly OffChain: "OFF_CHAIN";
+    readonly Underfunded: "UNDERFUNDED";
+};
+export type CancelledOrderStatusCancellationTypeEnum = typeof CancelledOrderStatusCancellationTypeEnum[keyof typeof CancelledOrderStatusCancellationTypeEnum];

package/dist/types/multi-rollup/models/chain-with-details-all-of.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 ChainWithDetailsAllOf
+ */
+export interface ChainWithDetailsAllOf {
+    /**
+     * URL for RPC node
+     * @type {string}
+     * @memberof ChainWithDetailsAllOf
+     */
+    'rpc_url': string | null;
+    /**
+     * The address of the Operator Allowlist - https://docs.immutable.com/products/zkevm/minting/royalties/allowlist-spec/
+     * @type {string}
+     * @memberof ChainWithDetailsAllOf
+     */
+    'operator_allowlist_address': string | null;
+    /**
+     * The address of the minter used in the Minting API - https://docs.immutable.com/products/zkEVM/minting/minting-api#minting-api-prerequisites
+     * @type {string}
+     * @memberof ChainWithDetailsAllOf
+     */
+    'minter_address': string | null;
+}

package/dist/types/multi-rollup/models/chain-with-details.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 { Chain } from './chain';
+import { ChainWithDetailsAllOf } from './chain-with-details-all-of';
+/**
+ * @type ChainWithDetails
+ * @export
+ */
+export type ChainWithDetails = Chain & ChainWithDetailsAllOf;

package/dist/types/multi-rollup/models/chain.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.
+ */
+/**
+ * The chain details
+ * @export
+ * @interface Chain
+ */
+export interface Chain {
+    /**
+     * The id of chain
+     * @type {string}
+     * @memberof Chain
+     */
+    'id': string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof Chain
+     */
+    'name': string;
+}

package/dist/types/multi-rollup/models/collection-bid-result.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 { Order } from './order';
+/**
+ *
+ * @export
+ * @interface CollectionBidResult
+ */
+export interface CollectionBidResult {
+    /**
+     *
+     * @type {Order}
+     * @memberof CollectionBidResult
+     */
+    'result': Order;
+}

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

package/dist/types/multi-rollup/models/collection-metadata.d.ts

@@ -0,0 +1,60 @@
+/**
+ * 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 CollectionMetadata
+ */
+export interface CollectionMetadata {
+    /**
+     * The name of the collection
+     * @type {string}
+     * @memberof CollectionMetadata
+     */
+    'name': string | null;
+    /**
+     * The symbol of contract
+     * @type {string}
+     * @memberof CollectionMetadata
+     */
+    'symbol': string | null;
+    /**
+     * The description of collection
+     * @type {string}
+     * @memberof CollectionMetadata
+     */
+    'description': string | null;
+    /**
+     * The url of the collection image
+     * @type {string}
+     * @memberof CollectionMetadata
+     */
+    'image': string | null;
+    /**
+     * The url of external link
+     * @type {string}
+     * @memberof CollectionMetadata
+     */
+    'external_link': string | null;
+    /**
+     * The uri for the metadata of the collection
+     * @type {string}
+     * @memberof CollectionMetadata
+     */
+    'contract_uri': string | null;
+    /**
+     * The metadata uri for nft
+     * @type {string}
+     * @memberof CollectionMetadata
+     */
+    'base_uri': string | null;
+}

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

@@ -0,0 +1,105 @@
+/**
+ * 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 { AssetVerificationStatus } from './asset-verification-status';
+import { Chain } from './chain';
+import { CollectionContractType } from './collection-contract-type';
+/**
+ *
+ * @export
+ * @interface Collection
+ */
+export interface Collection {
+    /**
+     *
+     * @type {Chain}
+     * @memberof Collection
+     */
+    'chain': Chain;
+    /**
+     * The name of the collection
+     * @type {string}
+     * @memberof Collection
+     */
+    'name': string | null;
+    /**
+     * The symbol of contract
+     * @type {string}
+     * @memberof Collection
+     */
+    'symbol': string | null;
+    /**
+     *
+     * @type {CollectionContractType}
+     * @memberof Collection
+     */
+    'contract_type': CollectionContractType;
+    /**
+     * The address of the contract
+     * @type {string}
+     * @memberof Collection
+     */
+    'contract_address': string;
+    /**
+     * The description of collection
+     * @type {string}
+     * @memberof Collection
+     */
+    'description': string | null;
+    /**
+     * The url of the collection image
+     * @type {string}
+     * @memberof Collection
+     */
+    'image': string | null;
+    /**
+     * The url of external link
+     * @type {string}
+     * @memberof Collection
+     */
+    'external_link': string | null;
+    /**
+     * The uri for the metadata of the collection
+     * @type {string}
+     * @memberof Collection
+     */
+    'contract_uri'?: string | null;
+    /**
+     * The metadata uri for nft
+     * @type {string}
+     * @memberof Collection
+     */
+    'base_uri': string | null;
+    /**
+     *
+     * @type {AssetVerificationStatus}
+     * @memberof Collection
+     */
+    'verification_status': AssetVerificationStatus;
+    /**
+     * When the collection was first indexed
+     * @type {string}
+     * @memberof Collection
+     */
+    'indexed_at': string;
+    /**
+     * When the collection was last updated
+     * @type {string}
+     * @memberof Collection
+     */
+    'updated_at': string;
+    /**
+     * When the collection metadata was last synced
+     * @type {string}
+     * @memberof Collection
+     */
+    'metadata_synced_at': string | null;
+}

package/dist/types/multi-rollup/models/create-bid-request-body.d.ts

@@ -0,0 +1,82 @@
+/**
+ * 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 { ERC20Item } from './erc20-item';
+import { Fee } from './fee';
+import { Item } from './item';
+import { ProtocolData } from './protocol-data';
+/**
+ *
+ * @export
+ * @interface CreateBidRequestBody
+ */
+export interface CreateBidRequestBody {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateBidRequestBody
+     */
+    'account_address': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateBidRequestBody
+     */
+    'order_hash': string;
+    /**
+     * Buy item for bid should either be ERC721 or ERC1155 item
+     * @type {Array<Item>}
+     * @memberof CreateBidRequestBody
+     */
+    'buy': Array<Item>;
+    /**
+     * Buy fees should only include maker marketplace fees and should be no more than two entries as more entires will incur more gas. It is best practice to have this as few as possible.
+     * @type {Array<Fee>}
+     * @memberof CreateBidRequestBody
+     */
+    'fees': Array<Fee>;
+    /**
+     * Time after which the Order is considered expired
+     * @type {string}
+     * @memberof CreateBidRequestBody
+     */
+    'end_at': string;
+    /**
+     *
+     * @type {ProtocolData}
+     * @memberof CreateBidRequestBody
+     */
+    'protocol_data': ProtocolData;
+    /**
+     * A random value added to the create Order request
+     * @type {string}
+     * @memberof CreateBidRequestBody
+     */
+    'salt': string;
+    /**
+     * Sell item for bid should be an ERC20 item
+     * @type {Array<ERC20Item>}
+     * @memberof CreateBidRequestBody
+     */
+    'sell': Array<ERC20Item>;
+    /**
+     * Digital signature generated by the user for the specific Order
+     * @type {string}
+     * @memberof CreateBidRequestBody
+     */
+    'signature': string;
+    /**
+     * Time after which Order is considered active
+     * @type {string}
+     * @memberof CreateBidRequestBody
+     */
+    'start_at': string;
+}

package/dist/types/multi-rollup/models/create-collection-bid-request-body.d.ts

@@ -0,0 +1,82 @@
+/**
+ * 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 { AssetCollectionItem } from './asset-collection-item';
+import { ERC20Item } from './erc20-item';
+import { Fee } from './fee';
+import { ProtocolData } from './protocol-data';
+/**
+ *
+ * @export
+ * @interface CreateCollectionBidRequestBody
+ */
+export interface CreateCollectionBidRequestBody {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateCollectionBidRequestBody
+     */
+    'account_address': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateCollectionBidRequestBody
+     */
+    'order_hash': string;
+    /**
+     * Buy item for collection bid should either be ERC721 or ERC1155 collection item
+     * @type {Array<AssetCollectionItem>}
+     * @memberof CreateCollectionBidRequestBody
+     */
+    'buy': Array<AssetCollectionItem>;
+    /**
+     * Buy fees should only include maker marketplace fees and should be no more than two entries as more entires will incur more gas. It is best practice to have this as few as possible.
+     * @type {Array<Fee>}
+     * @memberof CreateCollectionBidRequestBody
+     */
+    'fees': Array<Fee>;
+    /**
+     * Time after which the Order is considered expired
+     * @type {string}
+     * @memberof CreateCollectionBidRequestBody
+     */
+    'end_at': string;
+    /**
+     *
+     * @type {ProtocolData}
+     * @memberof CreateCollectionBidRequestBody
+     */
+    'protocol_data': ProtocolData;
+    /**
+     * A random value added to the create Order request
+     * @type {string}
+     * @memberof CreateCollectionBidRequestBody
+     */
+    'salt': string;
+    /**
+     * Sell item for collection bid should be an ERC20 item
+     * @type {Array<ERC20Item>}
+     * @memberof CreateCollectionBidRequestBody
+     */
+    'sell': Array<ERC20Item>;
+    /**
+     * Digital signature generated by the user for the specific Order
+     * @type {string}
+     * @memberof CreateCollectionBidRequestBody
+     */
+    'signature': string;
+    /**
+     * Time after which Order is considered active
+     * @type {string}
+     * @memberof CreateCollectionBidRequestBody
+     */
+    'start_at': string;
+}

package/dist/types/multi-rollup/models/create-counterfactual-address-request.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.
+ */
+/**
+ *
+ * @export
+ * @interface CreateCounterfactualAddressRequest
+ */
+export interface CreateCounterfactualAddressRequest {
+    /**
+     * The user\'s UAK address
+     * @type {string}
+     * @memberof CreateCounterfactualAddressRequest
+     */
+    'ethereum_address': string;
+    /**
+     * The signature generated with the UAK
+     * @type {string}
+     * @memberof CreateCounterfactualAddressRequest
+     */
+    'ethereum_signature': string;
+}

package/dist/types/multi-rollup/models/create-counterfactual-address-res.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 CreateCounterfactualAddressRes
+ */
+export interface CreateCounterfactualAddressRes {
+    /**
+     * The user\'s counterfactual address
+     * @type {string}
+     * @memberof CreateCounterfactualAddressRes
+     */
+    'counterfactual_address': string;
+}

package/dist/types/multi-rollup/models/create-listing-request-body.d.ts

@@ -0,0 +1,81 @@
+/**
+ * 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 { Fee } from './fee';
+import { Item } from './item';
+import { ProtocolData } from './protocol-data';
+/**
+ *
+ * @export
+ * @interface CreateListingRequestBody
+ */
+export interface CreateListingRequestBody {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateListingRequestBody
+     */
+    'account_address': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateListingRequestBody
+     */
+    'order_hash': string;
+    /**
+     * Buy item for listing should either be NATIVE or ERC20 item
+     * @type {Array<Item>}
+     * @memberof CreateListingRequestBody
+     */
+    'buy': Array<Item>;
+    /**
+     * Buy fees should only include maker marketplace fees and should be no more than two entries as more entires will incur more gas. It is best practice to have this as few as possible.
+     * @type {Array<Fee>}
+     * @memberof CreateListingRequestBody
+     */
+    'fees': Array<Fee>;
+    /**
+     * Time after which the Order is considered expired
+     * @type {string}
+     * @memberof CreateListingRequestBody
+     */
+    'end_at': string;
+    /**
+     *
+     * @type {ProtocolData}
+     * @memberof CreateListingRequestBody
+     */
+    'protocol_data': ProtocolData;
+    /**
+     * A random value added to the create Order request
+     * @type {string}
+     * @memberof CreateListingRequestBody
+     */
+    'salt': string;
+    /**
+     * Sell item for listing should be an ERC721 item
+     * @type {Array<Item>}
+     * @memberof CreateListingRequestBody
+     */
+    'sell': Array<Item>;
+    /**
+     * Digital signature generated by the user for the specific Order
+     * @type {string}
+     * @memberof CreateListingRequestBody
+     */
+    'signature': string;
+    /**
+     * Time after which Order is considered active
+     * @type {string}
+     * @memberof CreateListingRequestBody
+     */
+    'start_at': string;
+}

package/dist/types/multi-rollup/models/create-mint-request-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 { MintAsset } from './mint-asset';
+/**
+ *
+ * @export
+ * @interface CreateMintRequestRequest
+ */
+export interface CreateMintRequestRequest {
+    /**
+     * List of nft to be minted
+     * @type {Array<MintAsset>}
+     * @memberof CreateMintRequestRequest
+     */
+    'assets': Array<MintAsset>;
+}