@imtbl/sdk 0.24.1 → 0.26.0

package/dist/blockchain_data.d.ts

@@ -1125,6 +1125,124 @@ interface NFTMetadataAttribute {
     'value': NFTMetadataAttributeValue;
 }
 
+/**
+ * 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 Metadata
+ */
+interface Metadata {
+    /**
+     * Metadata ID in UUIDv4 format
+     * @type {string}
+     * @memberof Metadata
+     */
+    'id': string;
+    /**
+     *
+     * @type {Chain}
+     * @memberof Metadata
+     */
+    'chain': Chain;
+    /**
+     * The contract address of the metadata
+     * @type {string}
+     * @memberof Metadata
+     */
+    'contract_address': string;
+    /**
+     * When the metadata was created
+     * @type {string}
+     * @memberof Metadata
+     */
+    'created_at': string;
+    /**
+     * When the metadata was last updated
+     * @type {string}
+     * @memberof Metadata
+     */
+    'updated_at': string | null;
+    /**
+     * The name of the NFT
+     * @type {string}
+     * @memberof Metadata
+     */
+    'name': string | null;
+    /**
+     * The description of the NFT
+     * @type {string}
+     * @memberof Metadata
+     */
+    'description': string | null;
+    /**
+     * The image url of the NFT
+     * @type {string}
+     * @memberof Metadata
+     */
+    'image': string | null;
+    /**
+     * The external website link of NFT
+     * @type {string}
+     * @memberof Metadata
+     */
+    'external_url'?: string | null;
+    /**
+     * The animation url of the NFT
+     * @type {string}
+     * @memberof Metadata
+     */
+    'animation_url': string | null;
+    /**
+     * The youtube URL of NFT
+     * @type {string}
+     * @memberof Metadata
+     */
+    'youtube_url': string | null;
+    /**
+     * List of Metadata attributes
+     * @type {Array<NFTMetadataAttribute>}
+     * @memberof Metadata
+     */
+    '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.
+ */
+
+/**
+ * Single metadata
+ * @export
+ * @interface GetMetadataResult
+ */
+interface GetMetadataResult {
+    /**
+     *
+     * @type {Metadata}
+     * @memberof GetMetadataResult
+     */
+    'result': Metadata;
+}
+
 /**
  * Immutable zkEVM API
  * Immutable Multi Rollup API
@@ -1167,6 +1285,12 @@ interface NFT {
      * @memberof NFT
      */
     'indexed_at': string;
+    /**
+     * When the NFT owner was last updated
+     * @type {string}
+     * @memberof NFT
+     */
+    'updated_at': string;
     /**
      * When NFT metadata was last synced
      * @type {string}
@@ -1354,6 +1478,12 @@ interface Token {
      * @memberof Token
      */
     'name': string | null;
+    /**
+     * When the collection was last updated
+     * @type {string}
+     * @memberof Token
+     */
+    'updated_at': string;
 }
 
 /**
@@ -1509,6 +1639,38 @@ interface ListCollectionsResult {
     '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 ListMetadataResult
+ */
+interface ListMetadataResult {
+    /**
+     * List of metadata
+     * @type {Array<Metadata>}
+     * @memberof ListMetadataResult
+     */
+    'result': Array<Metadata>;
+    /**
+     *
+     * @type {Page}
+     * @memberof ListMetadataResult
+     */
+    'page': Page;
+}
+
 /**
  * Immutable zkEVM API
  * Immutable Multi Rollup API
@@ -1557,6 +1719,12 @@ interface NFTOwner {
      * @memberof NFTOwner
      */
     'quantity': string;
+    /**
+     * When the NFT owner was last updated
+     * @type {string}
+     * @memberof NFTOwner
+     */
+    'updated_at'?: string;
 }
 
 /**
@@ -2100,6 +2268,12 @@ interface CollectionsApiListCollectionsRequest {
      * @memberof CollectionsApiListCollections
      */
     readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof CollectionsApiListCollections
+     */
+    readonly fromUpdatedAt?: string;
     /**
      * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
      * @type {string}
@@ -2170,6 +2344,68 @@ interface CollectionsApiRefreshCollectionMetadataRequest {
     readonly refreshCollectionMetadataRequest: RefreshCollectionMetadataRequest;
 }
 
+/**
+ * Request parameters for getMetadata operation in MetadataApi.
+ * @export
+ * @interface MetadataApiGetMetadataRequest
+ */
+interface MetadataApiGetMetadataRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof MetadataApiGetMetadata
+     */
+    readonly chainName: string;
+    /**
+     * The address of metadata contract
+     * @type {string}
+     * @memberof MetadataApiGetMetadata
+     */
+    readonly contractAddress: string;
+    /**
+     * The id of the metadata
+     * @type {string}
+     * @memberof MetadataApiGetMetadata
+     */
+    readonly metadataId: string;
+}
+/**
+ * Request parameters for listMetadata operation in MetadataApi.
+ * @export
+ * @interface MetadataApiListMetadataRequest
+ */
+interface MetadataApiListMetadataRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof MetadataApiListMetadata
+     */
+    readonly chainName: string;
+    /**
+     * The address of metadata contract
+     * @type {string}
+     * @memberof MetadataApiListMetadata
+     */
+    readonly contractAddress: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof MetadataApiListMetadata
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof MetadataApiListMetadata
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof MetadataApiListMetadata
+     */
+    readonly pageSize?: number;
+}
 /**
  * Request parameters for refreshMetadataByID operation in MetadataApi.
  * @export
@@ -2258,6 +2494,43 @@ interface NftOwnersApiListNFTOwnersRequest {
      */
     readonly pageSize?: number;
 }
