@imtbl/sdk 0.13.2-alpha → 0.14.0-alpha.1

package/dist/index.d.ts

@@ -1281,7 +1281,7 @@ interface GetTokenResult {
  * @export
  * @interface Page
  */
-interface Page$1 {
+interface Page$2 {
     /**
      * First item as an encoded string
      * @type {string}
@@ -1325,7 +1325,7 @@ interface ListActivitiesResult {
      * @type {Page}
      * @memberof ListActivitiesResult
      */
-    'page': Page$1;
+    'page': Page$2;
 }
 
 /**
@@ -1357,7 +1357,7 @@ interface ListChainsResult {
      * @type {Page}
      * @memberof ListChainsResult
      */
-    'page': Page$1;
+    'page': Page$2;
 }
 
 /**
@@ -1389,7 +1389,7 @@ interface ListCollectionsResult {
      * @type {Page}
      * @memberof ListCollectionsResult
      */
-    'page': Page$1;
+    'page': Page$2;
 }
 
 /**
@@ -1471,7 +1471,7 @@ interface ListNFTOwnersResult {
      * @type {Page}
      * @memberof ListNFTOwnersResult
      */
-    'page': Page$1;
+    'page': Page$2;
 }
 
 /**
@@ -1503,7 +1503,7 @@ interface ListNFTsResult {
      * @type {Page}
      * @memberof ListNFTsResult
      */
-    'page': Page$1;
+    'page': Page$2;
 }
 
 /**
@@ -1535,7 +1535,7 @@ interface ListTokensResult {
      * @type {Page}
      * @memberof ListTokensResult
      */
-    'page': Page$1;
+    'page': Page$2;
 }
 
 /**
@@ -7209,7 +7209,7 @@ declare type OrderSell = Token;
  * @export
  * @interface Order
  */
-interface Order$1 {
+interface Order$2 {
     /**
      * Amount of the asset already sold by this order
      * @type {string}
@@ -7307,7 +7307,7 @@ interface ListOrdersResponse {
      * @type {Array<Order>}
      * @memberof ListOrdersResponse
      */
-    'result': Array<Order$1>;
+    'result': Array<Order$2>;
 }
 
 /**
@@ -11079,7 +11079,7 @@ declare class OrdersApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
-    getOrder(requestParameters: OrdersApiGetOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Order$1, any>>;
+    getOrder(requestParameters: OrdersApiGetOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Order$2, any>>;
     /**
      * Get an order (V3)
      * @summary Get an order (V3)
@@ -13331,7 +13331,7 @@ declare enum OrderStatus {
     EXPIRED = "EXPIRED"
 }
 
-type Order = {
+type Order$1 = {
     account_address: string;
     buy: Array<Item>;
     fees: Array<Fee$1>;
@@ -13371,17 +13371,17 @@ type Order = {
 
 type FulfillmentDataResult = {
     extra_data: string;
-    order: Order;
+    order: Order$1;
 };
 
-type ListingResult = {
-    result: Order;
+type ListingResult$1 = {
+    result: Order$1;
 };
 
 /**
  * Pagination properties
  */
-type Page = {
+type Page$1 = {
     /**
      * First item as an encoded string
      */
@@ -13392,9 +13392,9 @@ type Page = {
     next_cursor: string | null;
 };
 
-type ListListingsResult = {
-    page: Page;
-    result: Array<Order>;
+type ListListingsResult$1 = {
+    page: Page$1;
+    result: Array<Order$1>;
 };
 
 /**
@@ -13450,7 +13450,7 @@ declare class OrdersService {
          * Page cursor to retrieve previous or next page. Use the value returned in the response.
          */
         pageCursor?: PageCursor;
-    }): CancelablePromise<ListListingsResult>;
+    }): CancelablePromise<ListListingsResult$1>;
     /**
      * Create a listing
      * Create a listing
@@ -13460,7 +13460,7 @@ declare class OrdersService {
     createListing({ chainName, requestBody, }: {
         chainName: ChainName$1;
         requestBody: CreateListingRequestBody;
-    }): CancelablePromise<ListingResult>;
+    }): CancelablePromise<ListingResult$1>;
     /**
      * Get a single listing by ID
      * Get a single listing by ID
@@ -13473,7 +13473,7 @@ declare class OrdersService {
          * Global Order identifier
          */
         listingId: string;
