@imtbl/sdk 1.10.0-alpha.1 → 1.11.0

package/dist/index.cjs

@@ -174,7 +174,7 @@ const flattenProperties$1 = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION$1 = '1.10.0-alpha.1';
+const SDK_VERSION$1 = '1.11.0';
 const getReferrer$1 = () => {
     if (isNode$1()) {
         return '';
@@ -8441,6 +8441,85 @@ class NftOwnersApi extends BaseAPI$2 {
  */
 const NftsApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         * [Experimental] Create a mint request to mint a set of NFTs for a given collection
+         * @summary [Experimental] Mint NFTs
+         * @param {string} contractAddress The address of contract
+         * @param {string} chainName The name of chain
+         * @param {CreateMintRequestRequest} createMintRequestRequest the request body
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createMintRequest: async (contractAddress, chainName, createMintRequestRequest, options = {}) => {
+            // verify required parameter 'contractAddress' is not null or undefined
+            assertParamExists$2('createMintRequest', 'contractAddress', contractAddress);
+            // verify required parameter 'chainName' is not null or undefined
+            assertParamExists$2('createMintRequest', 'chainName', chainName);
+            // verify required parameter 'createMintRequestRequest' is not null or undefined
+            assertParamExists$2('createMintRequest', 'createMintRequestRequest', createMintRequestRequest);
+            const localVarPath = `/v1/chains/{chain_name}/collections/{contract_address}/nfts/mint-requests`
+                .replace(`{${"contract_address"}}`, encodeURIComponent(String(contractAddress)))
+                .replace(`{${"chain_name"}}`, encodeURIComponent(String(chainName)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL$2);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ImmutableApiKey required
+            await setApiKeyToObject(localVarHeaderParameter, "x-immutable-api-key", configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams$2(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            localVarRequestOptions.data = serializeDataIfNeeded$2(createMintRequestRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString$2(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * [Experimental] Retrieve the status of a mint request identified by its reference_id
+         * @summary [Experimental] Get mint request by reference ID
+         * @param {string} contractAddress The address of contract
+         * @param {string} chainName The name of chain
+         * @param {string} referenceId The ID of the mint request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMintRequest: async (contractAddress, chainName, referenceId, options = {}) => {
+            // verify required parameter 'contractAddress' is not null or undefined
+            assertParamExists$2('getMintRequest', 'contractAddress', contractAddress);
+            // verify required parameter 'chainName' is not null or undefined
+            assertParamExists$2('getMintRequest', 'chainName', chainName);
+            // verify required parameter 'referenceId' is not null or undefined
+            assertParamExists$2('getMintRequest', 'referenceId', referenceId);
+            const localVarPath = `/v1/chains/{chain_name}/collections/{contract_address}/nfts/mint-requests/{reference_id}`
+                .replace(`{${"contract_address"}}`, encodeURIComponent(String(contractAddress)))
+                .replace(`{${"chain_name"}}`, encodeURIComponent(String(chainName)))
+                .replace(`{${"reference_id"}}`, encodeURIComponent(String(referenceId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL$2);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ImmutableApiKey required
+            await setApiKeyToObject(localVarHeaderParameter, "x-immutable-api-key", configuration);
+            setSearchParams$2(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: toPathString$2(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Get NFT by token ID
          * @summary Get NFT by token ID
@@ -8521,6 +8600,53 @@ const NftsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * [Experimental] Retrieve the status of all mints for a given contract address
+         * @summary [Experimental] List mint requests
+         * @param {string} contractAddress The address of contract
+         * @param {string} chainName The name of chain
+         * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+         * @param {number} [pageSize] Maximum number of items to return
+         * @param {MintRequestStatus} [status] The status of the mint request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMintRequests: async (contractAddress, chainName, pageCursor, pageSize, status, options = {}) => {
+            // verify required parameter 'contractAddress' is not null or undefined
+            assertParamExists$2('listMintRequests', 'contractAddress', contractAddress);
+            // verify required parameter 'chainName' is not null or undefined
+            assertParamExists$2('listMintRequests', 'chainName', chainName);
+            const localVarPath = `/v1/chains/{chain_name}/collections/{contract_address}/nfts/mint-requests`
+                .replace(`{${"contract_address"}}`, encodeURIComponent(String(contractAddress)))
+                .replace(`{${"chain_name"}}`, encodeURIComponent(String(chainName)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL$2);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ImmutableApiKey required
+            await setApiKeyToObject(localVarHeaderParameter, "x-immutable-api-key", configuration);
+            if (pageCursor !== undefined) {
+                localVarQueryParameter['page_cursor'] = pageCursor;
+            }
+            if (pageSize !== undefined) {
+                localVarQueryParameter['page_size'] = pageSize;
+            }
+            if (status !== undefined) {
+                localVarQueryParameter['status'] = status;
+            }
+            setSearchParams$2(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: toPathString$2(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * List NFTs by contract address
          * @summary List NFTs by contract address
@@ -8626,6 +8752,32 @@ const NftsApiAxiosParamCreator = function (configuration) {
 const NftsApiFp = function (configuration) {
     const localVarAxiosParamCreator = NftsApiAxiosParamCreator(configuration);
     return {
+        /**
+         * [Experimental] Create a mint request to mint a set of NFTs for a given collection
+         * @summary [Experimental] Mint NFTs
+         * @param {string} contractAddress The address of contract
+         * @param {string} chainName The name of chain
+         * @param {CreateMintRequestRequest} createMintRequestRequest the request body
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createMintRequest(contractAddress, chainName, createMintRequestRequest, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createMintRequest(contractAddress, chainName, createMintRequestRequest, options);
+            return createRequestFunction$2(localVarAxiosArgs, globalAxios$1, BASE_PATH$2, configuration);
+        },
+        /**
+         * [Experimental] Retrieve the status of a mint request identified by its reference_id
+         * @summary [Experimental] Get mint request by reference ID
+         * @param {string} contractAddress The address of contract
+         * @param {string} chainName The name of chain
+         * @param {string} referenceId The ID of the mint request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getMintRequest(contractAddress, chainName, referenceId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getMintRequest(contractAddress, chainName, referenceId, options);
+            return createRequestFunction$2(localVarAxiosArgs, globalAxios$1, BASE_PATH$2, configuration);
+        },
         /**
          * Get NFT by token ID
          * @summary Get NFT by token ID
@@ -8653,6 +8805,21 @@ const NftsApiFp = function (configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listAllNFTs(chainName, fromUpdatedAt, pageCursor, pageSize, options);
             return createRequestFunction$2(localVarAxiosArgs, globalAxios$1, BASE_PATH$2, configuration);
         },
+        /**
+         * [Experimental] Retrieve the status of all mints for a given contract address
+         * @summary [Experimental] List mint requests
+         * @param {string} contractAddress The address of contract
+         * @param {string} chainName The name of chain
+         * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+         * @param {number} [pageSize] Maximum number of items to return
+         * @param {MintRequestStatus} [status] The status of the mint request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listMintRequests(contractAddress, chainName, pageCursor, pageSize, status, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listMintRequests(contractAddress, chainName, pageCursor, pageSize, status, options);
+            return createRequestFunction$2(localVarAxiosArgs, globalAxios$1, BASE_PATH$2, configuration);
+        },
         /**
          * List NFTs by contract address
          * @summary List NFTs by contract address
@@ -8693,6 +8860,26 @@ const NftsApiFp = function (configuration) {
 const NftsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = NftsApiFp(configuration);
     return {
+        /**
+         * [Experimental] Create a mint request to mint a set of NFTs for a given collection
+         * @summary [Experimental] Mint NFTs
+         * @param {NftsApiCreateMintRequestRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createMintRequest(requestParameters, options) {
+            return localVarFp.createMintRequest(requestParameters.contractAddress, requestParameters.chainName, requestParameters.createMintRequestRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * [Experimental] Retrieve the status of a mint request identified by its reference_id
+         * @summary [Experimental] Get mint request by reference ID
+         * @param {NftsApiGetMintRequestRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMintRequest(requestParameters, options) {
+            return localVarFp.getMintRequest(requestParameters.contractAddress, requestParameters.chainName, requestParameters.referenceId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get NFT by token ID
          * @summary Get NFT by token ID
@@ -8713,6 +8900,16 @@ const NftsApiFactory = function (configuration, basePath, axios) {
         listAllNFTs(requestParameters, options) {
             return localVarFp.listAllNFTs(requestParameters.chainName, requestParameters.fromUpdatedAt, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(axios, basePath));
         },
+        /**
+         * [Experimental] Retrieve the status of all mints for a given contract address
+         * @summary [Experimental] List mint requests
+         * @param {NftsApiListMintRequestsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMintRequests(requestParameters, options) {
+            return localVarFp.listMintRequests(requestParameters.contractAddress, requestParameters.chainName, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.status, options).then((request) => request(axios, basePath));
+        },
         /**
          * List NFTs by contract address
          * @summary List NFTs by contract address
@@ -8742,6 +8939,28 @@ const NftsApiFactory = function (configuration, basePath, axios) {
  * @extends {BaseAPI}
  */
 class NftsApi extends BaseAPI$2 {
+    /**
+     * [Experimental] Create a mint request to mint a set of NFTs for a given collection
+     * @summary [Experimental] Mint NFTs
+     * @param {NftsApiCreateMintRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftsApi
+     */
+    createMintRequest(requestParameters, options) {
+        return NftsApiFp(this.configuration).createMintRequest(requestParameters.contractAddress, requestParameters.chainName, requestParameters.createMintRequestRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * [Experimental] Retrieve the status of a mint request identified by its reference_id
+     * @summary [Experimental] Get mint request by reference ID
+     * @param {NftsApiGetMintRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftsApi
+     */
+    getMintRequest(requestParameters, options) {
+        return NftsApiFp(this.configuration).getMintRequest(requestParameters.contractAddress, requestParameters.chainName, requestParameters.referenceId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Get NFT by token ID
      * @summary Get NFT by token ID
@@ -8764,6 +8983,17 @@ class NftsApi extends BaseAPI$2 {
     listAllNFTs(requestParameters, options) {
         return NftsApiFp(this.configuration).listAllNFTs(requestParameters.chainName, requestParameters.fromUpdatedAt, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * [Experimental] Retrieve the status of all mints for a given contract address
+     * @summary [Experimental] List mint requests
+     * @param {NftsApiListMintRequestsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftsApi
+     */
+    listMintRequests(requestParameters, options) {
+        return NftsApiFp(this.configuration).listMintRequests(requestParameters.contractAddress, requestParameters.chainName, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.status, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * List NFTs by contract address
      * @summary List NFTs by contract address
@@ -11298,7 +11528,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.10.0-alpha.1' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.11.0' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -11370,7 +11600,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.10.0-alpha.1',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.11.0',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -11631,6 +11861,51 @@ class BlockchainData {
             throw formatError(err);
         });
     }
+    /**
+     * Create a mint request to mint a set of NFTs for a given collection
+     * @experimental
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the remaining rate limits
+     * @throws {@link index.APIError}
+     */
+    async createMintRequest(request) {
+        return await this.nfts
+            .createMintRequest(request)
+            .then((res) => res.data)
+            .catch((err) => {
+            throw formatError(err);
+        });
+    }
+    /**
+     * List all mint requests for a given contract address
+     * @experimental
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of mint requests
+     * @throws {@link index.APIError}
+     */
+    async listMintRequests(request) {
+        return await this.nfts
+            .listMintRequests(request)
+            .then((res) => res.data)
+            .catch((err) => {
+            throw formatError(err);
+        });
+    }
+    /**
+     * Retrieve the status of a single mint request identified by its reference ID
+     * @experimental
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a single mint request
+     * @throws {@link index.APIError}
+     */
+    async getMintRequest(request) {
+        return await this.nfts
+            .getMintRequest(request)
+            .then((res) => res.data)
+            .catch((err) => {
+            throw formatError(err);
+        });
+    }
     /**
      * List NFT owners by token ID
      * @param request - the request object containing the parameters to be provided in the API request
@@ -11803,7 +12078,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.10.0-alpha.1',
+    sdkVersion: 'ts-immutable-sdk-1.11.0',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -37485,7 +37760,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.10.0-alpha.1';
+const SDK_VERSION = '1.11.0';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -42655,7 +42930,7 @@ const IMMUTABLE_ZKVEM_GAS_OVERRIDES = {
     maxPriorityFeePerGas: ethers.BigNumber.from(10e9),
 };
 
-const SDK_VERSION_MARKER = '1.10.0-alpha.1';
+const SDK_VERSION_MARKER = '1.11.0';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;