@imtbl/generated-clients 2.0.0-alpha.0

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

@@ -0,0 +1,434 @@
+/**
+ * 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 { GetMetadataResult } from '../models';
+import { ListMetadataResult } from '../models';
+import { MetadataRefreshRateLimitResult } from '../models';
+import { RefreshMetadataByIDRequest } from '../models';
+import { RefreshNFTMetadataByTokenIDRequest } from '../models';
+import { StackBundle } from '../models';
+/**
+ * MetadataApi - axios parameter creator
+ * @export
+ */
+export declare const MetadataApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get metadata by ID
+     * @summary Get 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: string, contractAddress: string, metadataId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a list of metadata from the given contract
+     * @summary Get a list of metadata from the given contract
+     * @param {string} chainName The name of chain
+     * @param {string} contractAddress The address of metadata contract
+     * @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}
+     */
+    listMetadata: (chainName: string, contractAddress: string, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a list of metadata from the given chain
+     * @summary Get a list of metadata from the given chain
+     * @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}
+     */
+    listMetadataForChain: (chainName: string, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List NFT stack bundles by stack_id. This endpoint functions similarly to `ListMetadataByID` but extends the response to include Market, Listings & Stack Count information for each stack.
+     * @summary List NFT stack bundles by stack_id. Response will include Market, Listings & Stack Count information for each stack
+     * @param {string} chainName The name of chain
+     * @param {Array<string>} stackId List of stack_id to filter by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listStacks: (chainName: string, stackId: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Refresh stacked metadata
+     * @summary Refresh stacked metadata
+     * @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: string, contractAddress: string, refreshMetadataByIDRequest: RefreshMetadataByIDRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Refresh NFT metadata
+     * @summary Refresh NFT metadata
+     * @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: string, chainName: string, refreshNFTMetadataByTokenIDRequest: RefreshNFTMetadataByTokenIDRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * MetadataApi - functional programming interface
+ * @export
+ */
+export declare const MetadataApiFp: (configuration?: Configuration) => {
+    /**
+     * Get metadata by ID
+     * @summary Get 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: string, contractAddress: string, metadataId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMetadataResult>>;
+    /**
+     * Get a list of metadata from the given contract
+     * @summary Get a list of metadata from the given contract
+     * @param {string} chainName The name of chain
+     * @param {string} contractAddress The address of metadata contract
+     * @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}
+     */
+    listMetadata(chainName: string, contractAddress: string, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListMetadataResult>>;
+    /**
+     * Get a list of metadata from the given chain
+     * @summary Get a list of metadata from the given chain
+     * @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}
+     */
+    listMetadataForChain(chainName: string, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListMetadataResult>>;
+    /**
+     * List NFT stack bundles by stack_id. This endpoint functions similarly to `ListMetadataByID` but extends the response to include Market, Listings & Stack Count information for each stack.
+     * @summary List NFT stack bundles by stack_id. Response will include Market, Listings & Stack Count information for each stack
+     * @param {string} chainName The name of chain
+     * @param {Array<string>} stackId List of stack_id to filter by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listStacks(chainName: string, stackId: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<StackBundle>>>;
+    /**
+     * Refresh stacked metadata
+     * @summary Refresh stacked metadata
+     * @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: string, contractAddress: string, refreshMetadataByIDRequest: RefreshMetadataByIDRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataRefreshRateLimitResult>>;
+    /**
+     * Refresh NFT metadata
+     * @summary Refresh NFT metadata
+     * @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: string, chainName: string, refreshNFTMetadataByTokenIDRequest: RefreshNFTMetadataByTokenIDRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataRefreshRateLimitResult>>;
+};
+/**
+ * MetadataApi - factory interface
+ * @export
+ */
+export declare const MetadataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get metadata by ID
+     * @summary Get metadata by ID
+     * @param {MetadataApiGetMetadataRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadata(requestParameters: MetadataApiGetMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<GetMetadataResult>;
+    /**
+     * Get a list of metadata from the given contract
+     * @summary Get a list of metadata from the given contract
+     * @param {MetadataApiListMetadataRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMetadata(requestParameters: MetadataApiListMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<ListMetadataResult>;
+    /**
+     * Get a list of metadata from the given chain
+     * @summary Get a list of metadata from the given chain
+     * @param {MetadataApiListMetadataForChainRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMetadataForChain(requestParameters: MetadataApiListMetadataForChainRequest, options?: AxiosRequestConfig): AxiosPromise<ListMetadataResult>;
+    /**
+     * List NFT stack bundles by stack_id. This endpoint functions similarly to `ListMetadataByID` but extends the response to include Market, Listings & Stack Count information for each stack.
+     * @summary List NFT stack bundles by stack_id. Response will include Market, Listings & Stack Count information for each stack
+     * @param {MetadataApiListStacksRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listStacks(requestParameters: MetadataApiListStacksRequest, options?: AxiosRequestConfig): AxiosPromise<Array<StackBundle>>;
+    /**
+     * Refresh stacked metadata
+     * @summary Refresh stacked metadata
+     * @param {MetadataApiRefreshMetadataByIDRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    refreshMetadataByID(requestParameters: MetadataApiRefreshMetadataByIDRequest, options?: AxiosRequestConfig): AxiosPromise<MetadataRefreshRateLimitResult>;
+    /**
+     * Refresh NFT metadata
+     * @summary Refresh NFT metadata
+     * @param {MetadataApiRefreshNFTMetadataByTokenIDRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    refreshNFTMetadataByTokenID(requestParameters: MetadataApiRefreshNFTMetadataByTokenIDRequest, options?: AxiosRequestConfig): AxiosPromise<MetadataRefreshRateLimitResult>;
+};
+/**
+ * Request parameters for getMetadata operation in MetadataApi.
+ * @export
+ * @interface MetadataApiGetMetadataRequest
+ */
+export 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
+ */
+export 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 listMetadataForChain operation in MetadataApi.
+ * @export
+ * @interface MetadataApiListMetadataForChainRequest
+ */
+export interface MetadataApiListMetadataForChainRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof MetadataApiListMetadataForChain
+     */
+    readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof MetadataApiListMetadataForChain
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof MetadataApiListMetadataForChain
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof MetadataApiListMetadataForChain
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listStacks operation in MetadataApi.
+ * @export
+ * @interface MetadataApiListStacksRequest
+ */
+export interface MetadataApiListStacksRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof MetadataApiListStacks
+     */
+    readonly chainName: string;
+    /**
+     * List of stack_id to filter by
+     * @type {Array<string>}
+     * @memberof MetadataApiListStacks
+     */
+    readonly stackId: Array<string>;
+}
+/**
+ * Request parameters for refreshMetadataByID operation in MetadataApi.
+ * @export
+ * @interface MetadataApiRefreshMetadataByIDRequest
+ */
+export 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
+ */
+export 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;
+}
+/**
+ * MetadataApi - object-oriented interface
+ * @export
+ * @class MetadataApi
+ * @extends {BaseAPI}
+ */
+export declare class MetadataApi extends BaseAPI {
+    /**
+     * Get metadata by ID
+     * @summary Get metadata by ID
+     * @param {MetadataApiGetMetadataRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataApi
+     */
+    getMetadata(requestParameters: MetadataApiGetMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMetadataResult, any>>;
+    /**
+     * Get a list of metadata from the given contract
+     * @summary Get a list of metadata from the given contract
+     * @param {MetadataApiListMetadataRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataApi
+     */
+    listMetadata(requestParameters: MetadataApiListMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListMetadataResult, any>>;
+    /**
+     * Get a list of metadata from the given chain
+     * @summary Get a list of metadata from the given chain
+     * @param {MetadataApiListMetadataForChainRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataApi
+     */
+    listMetadataForChain(requestParameters: MetadataApiListMetadataForChainRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListMetadataResult, any>>;
+    /**
+     * List NFT stack bundles by stack_id. This endpoint functions similarly to `ListMetadataByID` but extends the response to include Market, Listings & Stack Count information for each stack.
+     * @summary List NFT stack bundles by stack_id. Response will include Market, Listings & Stack Count information for each stack
+     * @param {MetadataApiListStacksRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataApi
+     */
+    listStacks(requestParameters: MetadataApiListStacksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StackBundle[], any>>;
+    /**
+     * Refresh stacked metadata
+     * @summary Refresh stacked metadata
+     * @param {MetadataApiRefreshMetadataByIDRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataApi
+     */
+    refreshMetadataByID(requestParameters: MetadataApiRefreshMetadataByIDRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MetadataRefreshRateLimitResult, any>>;
+    /**
+     * Refresh NFT metadata
+     * @summary Refresh NFT metadata
+     * @param {MetadataApiRefreshNFTMetadataByTokenIDRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataApi
+     */
+    refreshNFTMetadataByTokenID(requestParameters: MetadataApiRefreshNFTMetadataByTokenIDRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MetadataRefreshRateLimitResult, any>>;
+}