@imtbl/sdk 0.23.2 → 0.24.0-alpha.1

package/dist/blockchain_data.js

@@ -946,6 +946,46 @@ const MetadataApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * refresh metadata of a list of nfts
+         * @summary refresh the metedata data of a list of nfts by token id
+         * @param {string} contractAddress The address of contract
+         * @param {string} chainName The name of chain
+         * @param {RefreshNFTMetadataByTokenIDRequest} refreshNFTMetadataByTokenIDRequest the request body
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        refreshNFTMetadataByTokenID: async (contractAddress, chainName, refreshNFTMetadataByTokenIDRequest, options = {}) => {
+            // verify required parameter 'contractAddress' is not null or undefined
+            assertParamExists('refreshNFTMetadataByTokenID', 'contractAddress', contractAddress);
+            // verify required parameter 'chainName' is not null or undefined
+            assertParamExists('refreshNFTMetadataByTokenID', 'chainName', chainName);
+            // verify required parameter 'refreshNFTMetadataByTokenIDRequest' is not null or undefined
+            assertParamExists('refreshNFTMetadataByTokenID', 'refreshNFTMetadataByTokenIDRequest', refreshNFTMetadataByTokenIDRequest);
+            const localVarPath = `/v1/chains/{chain_name}/collections/{contract_address}/nfts/refresh-metadata`
+                .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);
+            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(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            localVarRequestOptions.data = serializeDataIfNeeded(refreshNFTMetadataByTokenIDRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
     };
 };
 /**
@@ -980,6 +1020,19 @@ const MetadataApiFp = function (configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.refreshMetadataByID(chainName, contractAddress, refreshMetadataByIDRequest, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * refresh metadata of a list of nfts
+         * @summary refresh the metedata data of a list of nfts by token id
+         * @param {string} contractAddress The address of contract
+         * @param {string} chainName The name of chain
+         * @param {RefreshNFTMetadataByTokenIDRequest} refreshNFTMetadataByTokenIDRequest the request body
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async refreshNFTMetadataByTokenID(contractAddress, chainName, refreshNFTMetadataByTokenIDRequest, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.refreshNFTMetadataByTokenID(contractAddress, chainName, refreshNFTMetadataByTokenIDRequest, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
     };
 };
 /**
@@ -1012,6 +1065,18 @@ const MetadataApiFactory = function (configuration, basePath, axios) {
         refreshMetadataByID(chainName, contractAddress, refreshMetadataByIDRequest, options) {
             return localVarFp.refreshMetadataByID(chainName, contractAddress, refreshMetadataByIDRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * refresh metadata of a list of nfts
+         * @summary refresh the metedata data of a list of nfts by token id
+         * @param {string} contractAddress The address of contract
+         * @param {string} chainName The name of chain
+         * @param {RefreshNFTMetadataByTokenIDRequest} refreshNFTMetadataByTokenIDRequest the request body
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        refreshNFTMetadataByTokenID(contractAddress, chainName, refreshNFTMetadataByTokenIDRequest, options) {
+            return localVarFp.refreshNFTMetadataByTokenID(contractAddress, chainName, refreshNFTMetadataByTokenIDRequest, options).then((request) => request(axios, basePath));
+        },
     };
 };
 /**
@@ -1042,6 +1107,17 @@ class MetadataApi extends BaseAPI {
     refreshMetadataByID(requestParameters, options) {
         return MetadataApiFp(this.configuration).refreshMetadataByID(requestParameters.chainName, requestParameters.contractAddress, requestParameters.refreshMetadataByIDRequest, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * refresh metadata of a list of nfts
+     * @summary refresh the metedata data of a list of nfts by token id
+     * @param {MetadataApiRefreshNFTMetadataByTokenIDRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataApi
+     */
+    refreshNFTMetadataByTokenID(requestParameters, options) {
+        return MetadataApiFp(this.configuration).refreshNFTMetadataByTokenID(requestParameters.contractAddress, requestParameters.chainName, requestParameters.refreshNFTMetadataByTokenIDRequest, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 
 /* tslint:disable */
@@ -2857,29 +2933,24 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.23.2',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.24.0-alpha.1',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
  * other than the production and sandbox defined below.
  */
-const createAPIConfiguration = ({ basePath, headers: baseHeaders, }) => {
+const createAPIConfiguration = ({ baseConfig, basePath, headers: baseHeaders, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
     }
     const headers = { ...(baseHeaders || {}), ...defaultHeaders };
     const configParams = {
+        ...baseConfig,
         basePath,
         baseOptions: { headers },
     };
     return new index.Configuration(configParams);
 };
-const production = () => createAPIConfiguration({
-    basePath: 'https://indexer-mr.imtbl.com',
-});
-const sandbox = () => createAPIConfiguration({
-    basePath: 'https://api.sandbox.immutable.com',
-});
 class BlockchainDataConfiguration {
     apiConfig;
     baseConfig;
@@ -2891,15 +2962,24 @@ class BlockchainDataConfiguration {
         else {
             switch (baseConfig.environment) {
                 case Environment.SANDBOX: {
-                    this.apiConfig = sandbox();
+                    this.apiConfig = createAPIConfiguration({
+                        basePath: 'https://api.sandbox.immutable.com',
+                        baseConfig,
+                    });
                     break;
                 }
                 case Environment.PRODUCTION: {
-                    this.apiConfig = production();
+                    this.apiConfig = createAPIConfiguration({
+                        basePath: 'https://indexer-mr.imtbl.com',
+                        baseConfig,
+                    });
                     break;
                 }
                 default: {
-                    this.apiConfig = sandbox();
+                    this.apiConfig = createAPIConfiguration({
+                        basePath: 'https://api.sandbox.immutable.com',
+                        baseConfig,
+                    });
                 }
             }
         }
@@ -2949,6 +3029,7 @@ class BlockchainData {
     nfts;
     nftOwners;
     tokens;
+    metadata;
     constructor(moduleConfig) {
         this.config = new BlockchainDataConfiguration(moduleConfig);
         this.activities = new index.ActivitiesApi(this.config.apiConfig);
@@ -2957,6 +3038,7 @@ class BlockchainData {
         this.nfts = new index.NftsApi(this.config.apiConfig);
         this.nftOwners = new index.NftOwnersApi(this.config.apiConfig);
         this.tokens = new index.TokensApi(this.config.apiConfig);
+        this.metadata = new index.MetadataApi(this.config.apiConfig);
     }
     /**
      * List all activities
@@ -3126,6 +3208,48 @@ class BlockchainData {
             throw formatError(err);
         });
     }
+    /**
+     * Refresh collection metadata
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the updated collection
+     * @throws {@link index.APIError}
+     */
+    async refreshCollectionMetadata(request) {
+        return await this.collections
+            .refreshCollectionMetadata(request)
+            .then((res) => res.data)
+            .catch((err) => {
+            throw formatError(err);
+        });
+    }
+    /**
+     * Refresh metadata for specific NFTs
+     * @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 refreshNFTMetadata(request) {
+        return await this.metadata
+            .refreshNFTMetadataByTokenID(request)
+            .then((res) => res.data)
+            .catch((err) => {
+            throw formatError(err);
+        });
+    }
+    /**
+     * Refresh metadata by ID. This will refresh metadata for all NFTs that reference the given metadata ID.
+     * @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 refreshStackedMetadata(request) {
+        return await this.metadata
+            .refreshMetadataByID(request)
+            .then((res) => res.data)
+            .catch((err) => {
+            throw formatError(err);
+        });
+    }
 }
 
 export { APIError, BlockchainData };