@imtbl/sdk 0.24.1 → 0.25.0

package/dist/index.d.ts

@@ -1159,6 +1159,98 @@ interface NFTMetadataAttribute {
     'value': NFTMetadataAttributeValue;
 }
 
+/**
+ * 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 Metadata
+ */
+interface Metadata {
+    /**
+     * Metadata ID in UUIDv4 format
+     * @type {string}
+     * @memberof Metadata
+     */
+    'id': string;
+    /**
+     *
+     * @type {Chain}
+     * @memberof Metadata
+     */
+    'chain': Chain$1;
+    /**
+     * 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;
+}
+
 /**
  * Immutable zkEVM API
  * Immutable Multi Rollup API
@@ -1201,6 +1293,12 @@ interface NFT {
      * @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}
@@ -1388,6 +1486,12 @@ interface Token$1 {
      * @memberof Token
      */
     'name': string | null;
+    /**
+     * When the collection was last updated
+     * @type {string}
+     * @memberof Token
+     */
+    'updated_at': string;
 }
 
 /**
@@ -1543,6 +1647,38 @@ interface ListCollectionsResult {
     'page': Page$2;
 }
 
+/**
+ * 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 ListMetadataResult
+ */
+interface ListMetadataResult {
+    /**
+     * List of metadata
+     * @type {Array<Metadata>}
+     * @memberof ListMetadataResult
+     */
+    'result': Array<Metadata>;
+    /**
+     *
+     * @type {Page}
+     * @memberof ListMetadataResult
+     */
+    'page': Page$2;
+}
+
 /**
  * Immutable zkEVM API
  * Immutable Multi Rollup API
@@ -1591,6 +1727,12 @@ interface NFTOwner {
      * @memberof NFTOwner
      */
     'quantity': string;
+    /**
+     * When the NFT owner was last updated
+     * @type {string}
+     * @memberof NFTOwner
+     */
+    'updated_at'?: string;
 }
 
 /**
@@ -2134,6 +2276,12 @@ interface CollectionsApiListCollectionsRequest$1 {
      * @memberof CollectionsApiListCollections
      */
     readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof CollectionsApiListCollections
+     */
+    readonly fromUpdatedAt?: string;
     /**
      * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
      * @type {string}
@@ -2204,6 +2352,43 @@ interface CollectionsApiRefreshCollectionMetadataRequest {
     readonly refreshCollectionMetadataRequest: RefreshCollectionMetadataRequest;
 }
 
+/**
+ * Request parameters for listMetadata operation in MetadataApi.
+ * @export
+ * @interface MetadataApiListMetadataRequest
+ */
+interface MetadataApiListMetadataRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof MetadataApiListMetadata
+     */
+    readonly chainName: string;
+    /**
+     * The address of metadata contract
+     * @type {string}
+     * @memberof MetadataApiListMetadata
+     */
+    readonly contractAddress: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof MetadataApiListMetadata
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof MetadataApiListMetadata
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof MetadataApiListMetadata
+     */
+    readonly pageSize?: number;
+}
 /**
  * Request parameters for refreshMetadataByID operation in MetadataApi.
  * @export
@@ -2292,6 +2477,43 @@ interface NftOwnersApiListNFTOwnersRequest {
      */
     readonly pageSize?: number;
 }
+/**
+ * Request parameters for listOwnersByContractAddress operation in NftOwnersApi.
+ * @export
+ * @interface NftOwnersApiListOwnersByContractAddressRequest
+ */
+interface NftOwnersApiListOwnersByContractAddressRequest {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof NftOwnersApiListOwnersByContractAddress
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftOwnersApiListOwnersByContractAddress
+     */
+    readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof NftOwnersApiListOwnersByContractAddress
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof NftOwnersApiListOwnersByContractAddress
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof NftOwnersApiListOwnersByContractAddress
+     */
+    readonly pageSize?: number;
+}
 
 /**
  * Request parameters for getNFT operation in NftsApi.
@@ -2318,6 +2540,68 @@ interface NftsApiGetNFTRequest {
      */
     readonly chainName: string;
 }
