@imtbl/generated-clients 2.0.0-alpha.0

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

@@ -0,0 +1,561 @@
+/**
+ * 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 { CreateMintRequestRequest } from '../models';
+import { CreateMintRequestResult } from '../models';
+import { GetNFTResult } from '../models';
+import { ListMintRequestsResult } from '../models';
+import { ListNFTsByOwnerResult } from '../models';
+import { ListNFTsResult } from '../models';
+import { MintRequestStatus } from '../models';
+/**
+ * NftsApi - axios parameter creator
+ * @export
+ */
+export declare const NftsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a mint request to mint a set of NFTs for a given collection
+     * @summary Mint NFTs
+     * @param {string} contractAddress The address of contract
+     * @param {string} chainName The name of chain
+     * @param {CreateMintRequestRequest} createMintRequestRequest Create Mint Request Body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMintRequest: (contractAddress: string, chainName: string, createMintRequestRequest: CreateMintRequestRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve the status of a mint request identified by its reference_id
+     * @summary Get mint request by reference ID
+     * @param {string} contractAddress The address of contract
+     * @param {string} chainName The name of chain
+     * @param {string} referenceId The id of the mint request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMintRequest: (contractAddress: string, chainName: string, referenceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get NFT by token ID
+     * @summary Get NFT by token ID
+     * @param {string} contractAddress The address of NFT contract
+     * @param {string} tokenId An &#x60;uint256&#x60; token id as string
+     * @param {string} chainName The name of chain
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNFT: (contractAddress: string, tokenId: string, chainName: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List all NFTs on a chain
+     * @summary List all NFTs
+     * @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}
+     */
+    listAllNFTs: (chainName: string, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve the status of all mints for a given contract address
+     * @summary List mint requests
+     * @param {string} contractAddress The address of contract
+     * @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 {MintRequestStatus} [status] The status of the mint request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMintRequests: (contractAddress: string, chainName: string, pageCursor?: string, pageSize?: number, status?: MintRequestStatus, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List NFTs by contract address
+     * @summary List NFTs by contract address
+     * @param {string} contractAddress Contract address
+     * @param {string} chainName The name of chain
+     * @param {Array<string>} [tokenId] List of token IDs 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}
+     */
+    listNFTs: (contractAddress: string, chainName: string, tokenId?: Array<string>, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List NFTs by account address
+     * @summary List NFTs by account address
+     * @param {string} accountAddress Account address
+     * @param {string} chainName The name of chain
+     * @param {string} [contractAddress] The address of contract
+     * @param {Array<string>} [tokenId] List of token IDs 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}
+     */
+    listNFTsByAccountAddress: (accountAddress: string, chainName: string, contractAddress?: string, tokenId?: Array<string>, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * NftsApi - functional programming interface
+ * @export
+ */
+export declare const NftsApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a mint request to mint a set of NFTs for a given collection
+     * @summary Mint NFTs
+     * @param {string} contractAddress The address of contract
+     * @param {string} chainName The name of chain
+     * @param {CreateMintRequestRequest} createMintRequestRequest Create Mint Request Body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMintRequest(contractAddress: string, chainName: string, createMintRequestRequest: CreateMintRequestRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMintRequestResult>>;
+    /**
+     * Retrieve the status of a mint request identified by its reference_id
+     * @summary Get mint request by reference ID
+     * @param {string} contractAddress The address of contract
+     * @param {string} chainName The name of chain
+     * @param {string} referenceId The id of the mint request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMintRequest(contractAddress: string, chainName: string, referenceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListMintRequestsResult>>;
+    /**
+     * Get NFT by token ID
+     * @summary Get NFT by token ID
+     * @param {string} contractAddress The address of NFT contract
+     * @param {string} tokenId An &#x60;uint256&#x60; token id as string
+     * @param {string} chainName The name of chain
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNFT(contractAddress: string, tokenId: string, chainName: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNFTResult>>;
+    /**
+     * List all NFTs on a chain
+     * @summary List all NFTs
+     * @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}
+     */
+    listAllNFTs(chainName: string, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNFTsResult>>;
+    /**
+     * Retrieve the status of all mints for a given contract address
+     * @summary List mint requests
+     * @param {string} contractAddress The address of contract
+     * @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 {MintRequestStatus} [status] The status of the mint request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMintRequests(contractAddress: string, chainName: string, pageCursor?: string, pageSize?: number, status?: MintRequestStatus, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListMintRequestsResult>>;
+    /**
+     * List NFTs by contract address
+     * @summary List NFTs by contract address
+     * @param {string} contractAddress Contract address
+     * @param {string} chainName The name of chain
+     * @param {Array<string>} [tokenId] List of token IDs 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}
+     */
+    listNFTs(contractAddress: string, chainName: string, tokenId?: Array<string>, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNFTsResult>>;
+    /**
+     * List NFTs by account address
+     * @summary List NFTs by account address
+     * @param {string} accountAddress Account address
+     * @param {string} chainName The name of chain
+     * @param {string} [contractAddress] The address of contract
+     * @param {Array<string>} [tokenId] List of token IDs 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}
+     */
+    listNFTsByAccountAddress(accountAddress: string, chainName: string, contractAddress?: string, tokenId?: Array<string>, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNFTsByOwnerResult>>;
+};
+/**
+ * NftsApi - factory interface
+ * @export
+ */
+export declare const NftsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a mint request to mint a set of NFTs for a given collection
+     * @summary Mint NFTs
+     * @param {NftsApiCreateMintRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMintRequest(requestParameters: NftsApiCreateMintRequestRequest, options?: AxiosRequestConfig): AxiosPromise<CreateMintRequestResult>;
+    /**
+     * Retrieve the status of a mint request identified by its reference_id
+     * @summary Get mint request by reference ID
+     * @param {NftsApiGetMintRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMintRequest(requestParameters: NftsApiGetMintRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ListMintRequestsResult>;
+    /**
+     * Get NFT by token ID
+     * @summary Get NFT by token ID
+     * @param {NftsApiGetNFTRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNFT(requestParameters: NftsApiGetNFTRequest, options?: AxiosRequestConfig): AxiosPromise<GetNFTResult>;
+    /**
+     * List all NFTs on a chain
+     * @summary List all NFTs
+     * @param {NftsApiListAllNFTsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllNFTs(requestParameters: NftsApiListAllNFTsRequest, options?: AxiosRequestConfig): AxiosPromise<ListNFTsResult>;
+    /**
+     * Retrieve the status of all mints for a given contract address
+     * @summary List mint requests
+     * @param {NftsApiListMintRequestsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMintRequests(requestParameters: NftsApiListMintRequestsRequest, options?: AxiosRequestConfig): AxiosPromise<ListMintRequestsResult>;
+    /**
+     * List NFTs by contract address
+     * @summary List NFTs by contract address
+     * @param {NftsApiListNFTsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNFTs(requestParameters: NftsApiListNFTsRequest, options?: AxiosRequestConfig): AxiosPromise<ListNFTsResult>;
+    /**
+     * List NFTs by account address
+     * @summary List NFTs by account address
+     * @param {NftsApiListNFTsByAccountAddressRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNFTsByAccountAddress(requestParameters: NftsApiListNFTsByAccountAddressRequest, options?: AxiosRequestConfig): AxiosPromise<ListNFTsByOwnerResult>;
+};
+/**
+ * Request parameters for createMintRequest operation in NftsApi.
+ * @export
+ * @interface NftsApiCreateMintRequestRequest
+ */
+export interface NftsApiCreateMintRequestRequest {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof NftsApiCreateMintRequest
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftsApiCreateMintRequest
+     */
+    readonly chainName: string;
+    /**
+     * Create Mint Request Body
+     * @type {CreateMintRequestRequest}
+     * @memberof NftsApiCreateMintRequest
+     */
+    readonly createMintRequestRequest: CreateMintRequestRequest;
+}
+/**
+ * Request parameters for getMintRequest operation in NftsApi.
+ * @export
+ * @interface NftsApiGetMintRequestRequest
+ */
+export interface NftsApiGetMintRequestRequest {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof NftsApiGetMintRequest
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftsApiGetMintRequest
+     */
+    readonly chainName: string;
+    /**
+     * The id of the mint request
+     * @type {string}
+     * @memberof NftsApiGetMintRequest
+     */
+    readonly referenceId: string;
+}
+/**
+ * Request parameters for getNFT operation in NftsApi.
+ * @export
+ * @interface NftsApiGetNFTRequest
+ */
+export interface NftsApiGetNFTRequest {
+    /**
+     * The address of NFT contract
+     * @type {string}
+     * @memberof NftsApiGetNFT
+     */
+    readonly contractAddress: string;
+    /**
+     * An &#x60;uint256&#x60; token id as string
+     * @type {string}
+     * @memberof NftsApiGetNFT
+     */
+    readonly tokenId: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftsApiGetNFT
+     */
+    readonly chainName: string;
+}
+/**
+ * Request parameters for listAllNFTs operation in NftsApi.
+ * @export
+ * @interface NftsApiListAllNFTsRequest
+ */
+export 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 listMintRequests operation in NftsApi.
+ * @export
+ * @interface NftsApiListMintRequestsRequest
+ */
+export interface NftsApiListMintRequestsRequest {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof NftsApiListMintRequests
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftsApiListMintRequests
+     */
+    readonly chainName: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof NftsApiListMintRequests
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof NftsApiListMintRequests
+     */
+    readonly pageSize?: number;
+    /**
+     * The status of the mint request
+     * @type {MintRequestStatus}
+     * @memberof NftsApiListMintRequests
+     */
+    readonly status?: MintRequestStatus;
+}
+/**
+ * Request parameters for listNFTs operation in NftsApi.
+ * @export
+ * @interface NftsApiListNFTsRequest
+ */
+export interface NftsApiListNFTsRequest {
+    /**
+     * Contract address
+     * @type {string}
+     * @memberof NftsApiListNFTs
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftsApiListNFTs
+     */
+    readonly chainName: string;
+    /**
+     * List of token IDs to filter by
+     * @type {Array<string>}
+     * @memberof NftsApiListNFTs
+     */
+    readonly tokenId?: Array<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}
+     * @memberof NftsApiListNFTs
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof NftsApiListNFTs
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listNFTsByAccountAddress operation in NftsApi.
+ * @export
+ * @interface NftsApiListNFTsByAccountAddressRequest
+ */
+export interface NftsApiListNFTsByAccountAddressRequest {
+    /**
+     * Account address
+     * @type {string}
+     * @memberof NftsApiListNFTsByAccountAddress
+     */
+    readonly accountAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftsApiListNFTsByAccountAddress
+     */
+    readonly chainName: string;
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof NftsApiListNFTsByAccountAddress
+     */
+    readonly contractAddress?: string;
+    /**
+     * List of token IDs to filter by
+     * @type {Array<string>}
+     * @memberof NftsApiListNFTsByAccountAddress
+     */
+    readonly tokenId?: Array<string>;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof NftsApiListNFTsByAccountAddress
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof NftsApiListNFTsByAccountAddress
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof NftsApiListNFTsByAccountAddress
+     */
+    readonly pageSize?: number;
+}
+/**
+ * NftsApi - object-oriented interface
+ * @export
+ * @class NftsApi
+ * @extends {BaseAPI}
+ */
+export declare class NftsApi extends BaseAPI {
+    /**
+     * Create a mint request to mint a set of NFTs for a given collection
+     * @summary Mint NFTs
+     * @param {NftsApiCreateMintRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftsApi
+     */
+    createMintRequest(requestParameters: NftsApiCreateMintRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateMintRequestResult, any>>;
+    /**
+     * Retrieve the status of a mint request identified by its reference_id
+     * @summary Get mint request by reference ID
+     * @param {NftsApiGetMintRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftsApi
+     */
+    getMintRequest(requestParameters: NftsApiGetMintRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListMintRequestsResult, any>>;
+    /**
+     * Get NFT by token ID
+     * @summary Get NFT by token ID
+     * @param {NftsApiGetNFTRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftsApi
+     */
+    getNFT(requestParameters: NftsApiGetNFTRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetNFTResult, any>>;
+    /**
+     * List all NFTs on a chain
+     * @summary List all NFTs
+     * @param {NftsApiListAllNFTsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftsApi
+     */
+    listAllNFTs(requestParameters: NftsApiListAllNFTsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNFTsResult, any>>;
+    /**
+     * Retrieve the status of all mints for a given contract address
+     * @summary List mint requests
+     * @param {NftsApiListMintRequestsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftsApi
+     */
+    listMintRequests(requestParameters: NftsApiListMintRequestsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListMintRequestsResult, any>>;
+    /**
+     * List NFTs by contract address
+     * @summary List NFTs by contract address
+     * @param {NftsApiListNFTsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftsApi
+     */
+    listNFTs(requestParameters: NftsApiListNFTsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNFTsResult, any>>;
+    /**
+     * List NFTs by account address
+     * @summary List NFTs by account address
+     * @param {NftsApiListNFTsByAccountAddressRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftsApi
+     */
+    listNFTsByAccountAddress(requestParameters: NftsApiListNFTsByAccountAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNFTsByOwnerResult, any>>;
+}