-    }): CancelablePromise<ListingResult>;
+    }): CancelablePromise<ListingResult$1>;
     /**
      * Retrieve fulfillment data for orders
      * Retrieve signed fulfillment data based on the list of order IDs and corresponding fees.
@@ -13521,7 +13521,7 @@ interface CreateListingParams {
     orderComponents: OrderComponents;
     orderHash: string;
     orderSignature: string;
-    makerFee?: Fee;
+    makerFee?: FeeValue;
 }
 type ListListingsParams = Omit<Parameters<typeof OrdersService.prototype.listListings>[0], 'chainName'>;
 declare enum FeeType {
@@ -13530,11 +13530,13 @@ declare enum FeeType {
     PROTOCOL = "PROTOCOL",
     ROYALTY = "ROYALTY"
 }
-interface Fee {
-    type: FeeType;
+interface FeeValue {
     recipient: string;
     amount: string;
 }
+interface Fee extends FeeValue {
+    type: FeeType;
+}
 declare enum TransactionPurpose {
     APPROVAL = "APPROVAL",
     FULFILL_ORDER = "FULFILL_ORDER"
@@ -13568,6 +13570,54 @@ interface FulfillOrderResponse {
 interface CancelOrderResponse {
     unsignedCancelOrderTransaction: PopulatedTransaction;
 }
+interface Order {
+    id: string;
+    accountAddress: string;
+    buy: (ERC20Item$1 | NativeItem$1)[];
+    sell: ERC721Item$1[];
+    fees: Fee[];
+    chain: {
+        id: string;
+        name: string;
+    };
+    createTime: string;
+    updateTime: string;
+    /**
+     * Time after which the Order is considered active
+     */
+    startTime: string;
+    /**
+     * Time after which the Order is expired
+     */
+    endTime: string;
+    protocolData: {
+        orderType: 'FULL_RESTRICTED';
+        zoneAddress: string;
+        counter: string;
+        seaportAddress: string;
+        seaportVersion: string;
+    };
+    salt: string;
+    signature: string;
+    status: OrderStatus;
+}
+interface ListingResult {
+    result: Order;
+}
+interface ListListingsResult {
+    page: Page;
+    result: Order[];
+}
+interface Page {
+    /**
+     * First item as an encoded string
+     */
+    previousCursor: string | null;
+    /**
+     * Last item as an encoded string
+     */
+    nextCursor: string | null;
+}
 
 /**
  * zkEVM orderbook SDK
@@ -13620,7 +13670,7 @@ declare class Orderbook {
      * @param {string} fulfillerAddress - The address of the account fulfilling the order.
      * @return {FulfillOrderResponse} Approval and fulfilment transactions.
      */
