@imtbl/sdk 0.23.0-alpha → 0.23.2-alpha.1

package/dist/blockchain_data.d.ts

@@ -962,6 +962,67 @@ interface Collection {
     'last_metadata_synced_at': 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.
+ */
+/**
+ *
+ * @export
+ * @interface CollectionMetadata
+ */
+interface CollectionMetadata {
+    /**
+     * The name of the collection
+     * @type {string}
+     * @memberof CollectionMetadata
+     */
+    'name': string | null;
+    /**
+     * The symbol of contract
+     * @type {string}
+     * @memberof CollectionMetadata
+     */
+    'symbol': string | null;
+    /**
+     * The description of collection
+     * @type {string}
+     * @memberof CollectionMetadata
+     */
+    'description': string | null;
+    /**
+     * The url of the collection image
+     * @type {string}
+     * @memberof CollectionMetadata
+     */
+    'image': string | null;
+    /**
+     * The url of external link
+     * @type {string}
+     * @memberof CollectionMetadata
+     */
+    'external_link': string | null;
+    /**
+     * The uri for the metadata of the collection
+     * @type {string}
+     * @memberof CollectionMetadata
+     */
+    'contract_uri': string | null;
+    /**
+     * The metadata uri for nft
+     * @type {string}
+     * @memberof CollectionMetadata
+     */
+    'base_uri': string | null;
+}
+
 /**
  * Immutable zkEVM API
  * Immutable Multi Rollup API
@@ -1594,6 +1655,313 @@ interface ListTokensResult {
     'page': Page;
 }
 
+/**
+ * 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 MetadataRefreshRateLimitResult
+ */
+interface MetadataRefreshRateLimitResult {
+    /**
+     *
+     * @type {string}
+     * @memberof MetadataRefreshRateLimitResult
+     */
+    'imx_refreshes_limit': string;
+    /**
+     *
+     * @type {string}
+     * @memberof MetadataRefreshRateLimitResult
+     */
+    'imx_refresh_limit_reset': string;
+    /**
+     *
+     * @type {string}
+     * @memberof MetadataRefreshRateLimitResult
+     */
+    'imx_remaining_refreshes': string;
+    /**
+     *
+     * @type {string}
+     * @memberof MetadataRefreshRateLimitResult
+     */
+    'retry_after': 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 RefreshCollectionMetadataRequest
+ */
+interface RefreshCollectionMetadataRequest {
+    /**
+     *
+     * @type {CollectionMetadata}
+     * @memberof RefreshCollectionMetadataRequest
+     */
+    'collection_metadata': CollectionMetadata;
+}
+
+/**
+ * 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 RefreshCollectionMetadataResult
+ */
+interface RefreshCollectionMetadataResult {
+    /**
+     *
+     * @type {string}
+     * @memberof RefreshCollectionMetadataResult
+     */
+    'contract_address': string;
+    /**
+     *
+     * @type {Chain}
+     * @memberof RefreshCollectionMetadataResult
+     */
+    'chain': Chain;
+    /**
+     *
+     * @type {CollectionMetadata}
+     * @memberof RefreshCollectionMetadataResult
+     */
+    'collection_metadata': CollectionMetadata;
+}
+
+/**
+ * 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 RefreshMetadataByIDAllOf
+ */
+interface RefreshMetadataByIDAllOf {
+    /**
+     * Metadata ID in UUIDv4 format
+     * @type {string}
+     * @memberof RefreshMetadataByIDAllOf
+     */
+    'metadata_id': 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 RefreshableNFTAttributes
+ */
+interface RefreshableNFTAttributes {
+    /**
+     * The name of the NFT
+     * @type {string}
+     * @memberof RefreshableNFTAttributes
+     */
+    'name': string | null;
+    /**
+     * The description of the NFT
+     * @type {string}
+     * @memberof RefreshableNFTAttributes
+     */
+    'description': string | null;
+    /**
+     * The image url of the NFT
+     * @type {string}
+     * @memberof RefreshableNFTAttributes
+     */
+    'image': string | null;
+    /**
+     * The external link of the NFT
+     * @type {string}
+     * @memberof RefreshableNFTAttributes
+     */
+    'external_url': string | null;
+    /**
+     * The animation url of the NFT
+     * @type {string}
+     * @memberof RefreshableNFTAttributes
+     */
+    'animation_url': string | null;
+    /**
+     * The youtube link of the NFT
+     * @type {string}
+     * @memberof RefreshableNFTAttributes
+     */
+    'youtube_url': string | null;
+    /**
+     * List of Metadata attributes
+     * @type {Array<NFTMetadataAttribute>}
+     * @memberof RefreshableNFTAttributes
+     */
+    'attributes': Array<NFTMetadataAttribute> | 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 RefreshMetadataByID
+ * @export
+ */
+type RefreshMetadataByID = RefreshMetadataByIDAllOf & RefreshableNFTAttributes;
+
+/**
+ * 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.
+ */
+
+/**
+ * Request body for refreshing metadata by id
+ * @export
+ * @interface RefreshMetadataByIDRequest
+ */
+interface RefreshMetadataByIDRequest {
+    /**
+     *
+     * @type {Array<RefreshMetadataByID>}
+     * @memberof RefreshMetadataByIDRequest
+     */
+    'metadata'?: Array<RefreshMetadataByID>;
+}
+
+/**
+ * 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 RefreshMetadataByTokenIDAllOf
+ */
+interface RefreshMetadataByTokenIDAllOf {
+    /**
+     * An `uint256` token id as string
+     * @type {string}
+     * @memberof RefreshMetadataByTokenIDAllOf
+     */
+    'token_id': 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.
+ */
+
+/**
+ * @type RefreshMetadataByTokenID
+ * @export
+ */
+type RefreshMetadataByTokenID = RefreshMetadataByTokenIDAllOf & RefreshableNFTAttributes;
+
+/**
+ * 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 RefreshNFTMetadataByTokenIDRequest
+ */
+interface RefreshNFTMetadataByTokenIDRequest {
+    /**
+     * List of nft metadata to be refreshed
+     * @type {Array<RefreshMetadataByTokenID>}
+     * @memberof RefreshNFTMetadataByTokenIDRequest
+     */
+    'nft_metadata': Array<RefreshMetadataByTokenID>;
+}
+
 /**
  * Request parameters for getActivity operation in ActivitiesApi.
  * @export
@@ -1776,6 +2144,82 @@ interface CollectionsApiListCollectionsByNFTOwnerRequest {
      */
     readonly pageSize?: number;
 }
+/**
+ * Request parameters for refreshCollectionMetadata operation in CollectionsApi.
+ * @export
+ * @interface CollectionsApiRefreshCollectionMetadataRequest
+ */
+interface CollectionsApiRefreshCollectionMetadataRequest {
+    /**
+     * The address contract
+     * @type {string}
+     * @memberof CollectionsApiRefreshCollectionMetadata
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof CollectionsApiRefreshCollectionMetadata
+     */
+    readonly chainName: string;
+    /**
+     * The request body
+     * @type {RefreshCollectionMetadataRequest}
+     * @memberof CollectionsApiRefreshCollectionMetadata
+     */
+    readonly refreshCollectionMetadataRequest: RefreshCollectionMetadataRequest;
+}
+
+/**
+ * Request parameters for refreshMetadataByID operation in MetadataApi.
+ * @export
+ * @interface MetadataApiRefreshMetadataByIDRequest
+ */
+interface MetadataApiRefreshMetadataByIDRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof MetadataApiRefreshMetadataByID
+     */
+    readonly chainName: string;
+    /**
+     * Contract address
+     * @type {string}
+     * @memberof MetadataApiRefreshMetadataByID
+     */
+    readonly contractAddress: string;
+    /**
+     * NFT Metadata Refresh Request
+     * @type {RefreshMetadataByIDRequest}
+     * @memberof MetadataApiRefreshMetadataByID
+     */
+    readonly refreshMetadataByIDRequest: RefreshMetadataByIDRequest;
+}
+/**
+ * Request parameters for refreshNFTMetadataByTokenID operation in MetadataApi.
+ * @export
+ * @interface MetadataApiRefreshNFTMetadataByTokenIDRequest
+ */
+interface MetadataApiRefreshNFTMetadataByTokenIDRequest {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof MetadataApiRefreshNFTMetadataByTokenID
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof MetadataApiRefreshNFTMetadataByTokenID
+     */
+    readonly chainName: string;
+    /**
+     * the request body
+     * @type {RefreshNFTMetadataByTokenIDRequest}
+     * @memberof MetadataApiRefreshNFTMetadataByTokenID
+     */
+    readonly refreshNFTMetadataByTokenIDRequest: RefreshNFTMetadataByTokenIDRequest;
+}
 
 /**
  * Request parameters for listNFTOwners operation in NftOwnersApi.
@@ -1993,6 +2437,7 @@ interface ModuleConfiguration<T> {
 interface APIConfigurationParams {
     basePath: string;
     headers?: Record<string, string>;
+    baseConfig?: ImmutableConfiguration;
 }
 interface BlockchainDataModuleConfiguration extends ModuleConfiguration<APIConfigurationParams> {
 }
@@ -2010,6 +2455,7 @@ declare class BlockchainData {
     private readonly nfts;
     private readonly nftOwners;
     private readonly tokens;
+    private readonly metadata;
     constructor(moduleConfig: BlockchainDataModuleConfiguration);
     /**
      * List all activities
@@ -2095,6 +2541,27 @@ declare class BlockchainData {
      * @throws {@link index.APIError}
      */
     getToken(request: TokensApiGetERC20TokenRequest): Promise<GetTokenResult>;
+    /**
+     * 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}
+     */
+    refreshCollectionMetadata(request: CollectionsApiRefreshCollectionMetadataRequest): Promise<RefreshCollectionMetadataResult>;
+    /**
+     * 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}
+     */
+    refreshNFTMetadata(request: MetadataApiRefreshNFTMetadataByTokenIDRequest): Promise<MetadataRefreshRateLimitResult>;
+    /**
+     * 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}
+     */
+    refreshStackedMetadata(request: MetadataApiRefreshMetadataByIDRequest): Promise<MetadataRefreshRateLimitResult>;
 }
 
 type ActivityType = ActivityType$1;