@imtbl/sdk 0.19.0-alpha → 0.20.1-alpha.1

package/dist/blockchain_data.d.ts

@@ -1014,6 +1014,56 @@ interface GetCollectionResult {
     'result': Collection;
 }
 
+/**
+ * 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.
+ */
+/**
+ * @type NFTMetadataAttributeValue
+ * The metadata trait value
+ * @export
+ */
+type NFTMetadataAttributeValue = boolean | number | string;
+
+/**
+ * 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 NFTMetadataAttribute
+ */
+interface NFTMetadataAttribute {
+    /**
+     * The metadata trait type
+     * @type {string}
+     * @memberof NFTMetadataAttribute
+     */
+    'trait_type': string;
+    /**
+     *
+     * @type {NFTMetadataAttributeValue}
+     * @memberof NFTMetadataAttribute
+     */
+    'value': NFTMetadataAttributeValue;
+}
+
 /**
  * Immutable zkEVM API
  * Immutable Multi Rollup API
@@ -1062,6 +1112,12 @@ interface NFT {
      * @memberof NFT
      */
     'metadata_synced_at': string | null;
+    /**
+     * The id of the metadata of this NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'metadata_id'?: string | null;
     /**
      * The name of the NFT
      * @type {string}
@@ -1106,56 +1162,6 @@ interface NFT {
     'mint_activity_id': string | null;
 }
 
-/**
- * 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.
- */
-/**
- * @type NFTMetadataAttributeValue
- * The metadata trait value
- * @export
- */
-type NFTMetadataAttributeValue = boolean | number | string;
-
-/**
- * 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 NFTMetadataAttribute
- */
-interface NFTMetadataAttribute {
-    /**
-     * The metadata trait type
-     * @type {string}
-     * @memberof NFTMetadataAttribute
-     */
-    'trait_type': string;
-    /**
-     *
-     * @type {NFTMetadataAttributeValue}
-     * @memberof NFTMetadataAttribute
-     */
-    'value': NFTMetadataAttributeValue;
-}
-
 /**
  * Immutable zkEVM API
  * Immutable Multi Rollup API

package/dist/blockchain_data.js

@@ -77,6 +77,18 @@ const assertParamExists = function (functionName, paramName, paramValue) {
         throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
     }
 };
+/**
+ *
+ * @export
+ */
+const setApiKeyToObject = async function (object, keyParamName, configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+};
 /**
  *
  * @export
@@ -626,6 +638,46 @@ const CollectionsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Refresh collection metadata
+         * @summary Refresh collection metadata
+         * @param {string} contractAddress The address contract
+         * @param {string} chainName The name of chain
+         * @param {RefreshCollectionMetadataRequest} refreshCollectionMetadataRequest The request body
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        refreshCollectionMetadata: async (contractAddress, chainName, refreshCollectionMetadataRequest, options = {}) => {
+            // verify required parameter 'contractAddress' is not null or undefined
+            assertParamExists('refreshCollectionMetadata', 'contractAddress', contractAddress);
+            // verify required parameter 'chainName' is not null or undefined
+            assertParamExists('refreshCollectionMetadata', 'chainName', chainName);
+            // verify required parameter 'refreshCollectionMetadataRequest' is not null or undefined
+            assertParamExists('refreshCollectionMetadata', 'refreshCollectionMetadataRequest', refreshCollectionMetadataRequest);
+            const localVarPath = `/v1/chains/{chain_name}/collections/{contract_address}/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(refreshCollectionMetadataRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
     };
 };
 /**
@@ -674,6 +726,19 @@ const CollectionsApiFp = function (configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listCollectionsByNFTOwner(accountAddress, chainName, pageCursor, pageSize, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Refresh collection metadata
+         * @summary Refresh collection metadata
+         * @param {string} contractAddress The address contract
+         * @param {string} chainName The name of chain
+         * @param {RefreshCollectionMetadataRequest} refreshCollectionMetadataRequest The request body
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async refreshCollectionMetadata(contractAddress, chainName, refreshCollectionMetadataRequest, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.refreshCollectionMetadata(contractAddress, chainName, refreshCollectionMetadataRequest, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
     };
 };
 /**
@@ -719,6 +784,18 @@ const CollectionsApiFactory = function (configuration, basePath, axios) {
         listCollectionsByNFTOwner(accountAddress, chainName, pageCursor, pageSize, options) {
             return localVarFp.listCollectionsByNFTOwner(accountAddress, chainName, pageCursor, pageSize, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Refresh collection metadata
+         * @summary Refresh collection metadata
+         * @param {string} contractAddress The address contract
+         * @param {string} chainName The name of chain
+         * @param {RefreshCollectionMetadataRequest} refreshCollectionMetadataRequest The request body
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        refreshCollectionMetadata(contractAddress, chainName, refreshCollectionMetadataRequest, options) {
+            return localVarFp.refreshCollectionMetadata(contractAddress, chainName, refreshCollectionMetadataRequest, options).then((request) => request(axios, basePath));
+        },
     };
 };
 /**
@@ -761,6 +838,210 @@ class CollectionsApi extends BaseAPI {
     listCollectionsByNFTOwner(requestParameters, options) {
         return CollectionsApiFp(this.configuration).listCollectionsByNFTOwner(requestParameters.accountAddress, requestParameters.chainName, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Refresh collection metadata
+     * @summary Refresh collection metadata
+     * @param {CollectionsApiRefreshCollectionMetadataRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionsApi
+     */
+    refreshCollectionMetadata(requestParameters, options) {
+        return CollectionsApiFp(this.configuration).refreshCollectionMetadata(requestParameters.contractAddress, requestParameters.chainName, requestParameters.refreshCollectionMetadataRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+/**
+ * MetadataApi - axios parameter creator
+ * @export
+ */
+const MetadataApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Get a single metadata by ID
+         * @summary Get a single metadata by ID
+         * @param {string} chainName The name of chain
+         * @param {string} contractAddress The address of metadata contract
+         * @param {string} metadataId The id of the metadata
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMetadata: async (chainName, contractAddress, metadataId, options = {}) => {
+            // verify required parameter 'chainName' is not null or undefined
+            assertParamExists('getMetadata', 'chainName', chainName);
+            // verify required parameter 'contractAddress' is not null or undefined
+            assertParamExists('getMetadata', 'contractAddress', contractAddress);
+            // verify required parameter 'metadataId' is not null or undefined
+            assertParamExists('getMetadata', 'metadataId', metadataId);
+            const localVarPath = `/v1/chains/{chain_name}/collections/{contract_address}/metadata/{metadata_id}`
+                .replace(`{${"chain_name"}}`, encodeURIComponent(String(chainName)))
+                .replace(`{${"contract_address"}}`, encodeURIComponent(String(contractAddress)))
+                .replace(`{${"metadata_id"}}`, encodeURIComponent(String(metadataId)));
+            // 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: 'GET', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Refresh shared metadata for a collection
+         * @param {string} chainName The name of chain
+         * @param {string} contractAddress Contract address
+         * @param {RefreshMetadataByIDRequest} refreshMetadataByIDRequest NFT Metadata Refresh Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        refreshMetadataByID: async (chainName, contractAddress, refreshMetadataByIDRequest, options = {}) => {
+            // verify required parameter 'chainName' is not null or undefined
+            assertParamExists('refreshMetadataByID', 'chainName', chainName);
+            // verify required parameter 'contractAddress' is not null or undefined
+            assertParamExists('refreshMetadataByID', 'contractAddress', contractAddress);
+            // verify required parameter 'refreshMetadataByIDRequest' is not null or undefined
+            assertParamExists('refreshMetadataByID', 'refreshMetadataByIDRequest', refreshMetadataByIDRequest);
+            const localVarPath = `/v1/chains/{chain_name}/collections/{contract_address}/metadata/refresh-metadata`
+                .replace(`{${"chain_name"}}`, encodeURIComponent(String(chainName)))
+                .replace(`{${"contract_address"}}`, encodeURIComponent(String(contractAddress)));
+            // 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(refreshMetadataByIDRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    };
+};
+/**
+ * MetadataApi - functional programming interface
+ * @export
+ */
+const MetadataApiFp = function (configuration) {
+    const localVarAxiosParamCreator = MetadataApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Get a single metadata by ID
+         * @summary Get a single metadata by ID
+         * @param {string} chainName The name of chain
+         * @param {string} contractAddress The address of metadata contract
+         * @param {string} metadataId The id of the metadata
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getMetadata(chainName, contractAddress, metadataId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getMetadata(chainName, contractAddress, metadataId, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Refresh shared metadata for a collection
+         * @param {string} chainName The name of chain
+         * @param {string} contractAddress Contract address
+         * @param {RefreshMetadataByIDRequest} refreshMetadataByIDRequest NFT Metadata Refresh Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async refreshMetadataByID(chainName, contractAddress, refreshMetadataByIDRequest, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.refreshMetadataByID(chainName, contractAddress, refreshMetadataByIDRequest, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    };
+};
+/**
+ * MetadataApi - factory interface
+ * @export
+ */
+const MetadataApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = MetadataApiFp(configuration);
+    return {
+        /**
+         * Get a single metadata by ID
+         * @summary Get a single metadata by ID
+         * @param {string} chainName The name of chain
+         * @param {string} contractAddress The address of metadata contract
+         * @param {string} metadataId The id of the metadata
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMetadata(chainName, contractAddress, metadataId, options) {
+            return localVarFp.getMetadata(chainName, contractAddress, metadataId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Refresh shared metadata for a collection
+         * @param {string} chainName The name of chain
+         * @param {string} contractAddress Contract address
+         * @param {RefreshMetadataByIDRequest} refreshMetadataByIDRequest NFT Metadata Refresh Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        refreshMetadataByID(chainName, contractAddress, refreshMetadataByIDRequest, options) {
+            return localVarFp.refreshMetadataByID(chainName, contractAddress, refreshMetadataByIDRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * MetadataApi - object-oriented interface
+ * @export
+ * @class MetadataApi
+ * @extends {BaseAPI}
+ */
+class MetadataApi extends BaseAPI {
+    /**
+     * Get a single metadata by ID
+     * @summary Get a single metadata by ID
+     * @param {MetadataApiGetMetadataRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataApi
+     */
+    getMetadata(requestParameters, options) {
+        return MetadataApiFp(this.configuration).getMetadata(requestParameters.chainName, requestParameters.contractAddress, requestParameters.metadataId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Refresh shared metadata for a collection
+     * @param {MetadataApiRefreshMetadataByIDRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataApi
+     */
+    refreshMetadataByID(requestParameters, options) {
+        return MetadataApiFp(this.configuration).refreshMetadataByID(requestParameters.chainName, requestParameters.contractAddress, requestParameters.refreshMetadataByIDRequest, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 
 /* tslint:disable */
@@ -1401,7 +1682,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
          * @param {string} chainName
          * @param {string} [accountAddress]
          * @param {number} [pageSize] Maximum number of trades to return per page
-         * @param {'created_at'} [sortBy] Trade field to sort by
+         * @param {'indexed_at'} [sortBy] Trade field to sort by
          * @param {'asc' | 'desc'} [sortDirection] Ascending or descending direction for sort
          * @param {string} [pageCursor] Page cursor to retrieve previous or next page. Use the value returned in the response.
          * @param {*} [options] Override http request option.
@@ -1526,7 +1807,7 @@ const OrdersApiFp = function (configuration) {
          * @param {string} chainName
          * @param {string} [accountAddress]
          * @param {number} [pageSize] Maximum number of trades to return per page
-         * @param {'created_at'} [sortBy] Trade field to sort by
+         * @param {'indexed_at'} [sortBy] Trade field to sort by
          * @param {'asc' | 'desc'} [sortDirection] Ascending or descending direction for sort
          * @param {string} [pageCursor] Page cursor to retrieve previous or next page. Use the value returned in the response.
          * @param {*} [options] Override http request option.
@@ -1613,7 +1894,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
          * @param {string} chainName
          * @param {string} [accountAddress]
          * @param {number} [pageSize] Maximum number of trades to return per page
-         * @param {'created_at'} [sortBy] Trade field to sort by
+         * @param {'indexed_at'} [sortBy] Trade field to sort by
          * @param {'asc' | 'desc'} [sortDirection] Ascending or descending direction for sort
          * @param {string} [pageCursor] Page cursor to retrieve previous or next page. Use the value returned in the response.
          * @param {*} [options] Override http request option.
@@ -2519,6 +2800,10 @@ var index = /*#__PURE__*/Object.freeze({
     ERC20ItemItemTypeEnum: ERC20ItemItemTypeEnum,
     ERC721ItemItemTypeEnum: ERC721ItemItemTypeEnum,
     FeeFeeTypeEnum: FeeFeeTypeEnum,
+    MetadataApi: MetadataApi,
+    MetadataApiAxiosParamCreator: MetadataApiAxiosParamCreator,
+    MetadataApiFactory: MetadataApiFactory,
+    MetadataApiFp: MetadataApiFp,
     NFTContractType: NFTContractType,
     NativeItemItemTypeEnum: NativeItemItemTypeEnum,
     NftOwnersApi: NftOwnersApi,
@@ -2572,7 +2857,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.19.0-alpha',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.20.1-alpha.1',
 };
 /**
  * createAPIConfiguration to create a custom Configuration