+/**
+ * Request parameters for listAllNFTOwners operation in NftsApi.
+ * @export
+ * @interface NftsApiListAllNFTOwnersRequest
+ */
+interface NftsApiListAllNFTOwnersRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftsApiListAllNFTOwners
+     */
+    readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof NftsApiListAllNFTOwners
+     */
+    readonly fromUpdatedAt: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof NftsApiListAllNFTOwners
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof NftsApiListAllNFTOwners
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listAllNFTs operation in NftsApi.
+ * @export
+ * @interface NftsApiListAllNFTsRequest
+ */
+interface NftsApiListAllNFTsRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftsApiListAllNFTs
+     */
+    readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof NftsApiListAllNFTs
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof NftsApiListAllNFTs
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof NftsApiListAllNFTs
+     */
+    readonly pageSize?: number;
+}
 /**
  * Request parameters for listNFTs operation in NftsApi.
  * @export
@@ -2336,6 +2620,12 @@ interface NftsApiListNFTsRequest {
      * @memberof NftsApiListNFTs
      */
     readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof NftsApiListNFTs
+     */
+    readonly fromUpdatedAt?: string;
     /**
      * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
      * @type {string}
@@ -2418,6 +2708,12 @@ interface TokensApiListERC20TokensRequest {
      * @memberof TokensApiListERC20Tokens
      */
     readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof TokensApiListERC20Tokens
+     */
+    readonly fromUpdatedAt?: string;
     /**
      * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
      * @type {string}
@@ -2537,6 +2833,13 @@ declare class BlockchainData {
      * @throws {@link index.APIError}
      */
     listNFTsByAccountAddress(request: NftsApiListNFTsByAccountAddressRequest): Promise<ListNFTsResult>;
+    /**
+     * List All NFTs on a chain
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFTs
+     * @throws {@link index.APIError}
+     */
+    listAllNFTs(request: NftsApiListAllNFTsRequest): Promise<ListNFTsResult>;
     /**
      * List NFT owners by token ID
      * @param request - the request object containing the parameters to be provided in the API request
@@ -2544,6 +2847,20 @@ declare class BlockchainData {
      * @throws {@link index.APIError}
      */
     listNFTOwners(request: NftOwnersApiListNFTOwnersRequest): Promise<ListNFTOwnersResult>;
+    /**
+     * List NFT owners by contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFT owners
+     * @throws {@link index.APIError}
+     */
+    listNFTOwnersByContractAddress(request: NftOwnersApiListOwnersByContractAddressRequest): Promise<ListNFTOwnersResult>;
+    /**
+     * List All NFT owners on a chain
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFT owners
+     * @throws {@link index.APIError}
+     */
+    listAllNFTOwners(request: NftsApiListAllNFTOwnersRequest): Promise<ListNFTOwnersResult>;
     /**
      * List ERC20 Token contracts
      * @param request - the request object containing the parameters to be provided in the API request
@@ -2558,6 +2875,13 @@ declare class BlockchainData {
      * @throws {@link index.APIError}
      */
     getToken(request: TokensApiGetERC20TokenRequest): Promise<GetTokenResult>;
+    /**
+     * List NFT Metadata by contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of Metadata
+     * @throws {@link index.APIError}
+     */
+    listNFTMetadataByContractAddress(request: MetadataApiListMetadataRequest): Promise<ListMetadataResult>;
     /**
      * Refresh collection metadata
      * @param request - the request object containing the parameters to be provided in the API request
@@ -13850,6 +14174,47 @@ declare abstract class BaseHttpRequest {
     abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
 }
 
+type CancelOrdersRequestBody = {
+    /**
+     * Address of the user initiating the cancel request
+     */
+    account_address: string;
+    /**
+     * List of order ids proposed for cancellation
+     */
+    orders: Array<string>;
+    /**
+     * Signature generated by the user for the specific cancellation request
+     */
+    signature: string;
+};
+
+type CancelOrdersResult = {
+    result: {
+        /**
+         * Orders which were successfully cancelled
+         */
+        successful_cancellations: Array<string>;
+        /**
+         * Orders which are marked for cancellation but the cancellation cannot be guaranteed
+         */
+        pending_cancellations: Array<string>;
+        /**
+         * Orders which failed to be cancelled
+         */
+        failed_cancellations: Array<{
+            /**
+             * ID of the order which failed to be cancelled
+             */
+            order: string;
+            /**
+             * Reason code indicating why the order failed to be cancelled
+             */
+            reason_code: 'ALREADY_FILLED';
+        }>;
+    };
+};
+
 /**
  * The name of chain
  */