-    fulfillOrder(listingId: string, takerAddress: string, takerFee?: Fee): Promise<FulfillOrderResponse>;
+    fulfillOrder(listingId: string, takerAddress: string, takerFee?: FeeValue): Promise<FulfillOrderResponse>;
     /**
      * Get an unsigned cancel order transaction. Orders can only be cancelled by
      * the account that created them.
@@ -13643,6 +13693,7 @@ type orderbook_d_CreateListingParams = CreateListingParams;
 type orderbook_d_Fee = Fee;
 type orderbook_d_FeeType = FeeType;
 declare const orderbook_d_FeeType: typeof FeeType;
+type orderbook_d_FeeValue = FeeValue;
 type orderbook_d_FulfillOrderResponse = FulfillOrderResponse;
 type orderbook_d_ListListingsParams = ListListingsParams;
 type orderbook_d_ListListingsResult = ListListingsResult;
@@ -13652,6 +13703,7 @@ type orderbook_d_OrderStatus = OrderStatus;
 declare const orderbook_d_OrderStatus: typeof OrderStatus;
 type orderbook_d_Orderbook = Orderbook;
 declare const orderbook_d_Orderbook: typeof Orderbook;
+type orderbook_d_Page = Page;
 type orderbook_d_PrepareListingParams = PrepareListingParams;
 type orderbook_d_PrepareListingResponse = PrepareListingResponse;
 type orderbook_d_RoyaltyInfo = RoyaltyInfo;
@@ -13673,6 +13725,7 @@ declare namespace orderbook_d {
     ERC721Item$1 as ERC721Item,
     orderbook_d_Fee as Fee,
     orderbook_d_FeeType as FeeType,
+    orderbook_d_FeeValue as FeeValue,
     orderbook_d_FulfillOrderResponse as FulfillOrderResponse,
     orderbook_d_ListListingsParams as ListListingsParams,
     orderbook_d_ListListingsResult as ListListingsResult,
@@ -13681,6 +13734,7 @@ declare namespace orderbook_d {
     orderbook_d_Order as Order,
     orderbook_d_OrderStatus as OrderStatus,
     orderbook_d_Orderbook as Orderbook,
+    orderbook_d_Page as Page,
     orderbook_d_PrepareListingParams as PrepareListingParams,
     orderbook_d_PrepareListingResponse as PrepareListingResponse,
     orderbook_d_RoyaltyInfo as RoyaltyInfo,
@@ -29591,6 +29645,14 @@ declare namespace ERC721Hybrid {
         to: string;
         quantity: BigNumber;
     };
+    type IDBurnStruct = {
+        owner: PromiseOrValue<string>;
+        tokenIds: PromiseOrValue<BigNumberish>[];
+    };
+    type IDBurnStructOutput = [string, BigNumber[]] & {
+        owner: string;
+        tokenIds: BigNumber[];
+    };
     type TransferRequestStruct = {
         from: PromiseOrValue<string>;
         tos: PromiseOrValue<string>[];
@@ -29606,7 +29668,8 @@ declare namespace ERC721Hybrid {
 type Mint = ERC721Hybrid.MintStruct;
 type IDMint$1 = ERC721Hybrid.IDMintStruct;
 type TransferRequest$1 = ERC721Hybrid.TransferRequestStruct;
-declare class ERC721HybridPermissionedMintable {
+type IDBurn$1 = ERC721Hybrid.IDBurnStruct;
+declare class ERC721 {
     private readonly contract;
     constructor(contractAddress: string);
     /**
@@ -29709,6 +29772,18 @@ declare class ERC721HybridPermissionedMintable {
     populateBurnBatch(tokenIds: PromiseOrValue<BigNumberish>[], overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the safe burn contract function
+     */
+    populateSafeBurn(owner: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the safe burn batch contract function
+     */
+    populateSafeBurnBatch(burns: IDBurn$1[], overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
     /**
      * @returns a populated transaction for the grantMinterRole contract function
      */
@@ -29724,13 +29799,13 @@ declare class ERC721HybridPermissionedMintable {
     /**
      * @returns a populated transaction for the mint by ID contract function
      */
-    populateMintByID(to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+    populateMint(to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
      * @returns a populated transaction for the safe mint by ID contract function
      */
-    populateSafeMintByID(to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+    populateSafeMint(to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
@@ -29748,25 +29823,25 @@ declare class ERC721HybridPermissionedMintable {
     /**
      * @returns a populated transaction for the batch mint by quantity contract function
      */
-    populateBatchMintByQuantity(mints: Mint[], overrides?: Overrides & {
+    populateMintBatchByQuantity(mints: Mint[], overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
      * @returns a populated transaction for the batch safe mint by quantity contract function
      */
-    populateBatchSafeMintByQuantity(mints: Mint[], overrides?: Overrides & {
+    populateSafeMintBatchByQuantity(mints: Mint[], overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
      * @returns a populated transaction for the batch mint by ID to multiple recipients contract function
      */
-    populateBatchMintByIDToMultiple(mints: IDMint$1[], overrides?: Overrides & {
+    populateMintBatch(mints: IDMint$1[], overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
      * @returns a populated transaction for the batch safe mint by ID to multiple recipients contract function
      */
-    populateBatchSafeMintByIDToMultiple(mints: IDMint$1[], overrides?: Overrides & {
+    populateSafeMintBatch(mints: IDMint$1[], overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
@@ -29849,15 +29924,23 @@ declare class ERC721HybridPermissionedMintable {
     }): Promise<PopulatedTransaction>;
 }
 
-type erc721_hybrid_permissioned_mintable_d_ERC721HybridPermissionedMintable = ERC721HybridPermissionedMintable;
-declare const erc721_hybrid_permissioned_mintable_d_ERC721HybridPermissionedMintable: typeof ERC721HybridPermissionedMintable;
-declare namespace erc721_hybrid_permissioned_mintable_d {
+type erc721_d_ERC721 = ERC721;
+declare const erc721_d_ERC721: typeof ERC721;
+declare namespace erc721_d {
   export {
-    erc721_hybrid_permissioned_mintable_d_ERC721HybridPermissionedMintable as ERC721HybridPermissionedMintable,
+    erc721_d_ERC721 as ERC721,
   };
 }
 
 declare namespace ImmutableERC721Base {
+    type IDBurnStruct = {
+        owner: PromiseOrValue<string>;
+        tokenIds: PromiseOrValue<BigNumberish>[];
+    };
+    type IDBurnStructOutput = [string, BigNumber[]] & {
+        owner: string;
+        tokenIds: BigNumber[];
+    };
     type IDMintStruct = {
         to: PromiseOrValue<string>;
         tokenIds: PromiseOrValue<BigNumberish>[];
@@ -29880,7 +29963,8 @@ declare namespace ImmutableERC721Base {
 
 type IDMint = ImmutableERC721Base.IDMintStruct;
 type TransferRequest = ImmutableERC721Base.TransferRequestStruct;
-declare class ERC721PermissionedMintable {
+type IDBurn = ImmutableERC721Base.IDBurnStruct;
+declare class ERC721MintByID {
     private readonly contract;
     constructor(contractAddress: string);
     /**
@@ -30007,6 +30091,18 @@ declare class ERC721PermissionedMintable {
     populateSafeMintBatch(mints: IDMint[], overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the safe burn contract function
+     */
+    populateSafeBurn(owner: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the safe burn batch contract function
+     */
+    populateSafeBurnBatch(burns: IDBurn[], overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
     /**
      * @returns a populated transaction for the renounceRole contract function
      */
@@ -30087,12 +30183,12 @@ declare class ERC721PermissionedMintable {
     }): Promise<PopulatedTransaction>;
 }
 
-type erc721_permissioned_mintable_d_ERC721PermissionedMintable = ERC721PermissionedMintable;
-declare const erc721_permissioned_mintable_d_ERC721PermissionedMintable: typeof ERC721PermissionedMintable;
-declare namespace erc721_permissioned_mintable_d {
+type erc721_mint_by_id_d_ERC721MintByID = ERC721MintByID;
+declare const erc721_mint_by_id_d_ERC721MintByID: typeof ERC721MintByID;
+declare namespace erc721_mint_by_id_d {
   export {
-    erc721_permissioned_mintable_d_ERC721PermissionedMintable as ERC721PermissionedMintable,
+    erc721_mint_by_id_d_ERC721MintByID as ERC721MintByID,
   };
 }
 
-export { blockchain_data_d as blockchainData, checkout_sdk_d as checkoutSdk, checkout_widgets_d as checkoutWidgets, config_d as config, erc20_d as erc20, erc721_hybrid_permissioned_mintable_d as erc721HybridPermissionedMintable, erc721_permissioned_mintable_d as erc721PermissionedMintable, immutablex_client_d as immutablexClient, orderbook_d as orderbook, passport_d as passport, provider_d as provider };
+export { blockchain_data_d as blockchainData, checkout_sdk_d as checkoutSdk, checkout_widgets_d as checkoutWidgets, config_d as config, erc20_d as erc20, erc721_d as erc721, erc721_mint_by_id_d as erc721MintById, immutablex_client_d as immutablexClient, orderbook_d as orderbook, passport_d as passport, provider_d as provider };