+/**
+ * Request parameters for listOwnersByContractAddress operation in NftOwnersApi.
+ * @export
+ * @interface NftOwnersApiListOwnersByContractAddressRequest
+ */
+interface NftOwnersApiListOwnersByContractAddressRequest {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof NftOwnersApiListOwnersByContractAddress
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftOwnersApiListOwnersByContractAddress
+     */
+    readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof NftOwnersApiListOwnersByContractAddress
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof NftOwnersApiListOwnersByContractAddress
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof NftOwnersApiListOwnersByContractAddress
+     */
+    readonly pageSize?: number;
+}
 
 /**
  * Request parameters for getNFT operation in NftsApi.
@@ -2284,6 +2557,68 @@ interface NftsApiGetNFTRequest {
      */
     readonly chainName: string;
 }
+/**
+ * Request parameters for listAllNFTOwners operation in NftsApi.
+ * @export
+ * @interface NftsApiListAllNFTOwnersRequest
+ */
+interface NftsApiListAllNFTOwnersRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftsApiListAllNFTOwners
+     */
+    readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof NftsApiListAllNFTOwners
+     */
+    readonly fromUpdatedAt: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof NftsApiListAllNFTOwners
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof NftsApiListAllNFTOwners
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listAllNFTs operation in NftsApi.
+ * @export
+ * @interface NftsApiListAllNFTsRequest
+ */
+interface NftsApiListAllNFTsRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftsApiListAllNFTs
+     */
+    readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof NftsApiListAllNFTs
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof NftsApiListAllNFTs
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof NftsApiListAllNFTs
+     */
+    readonly pageSize?: number;
+}
 /**
  * Request parameters for listNFTs operation in NftsApi.
  * @export
@@ -2302,6 +2637,12 @@ interface NftsApiListNFTsRequest {
      * @memberof NftsApiListNFTs
      */
     readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof NftsApiListNFTs
+     */
+    readonly fromUpdatedAt?: string;
     /**
      * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
      * @type {string}
@@ -2384,6 +2725,12 @@ interface TokensApiListERC20TokensRequest {
      * @memberof TokensApiListERC20Tokens
      */
     readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof TokensApiListERC20Tokens
+     */
+    readonly fromUpdatedAt?: string;
     /**
      * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
      * @type {string}
@@ -2520,6 +2867,13 @@ declare class BlockchainData {
      * @throws {@link index.APIError}
      */
     listNFTsByAccountAddress(request: NftsApiListNFTsByAccountAddressRequest): Promise<ListNFTsResult>;
+    /**
+     * List All NFTs on a chain
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFTs
+     * @throws {@link index.APIError}
+     */
+    listAllNFTs(request: NftsApiListAllNFTsRequest): Promise<ListNFTsResult>;
     /**
      * List NFT owners by token ID
      * @param request - the request object containing the parameters to be provided in the API request
@@ -2527,6 +2881,20 @@ declare class BlockchainData {
      * @throws {@link index.APIError}
      */
     listNFTOwners(request: NftOwnersApiListNFTOwnersRequest): Promise<ListNFTOwnersResult>;
+    /**
+     * List NFT owners by contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFT owners
+     * @throws {@link index.APIError}
+     */
+    listNFTOwnersByContractAddress(request: NftOwnersApiListOwnersByContractAddressRequest): Promise<ListNFTOwnersResult>;
+    /**
+     * List All NFT owners on a chain
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFT owners
+     * @throws {@link index.APIError}
+     */
+    listAllNFTOwners(request: NftsApiListAllNFTOwnersRequest): Promise<ListNFTOwnersResult>;
     /**
      * List ERC20 Token contracts
      * @param request - the request object containing the parameters to be provided in the API request
@@ -2541,6 +2909,20 @@ declare class BlockchainData {
      * @throws {@link index.APIError}
      */
     getToken(request: TokensApiGetERC20TokenRequest): Promise<GetTokenResult>;
+    /**
+     * Get metadata by ID
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a single Metadata
+     * @throws {@link index.APIError}
+     */
+    getMetadata(request: MetadataApiGetMetadataRequest): Promise<GetMetadataResult>;
+    /**
+     * List NFT Metadata by contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of Metadata
+     * @throws {@link index.APIError}
+     */
+    listNFTMetadataByContractAddress(request: MetadataApiListMetadataRequest): Promise<ListMetadataResult>;
     /**
      * Refresh collection metadata
      * @param request - the request object containing the parameters to be provided in the API request