@@ -14003,17 +14368,69 @@ type Chain = {
     name: string;
 };
 
+type ActiveOrderStatus = {
+    /**
+     * The order status
+     */
+    name: 'ACTIVE';
+};
+
+type CancelledOrderStatus = {
+    /**
+     * The order status
+     */
+    name: 'CANCELLED';
+    /**
+     * Whether the cancellation of the order is pending
+     */
+    is_pending: boolean;
+    /**
+     * Whether the cancellation was done on-chain or off-chain
+     */
+    cancellation_type: CancelledOrderStatus.cancellation_type;
+};
+declare namespace CancelledOrderStatus {
+    /**
+     * Whether the cancellation was done on-chain or off-chain
+     */
+    enum cancellation_type {
+        ON_CHAIN = "ON_CHAIN",
+        OFF_CHAIN = "OFF_CHAIN"
+    }
+}
+
+type ExpiredOrderStatus = {
+    /**
+     * The order status
+     */
+    name: 'EXPIRED';
+};
+
+type FilledOrderStatus = {
+    /**
+     * The order status
+     */
+    name: 'FILLED';
+};
+
+type InactiveOrderStatus = {
+    /**
+     * The order status
+     */
+    name: 'INACTIVE';
+};
+
+type PendingOrderStatus = {
+    /**
+     * The order status
+     */
+    name: 'PENDING';
+};
+
 /**
  * The Order status
  */
