@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/multi-rollup/domain/metadata-search-api.d.ts

@@ -0,0 +1,316 @@
+/**
+ * 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.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../base';
+import { ListFiltersResult } from '../models';
+import { SearchNFTsResult } from '../models';
+import { SearchStacksResult } from '../models';
+/**
+ * MetadataSearchApi - axios parameter creator
+ * @export
+ */
+export declare const MetadataSearchApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get list of metadata filters
+     * @summary Get list of metadata attribute filters
+     * @param {string} chainName The name of chain
+     * @param {string} contractAddress Contract addresses for collection
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFilters: (chainName: string, contractAddress: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Search NFTs
+     * @summary Search NFTs
+     * @param {string} chainName The name of chain
+     * @param {Array<string>} contractAddress List of contract addresses to filter by
+     * @param {string} [accountAddress] Account address to filter by
+     * @param {Array<string>} [stackId] Filters NFTs that belong to any of these stacks
+     * @param {boolean} [onlyIncludeOwnerListings] Whether the listings should include only the owner created listings
+     * @param {number} [pageSize] Number of results to return per page
+     * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchNFTs: (chainName: string, contractAddress: Array<string>, accountAddress?: string, stackId?: Array<string>, onlyIncludeOwnerListings?: boolean, pageSize?: number, pageCursor?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Search NFT stacks
+     * @summary Search NFT stacks
+     * @param {string} chainName The name of chain
+     * @param {Array<string>} contractAddress List of contract addresses to filter by
+     * @param {string} [accountAddress] Account address to filter by
+     * @param {boolean} [onlyIncludeOwnerListings] Whether to the listings should include only the owner created listings
+     * @param {boolean} [onlyIfHasActiveListings] Filters results to include only stacks that have a current active listing. False and \&#39;null\&#39; return all unfiltered stacks.
+     * @param {string} [traits] JSON encoded traits to filter by. e.g. encodeURIComponent(JSON.stringify({\&quot;rarity\&quot;: {\&quot;values\&quot;: [\&quot;common\&quot;, \&quot;rare\&quot;], \&quot;condition\&quot;: \&quot;eq\&quot;}}))
+     * @param {string} [keyword] Keyword to search NFT name and description. Alphanumeric characters only.
+     * @param {SearchStacksSortByEnum} [sortBy] Sort results in a specific order
+     * @param {number} [pageSize] Number of results to return per page
+     * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchStacks: (chainName: string, contractAddress: Array<string>, accountAddress?: string, onlyIncludeOwnerListings?: boolean, onlyIfHasActiveListings?: boolean, traits?: string, keyword?: string, sortBy?: SearchStacksSortByEnum, pageSize?: number, pageCursor?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * MetadataSearchApi - functional programming interface
+ * @export
+ */
+export declare const MetadataSearchApiFp: (configuration?: Configuration) => {
+    /**
+     * Get list of metadata filters
+     * @summary Get list of metadata attribute filters
+     * @param {string} chainName The name of chain
+     * @param {string} contractAddress Contract addresses for collection
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFilters(chainName: string, contractAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFiltersResult>>;
+    /**
+     * Search NFTs
+     * @summary Search NFTs
+     * @param {string} chainName The name of chain
+     * @param {Array<string>} contractAddress List of contract addresses to filter by
+     * @param {string} [accountAddress] Account address to filter by
+     * @param {Array<string>} [stackId] Filters NFTs that belong to any of these stacks
+     * @param {boolean} [onlyIncludeOwnerListings] Whether the listings should include only the owner created listings
+     * @param {number} [pageSize] Number of results to return per page
+     * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchNFTs(chainName: string, contractAddress: Array<string>, accountAddress?: string, stackId?: Array<string>, onlyIncludeOwnerListings?: boolean, pageSize?: number, pageCursor?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchNFTsResult>>;
+    /**
+     * Search NFT stacks
+     * @summary Search NFT stacks
+     * @param {string} chainName The name of chain
+     * @param {Array<string>} contractAddress List of contract addresses to filter by
+     * @param {string} [accountAddress] Account address to filter by
+     * @param {boolean} [onlyIncludeOwnerListings] Whether to the listings should include only the owner created listings
+     * @param {boolean} [onlyIfHasActiveListings] Filters results to include only stacks that have a current active listing. False and \&#39;null\&#39; return all unfiltered stacks.
+     * @param {string} [traits] JSON encoded traits to filter by. e.g. encodeURIComponent(JSON.stringify({\&quot;rarity\&quot;: {\&quot;values\&quot;: [\&quot;common\&quot;, \&quot;rare\&quot;], \&quot;condition\&quot;: \&quot;eq\&quot;}}))
+     * @param {string} [keyword] Keyword to search NFT name and description. Alphanumeric characters only.
+     * @param {SearchStacksSortByEnum} [sortBy] Sort results in a specific order
+     * @param {number} [pageSize] Number of results to return per page
+     * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchStacks(chainName: string, contractAddress: Array<string>, accountAddress?: string, onlyIncludeOwnerListings?: boolean, onlyIfHasActiveListings?: boolean, traits?: string, keyword?: string, sortBy?: SearchStacksSortByEnum, pageSize?: number, pageCursor?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchStacksResult>>;
+};
+/**
+ * MetadataSearchApi - factory interface
+ * @export
+ */
+export declare const MetadataSearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get list of metadata filters
+     * @summary Get list of metadata attribute filters
+     * @param {MetadataSearchApiListFiltersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFilters(requestParameters: MetadataSearchApiListFiltersRequest, options?: AxiosRequestConfig): AxiosPromise<ListFiltersResult>;
+    /**
+     * Search NFTs
+     * @summary Search NFTs
+     * @param {MetadataSearchApiSearchNFTsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchNFTs(requestParameters: MetadataSearchApiSearchNFTsRequest, options?: AxiosRequestConfig): AxiosPromise<SearchNFTsResult>;
+    /**
+     * Search NFT stacks
+     * @summary Search NFT stacks
+     * @param {MetadataSearchApiSearchStacksRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchStacks(requestParameters: MetadataSearchApiSearchStacksRequest, options?: AxiosRequestConfig): AxiosPromise<SearchStacksResult>;
+};
+/**
+ * Request parameters for listFilters operation in MetadataSearchApi.
+ * @export
+ * @interface MetadataSearchApiListFiltersRequest
+ */
+export interface MetadataSearchApiListFiltersRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof MetadataSearchApiListFilters
+     */
+    readonly chainName: string;
+    /**
+     * Contract addresses for collection
+     * @type {string}
+     * @memberof MetadataSearchApiListFilters
+     */
+    readonly contractAddress: string;
+}
+/**
+ * Request parameters for searchNFTs operation in MetadataSearchApi.
+ * @export
+ * @interface MetadataSearchApiSearchNFTsRequest
+ */
+export interface MetadataSearchApiSearchNFTsRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof MetadataSearchApiSearchNFTs
+     */
+    readonly chainName: string;
+    /**
+     * List of contract addresses to filter by
+     * @type {Array<string>}
+     * @memberof MetadataSearchApiSearchNFTs
+     */
+    readonly contractAddress: Array<string>;
+    /**
+     * Account address to filter by
+     * @type {string}
+     * @memberof MetadataSearchApiSearchNFTs
+     */
+    readonly accountAddress?: string;
+    /**
+     * Filters NFTs that belong to any of these stacks
+     * @type {Array<string>}
+     * @memberof MetadataSearchApiSearchNFTs
+     */
+    readonly stackId?: Array<string>;
+    /**
+     * Whether the listings should include only the owner created listings
+     * @type {boolean}
+     * @memberof MetadataSearchApiSearchNFTs
+     */
+    readonly onlyIncludeOwnerListings?: boolean;
+    /**
+     * Number of results to return per page
+     * @type {number}
+     * @memberof MetadataSearchApiSearchNFTs
+     */
+    readonly pageSize?: number;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof MetadataSearchApiSearchNFTs
+     */
+    readonly pageCursor?: string;
+}
+/**
+ * Request parameters for searchStacks operation in MetadataSearchApi.
+ * @export
+ * @interface MetadataSearchApiSearchStacksRequest
+ */
+export interface MetadataSearchApiSearchStacksRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof MetadataSearchApiSearchStacks
+     */
+    readonly chainName: string;
+    /**
+     * List of contract addresses to filter by
+     * @type {Array<string>}
+     * @memberof MetadataSearchApiSearchStacks
+     */
+    readonly contractAddress: Array<string>;
+    /**
+     * Account address to filter by
+     * @type {string}
+     * @memberof MetadataSearchApiSearchStacks
+     */
+    readonly accountAddress?: string;
+    /**
+     * Whether to the listings should include only the owner created listings
+     * @type {boolean}
+     * @memberof MetadataSearchApiSearchStacks
+     */
+    readonly onlyIncludeOwnerListings?: boolean;
+    /**
+     * Filters results to include only stacks that have a current active listing. False and \&#39;null\&#39; return all unfiltered stacks.
+     * @type {boolean}
+     * @memberof MetadataSearchApiSearchStacks
+     */
+    readonly onlyIfHasActiveListings?: boolean;
+    /**
+     * JSON encoded traits to filter by. e.g. encodeURIComponent(JSON.stringify({\&quot;rarity\&quot;: {\&quot;values\&quot;: [\&quot;common\&quot;, \&quot;rare\&quot;], \&quot;condition\&quot;: \&quot;eq\&quot;}}))
+     * @type {string}
+     * @memberof MetadataSearchApiSearchStacks
+     */
+    readonly traits?: string;
+    /**
+     * Keyword to search NFT name and description. Alphanumeric characters only.
+     * @type {string}
+     * @memberof MetadataSearchApiSearchStacks
+     */
+    readonly keyword?: string;
+    /**
+     * Sort results in a specific order
+     * @type {'cheapest_first'}
+     * @memberof MetadataSearchApiSearchStacks
+     */
+    readonly sortBy?: SearchStacksSortByEnum;
+    /**
+     * Number of results to return per page
+     * @type {number}
+     * @memberof MetadataSearchApiSearchStacks
+     */
+    readonly pageSize?: number;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof MetadataSearchApiSearchStacks
+     */
+    readonly pageCursor?: string;
+}
+/**
+ * MetadataSearchApi - object-oriented interface
+ * @export
+ * @class MetadataSearchApi
+ * @extends {BaseAPI}
+ */
+export declare class MetadataSearchApi extends BaseAPI {
+    /**
+     * Get list of metadata filters
+     * @summary Get list of metadata attribute filters
+     * @param {MetadataSearchApiListFiltersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataSearchApi
+     */
+    listFilters(requestParameters: MetadataSearchApiListFiltersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFiltersResult, any>>;
+    /**
+     * Search NFTs
+     * @summary Search NFTs
+     * @param {MetadataSearchApiSearchNFTsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataSearchApi
+     */
+    searchNFTs(requestParameters: MetadataSearchApiSearchNFTsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchNFTsResult, any>>;
+    /**
+     * Search NFT stacks
+     * @summary Search NFT stacks
+     * @param {MetadataSearchApiSearchStacksRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataSearchApi
+     */
+    searchStacks(requestParameters: MetadataSearchApiSearchStacksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchStacksResult, any>>;
+}
+/**
+ * @export
+ */
+export declare const SearchStacksSortByEnum: {
+    readonly CheapestFirst: "cheapest_first";
+};
+export type SearchStacksSortByEnum = typeof SearchStacksSortByEnum[keyof typeof SearchStacksSortByEnum];

package/dist/types/multi-rollup/domain/nft-owners-api.d.ts

@@ -0,0 +1,276 @@
+/**
+ * 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.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../base';
+import { ListCollectionOwnersResult } from '../models';
+import { ListNFTOwnersResult } from '../models';
+/**
+ * NftOwnersApi - axios parameter creator
+ * @export
+ */
+export declare const NftOwnersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * List all NFT owners on a chain
+     * @summary List all NFT owners
+     * @param {string} chainName The name of chain
+     * @param {string} [fromUpdatedAt] Datetime to use as the oldest updated timestamp
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllNFTOwners: (chainName: string, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List NFT owners by token ID
+     * @summary List NFT owners by token ID
+     * @param {string} contractAddress The address of contract
+     * @param {string} tokenId An &#x60;uint256&#x60; token id as string
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNFTOwners: (contractAddress: string, tokenId: string, chainName: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List owners by contract address
+     * @summary List owners by contract address
+     * @param {string} contractAddress The address of contract
+     * @param {string} chainName The name of chain
+     * @param {Array<string>} [accountAddress] List of account addresses to filter by
+     * @param {string} [fromUpdatedAt] Datetime to use as the oldest updated timestamp
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOwnersByContractAddress: (contractAddress: string, chainName: string, accountAddress?: Array<string>, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * NftOwnersApi - functional programming interface
+ * @export
+ */
+export declare const NftOwnersApiFp: (configuration?: Configuration) => {
+    /**
+     * List all NFT owners on a chain
+     * @summary List all NFT owners
+     * @param {string} chainName The name of chain
+     * @param {string} [fromUpdatedAt] Datetime to use as the oldest updated timestamp
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllNFTOwners(chainName: string, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNFTOwnersResult>>;
+    /**
+     * List NFT owners by token ID
+     * @summary List NFT owners by token ID
+     * @param {string} contractAddress The address of contract
+     * @param {string} tokenId An &#x60;uint256&#x60; token id as string
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNFTOwners(contractAddress: string, tokenId: string, chainName: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNFTOwnersResult>>;
+    /**
+     * List owners by contract address
+     * @summary List owners by contract address
+     * @param {string} contractAddress The address of contract
+     * @param {string} chainName The name of chain
+     * @param {Array<string>} [accountAddress] List of account addresses to filter by
+     * @param {string} [fromUpdatedAt] Datetime to use as the oldest updated timestamp
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOwnersByContractAddress(contractAddress: string, chainName: string, accountAddress?: Array<string>, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCollectionOwnersResult>>;
+};
+/**
+ * NftOwnersApi - factory interface
+ * @export
+ */
+export declare const NftOwnersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * List all NFT owners on a chain
+     * @summary List all NFT owners
+     * @param {NftOwnersApiListAllNFTOwnersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllNFTOwners(requestParameters: NftOwnersApiListAllNFTOwnersRequest, options?: AxiosRequestConfig): AxiosPromise<ListNFTOwnersResult>;
+    /**
+     * List NFT owners by token ID
+     * @summary List NFT owners by token ID
+     * @param {NftOwnersApiListNFTOwnersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNFTOwners(requestParameters: NftOwnersApiListNFTOwnersRequest, options?: AxiosRequestConfig): AxiosPromise<ListNFTOwnersResult>;
+    /**
+     * List owners by contract address
+     * @summary List owners by contract address
+     * @param {NftOwnersApiListOwnersByContractAddressRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOwnersByContractAddress(requestParameters: NftOwnersApiListOwnersByContractAddressRequest, options?: AxiosRequestConfig): AxiosPromise<ListCollectionOwnersResult>;
+};
+/**
+ * Request parameters for listAllNFTOwners operation in NftOwnersApi.
+ * @export
+ * @interface NftOwnersApiListAllNFTOwnersRequest
+ */
+export interface NftOwnersApiListAllNFTOwnersRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftOwnersApiListAllNFTOwners
+     */
+    readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof NftOwnersApiListAllNFTOwners
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof NftOwnersApiListAllNFTOwners
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof NftOwnersApiListAllNFTOwners
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listNFTOwners operation in NftOwnersApi.
+ * @export
+ * @interface NftOwnersApiListNFTOwnersRequest
+ */
+export interface NftOwnersApiListNFTOwnersRequest {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof NftOwnersApiListNFTOwners
+     */
+    readonly contractAddress: string;
+    /**
+     * An &#x60;uint256&#x60; token id as string
+     * @type {string}
+     * @memberof NftOwnersApiListNFTOwners
+     */
+    readonly tokenId: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftOwnersApiListNFTOwners
+     */
+    readonly chainName: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof NftOwnersApiListNFTOwners
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof NftOwnersApiListNFTOwners
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listOwnersByContractAddress operation in NftOwnersApi.
+ * @export
+ * @interface NftOwnersApiListOwnersByContractAddressRequest
+ */
+export interface NftOwnersApiListOwnersByContractAddressRequest {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof NftOwnersApiListOwnersByContractAddress
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftOwnersApiListOwnersByContractAddress
+     */
+    readonly chainName: string;
+    /**
+     * List of account addresses to filter by
+     * @type {Array<string>}
+     * @memberof NftOwnersApiListOwnersByContractAddress
+     */
+    readonly accountAddress?: Array<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;
+}
+/**
+ * NftOwnersApi - object-oriented interface
+ * @export
+ * @class NftOwnersApi
+ * @extends {BaseAPI}
+ */
+export declare class NftOwnersApi extends BaseAPI {
+    /**
+     * List all NFT owners on a chain
+     * @summary List all NFT owners
+     * @param {NftOwnersApiListAllNFTOwnersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftOwnersApi
+     */
+    listAllNFTOwners(requestParameters: NftOwnersApiListAllNFTOwnersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNFTOwnersResult, any>>;
+    /**
+     * List NFT owners by token ID
+     * @summary List NFT owners by token ID
+     * @param {NftOwnersApiListNFTOwnersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftOwnersApi
+     */
+    listNFTOwners(requestParameters: NftOwnersApiListNFTOwnersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNFTOwnersResult, any>>;
+    /**
+     * List owners by contract address
+     * @summary List owners by contract address
+     * @param {NftOwnersApiListOwnersByContractAddressRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftOwnersApi
+     */
+    listOwnersByContractAddress(requestParameters: NftOwnersApiListOwnersByContractAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCollectionOwnersResult, any>>;
+}