-declare enum OrderStatus {
-    PENDING = "PENDING",
-    ACTIVE = "ACTIVE",
-    INACTIVE = "INACTIVE",
-    FILLED = "FILLED",
-    CANCELLED = "CANCELLED",
-    EXPIRED = "EXPIRED"
-}
+type OrderStatus = (CancelledOrderStatus | PendingOrderStatus | ActiveOrderStatus | InactiveOrderStatus | FilledOrderStatus | ExpiredOrderStatus);
 
 type Order$1 = {
     account_address: string;
@@ -14134,6 +14551,18 @@ type ListTradeResult = {
     result: Array<Trade$1>;
 };
 
+/**
+ * The Order status
+ */
+declare enum OrderStatusName {
+    PENDING = "PENDING",
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE",
+    FILLED = "FILLED",
+    EXPIRED = "EXPIRED",
+    CANCELLED = "CANCELLED"
+}
+
 /**
  * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
  */
@@ -14148,7 +14577,7 @@ type TradeResult$1 = {
     result: Trade$1;
 };
 
-type UnfulfillableOrder = {
+type UnfulfillableOrder$1 = {
     /**
      * OrderID for the requested but unfulfillable order
      */
@@ -14162,6 +14591,16 @@ type UnfulfillableOrder = {
 declare class OrdersService {
     readonly httpRequest: BaseHttpRequest;
     constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Cancel one or more orders
+     * Cancel one or more orders
+     * @returns CancelOrdersResult Orders cancellation response.
+     * @throws ApiError
+     */
+    cancelOrders({ chainName, requestBody, }: {
+        chainName: ChainName$1;
+        requestBody: CancelOrdersRequestBody;
+    }): CancelablePromise<CancelOrdersResult>;
     /**
      * List all listings
      * List all listings
@@ -14173,7 +14612,7 @@ declare class OrdersService {
         /**
          * Order status to filter by
          */
-        status?: OrderStatus;
+        status?: OrderStatusName;
         /**
          * Sell item contract address to filter by
          */
@@ -14238,7 +14677,7 @@ declare class OrdersService {
     }): CancelablePromise<{
         result: {
             fulfillable_orders: Array<FulfillableOrder>;
-            unfulfillable_orders: Array<UnfulfillableOrder>;
+            unfulfillable_orders: Array<UnfulfillableOrder$1>;
         };
     }>;
     /**
@@ -14359,6 +14798,20 @@ interface SignableAction {
     };
 }
 type Action = TransactionAction | SignableAction;
+interface FulfillmentListing {
+    listingId: string;
+    takerFees: Array<FeeValue>;
+}
+interface FulfillBulkOrdersResponse {
+    actions: Action[];
+    expiration: string;
+    fulfillableOrders: Order[];
+    unfulfillableOrders: UnfulfillableOrder[];
+}
+interface UnfulfillableOrder {
+    orderId: string;
+    reason: string;
+}
 interface FulfillOrderResponse {
     actions: Action[];
     /**
@@ -14529,6 +14982,7 @@ declare class Orderbook {
      * @return {FulfillOrderResponse} Approval and fulfilment transactions.
      */
     fulfillOrder(listingId: string, takerAddress: string, takerFees: FeeValue[]): Promise<FulfillOrderResponse>;
+    fulfillBulkOrders(listings: Array<FulfillmentListing>, takerAddress: string): Promise<FulfillBulkOrdersResponse>;
     /**
      * Get an unsigned cancel order transaction. Orders can only be cancelled by
      * the account that created them.
@@ -14553,7 +15007,9 @@ type orderbook_d_ERC721Item = ERC721Item;
 type orderbook_d_FeeType = FeeType;
 declare const orderbook_d_FeeType: typeof FeeType;
 type orderbook_d_FeeValue = FeeValue;
+type orderbook_d_FulfillBulkOrdersResponse = FulfillBulkOrdersResponse;
 type orderbook_d_FulfillOrderResponse = FulfillOrderResponse;
+type orderbook_d_FulfillmentListing = FulfillmentListing;
 type orderbook_d_ListListingsParams = ListListingsParams;
 type orderbook_d_ListListingsResult = ListListingsResult;
 type orderbook_d_ListTradesParams = ListTradesParams;
@@ -14561,8 +15017,8 @@ type orderbook_d_ListTradesResult = ListTradesResult;
 type orderbook_d_ListingResult = ListingResult;
 type orderbook_d_NativeItem = NativeItem;
 type orderbook_d_Order = Order;
-type orderbook_d_OrderStatus = OrderStatus;
-declare const orderbook_d_OrderStatus: typeof OrderStatus;
+type orderbook_d_OrderStatusName = OrderStatusName;
+declare const orderbook_d_OrderStatusName: typeof OrderStatusName;
 type orderbook_d_Orderbook = Orderbook;
 declare const orderbook_d_Orderbook: typeof Orderbook;
 type orderbook_d_Page = Page;
@@ -14578,6 +15034,7 @@ type orderbook_d_TransactionAction = TransactionAction;
 type orderbook_d_TransactionBuilder = TransactionBuilder;
 type orderbook_d_TransactionPurpose = TransactionPurpose;
 declare const orderbook_d_TransactionPurpose: typeof TransactionPurpose;
+type orderbook_d_UnfulfillableOrder = UnfulfillableOrder;
 declare const orderbook_d_constants: typeof constants;
 declare namespace orderbook_d {
   export {
@@ -14590,7 +15047,9 @@ declare namespace orderbook_d {
     Fee$1 as Fee,
     orderbook_d_FeeType as FeeType,
     orderbook_d_FeeValue as FeeValue,
+    orderbook_d_FulfillBulkOrdersResponse as FulfillBulkOrdersResponse,
     orderbook_d_FulfillOrderResponse as FulfillOrderResponse,
+    orderbook_d_FulfillmentListing as FulfillmentListing,
     orderbook_d_ListListingsParams as ListListingsParams,
     orderbook_d_ListListingsResult as ListListingsResult,
     orderbook_d_ListTradesParams as ListTradesParams,
@@ -14598,7 +15057,7 @@ declare namespace orderbook_d {
     orderbook_d_ListingResult as ListingResult,
     orderbook_d_NativeItem as NativeItem,
     orderbook_d_Order as Order,
-    orderbook_d_OrderStatus as OrderStatus,
+    orderbook_d_OrderStatusName as OrderStatusName,
     orderbook_d_Orderbook as Orderbook,
     orderbook_d_Page as Page,
     orderbook_d_PrepareListingParams as PrepareListingParams,
@@ -14611,6 +15070,7 @@ declare namespace orderbook_d {
     orderbook_d_TransactionAction as TransactionAction,
     orderbook_d_TransactionBuilder as TransactionBuilder,
     orderbook_d_TransactionPurpose as TransactionPurpose,
+    orderbook_d_UnfulfillableOrder as UnfulfillableOrder,
     orderbook_d_constants as constants,
   };
 }