@imtbl/generated-clients 2.0.0-alpha.0

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

@@ -0,0 +1,317 @@
+/**
+ * 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 { AssetVerificationStatus } from '../models';
+import { GetCollectionResult } from '../models';
+import { ListCollectionsResult } from '../models';
+import { RefreshCollectionMetadataRequest } from '../models';
+import { RefreshCollectionMetadataResult } from '../models';
+/**
+ * CollectionsApi - axios parameter creator
+ * @export
+ */
+export declare const CollectionsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get collection by contract address
+     * @summary Get collection by contract address
+     * @param {string} contractAddress The address contract
+     * @param {string} chainName The name of chain
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCollection: (contractAddress: string, chainName: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List all collections
+     * @summary List all collections
+     * @param {string} chainName The name of chain
+     * @param {Array<string>} [contractAddress] List of contract addresses to filter by
+     * @param {Array<AssetVerificationStatus>} [verificationStatus] List of verification status 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}
+     */
+    listCollections: (chainName: string, contractAddress?: Array<string>, verificationStatus?: Array<AssetVerificationStatus>, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List collections by NFT owner account address
+     * @summary List collections by NFT owner
+     * @param {string} accountAddress Account address
+     * @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}
+     */
+    listCollectionsByNFTOwner: (accountAddress: string, chainName: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Refresh collection metadata
+     * @summary Refresh collection metadata
+     * @param {string} contractAddress The address contract
+     * @param {string} chainName The name of chain
+     * @param {RefreshCollectionMetadataRequest} refreshCollectionMetadataRequest The request body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    refreshCollectionMetadata: (contractAddress: string, chainName: string, refreshCollectionMetadataRequest: RefreshCollectionMetadataRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CollectionsApi - functional programming interface
+ * @export
+ */
+export declare const CollectionsApiFp: (configuration?: Configuration) => {
+    /**
+     * Get collection by contract address
+     * @summary Get collection by contract address
+     * @param {string} contractAddress The address contract
+     * @param {string} chainName The name of chain
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCollection(contractAddress: string, chainName: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCollectionResult>>;
+    /**
+     * List all collections
+     * @summary List all collections
+     * @param {string} chainName The name of chain
+     * @param {Array<string>} [contractAddress] List of contract addresses to filter by
+     * @param {Array<AssetVerificationStatus>} [verificationStatus] List of verification status 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}
+     */
+    listCollections(chainName: string, contractAddress?: Array<string>, verificationStatus?: Array<AssetVerificationStatus>, fromUpdatedAt?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCollectionsResult>>;
+    /**
+     * List collections by NFT owner account address
+     * @summary List collections by NFT owner
+     * @param {string} accountAddress Account address
+     * @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}
+     */
+    listCollectionsByNFTOwner(accountAddress: string, chainName: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCollectionsResult>>;
+    /**
+     * Refresh collection metadata
+     * @summary Refresh collection metadata
+     * @param {string} contractAddress The address contract
+     * @param {string} chainName The name of chain
+     * @param {RefreshCollectionMetadataRequest} refreshCollectionMetadataRequest The request body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    refreshCollectionMetadata(contractAddress: string, chainName: string, refreshCollectionMetadataRequest: RefreshCollectionMetadataRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RefreshCollectionMetadataResult>>;
+};
+/**
+ * CollectionsApi - factory interface
+ * @export
+ */
+export declare const CollectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get collection by contract address
+     * @summary Get collection by contract address
+     * @param {CollectionsApiGetCollectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCollection(requestParameters: CollectionsApiGetCollectionRequest, options?: AxiosRequestConfig): AxiosPromise<GetCollectionResult>;
+    /**
+     * List all collections
+     * @summary List all collections
+     * @param {CollectionsApiListCollectionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCollections(requestParameters: CollectionsApiListCollectionsRequest, options?: AxiosRequestConfig): AxiosPromise<ListCollectionsResult>;
+    /**
+     * List collections by NFT owner account address
+     * @summary List collections by NFT owner
+     * @param {CollectionsApiListCollectionsByNFTOwnerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCollectionsByNFTOwner(requestParameters: CollectionsApiListCollectionsByNFTOwnerRequest, options?: AxiosRequestConfig): AxiosPromise<ListCollectionsResult>;
+    /**
+     * Refresh collection metadata
+     * @summary Refresh collection metadata
+     * @param {CollectionsApiRefreshCollectionMetadataRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    refreshCollectionMetadata(requestParameters: CollectionsApiRefreshCollectionMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<RefreshCollectionMetadataResult>;
+};
+/**
+ * Request parameters for getCollection operation in CollectionsApi.
+ * @export
+ * @interface CollectionsApiGetCollectionRequest
+ */
+export interface CollectionsApiGetCollectionRequest {
+    /**
+     * The address contract
+     * @type {string}
+     * @memberof CollectionsApiGetCollection
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof CollectionsApiGetCollection
+     */
+    readonly chainName: string;
+}
+/**
+ * Request parameters for listCollections operation in CollectionsApi.
+ * @export
+ * @interface CollectionsApiListCollectionsRequest
+ */
+export interface CollectionsApiListCollectionsRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof CollectionsApiListCollections
+     */
+    readonly chainName: string;
+    /**
+     * List of contract addresses to filter by
+     * @type {Array<string>}
+     * @memberof CollectionsApiListCollections
+     */
+    readonly contractAddress?: Array<string>;
+    /**
+     * List of verification status to filter by
+     * @type {Array<AssetVerificationStatus>}
+     * @memberof CollectionsApiListCollections
+     */
+    readonly verificationStatus?: Array<AssetVerificationStatus>;
+    /**
+     * 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}
+     * @memberof CollectionsApiListCollections
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof CollectionsApiListCollections
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listCollectionsByNFTOwner operation in CollectionsApi.
+ * @export
+ * @interface CollectionsApiListCollectionsByNFTOwnerRequest
+ */
+export interface CollectionsApiListCollectionsByNFTOwnerRequest {
+    /**
+     * Account address
+     * @type {string}
+     * @memberof CollectionsApiListCollectionsByNFTOwner
+     */
+    readonly accountAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof CollectionsApiListCollectionsByNFTOwner
+     */
+    readonly chainName: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof CollectionsApiListCollectionsByNFTOwner
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof CollectionsApiListCollectionsByNFTOwner
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for refreshCollectionMetadata operation in CollectionsApi.
+ * @export
+ * @interface CollectionsApiRefreshCollectionMetadataRequest
+ */
+export 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;
+}
+/**
+ * CollectionsApi - object-oriented interface
+ * @export
+ * @class CollectionsApi
+ * @extends {BaseAPI}
+ */
+export declare class CollectionsApi extends BaseAPI {
+    /**
+     * Get collection by contract address
+     * @summary Get collection by contract address
+     * @param {CollectionsApiGetCollectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionsApi
+     */
+    getCollection(requestParameters: CollectionsApiGetCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCollectionResult, any>>;
+    /**
+     * List all collections
+     * @summary List all collections
+     * @param {CollectionsApiListCollectionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionsApi
+     */
+    listCollections(requestParameters: CollectionsApiListCollectionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCollectionsResult, any>>;
+    /**
+     * List collections by NFT owner account address
+     * @summary List collections by NFT owner
+     * @param {CollectionsApiListCollectionsByNFTOwnerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionsApi
+     */
+    listCollectionsByNFTOwner(requestParameters: CollectionsApiListCollectionsByNFTOwnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCollectionsResult, any>>;
+    /**
+     * Refresh collection metadata
+     * @summary Refresh collection metadata
+     * @param {CollectionsApiRefreshCollectionMetadataRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionsApi
+     */
+    refreshCollectionMetadata(requestParameters: CollectionsApiRefreshCollectionMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RefreshCollectionMetadataResult, any>>;
+}

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

@@ -0,0 +1,96 @@
+/**
+ * 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 { SignCraftingRequest } from '../models';
+import { SignCraftingResult } from '../models';
+/**
+ * CraftingApi - axios parameter creator
+ * @export
+ */
+export declare const CraftingApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Sign a crafting payload
+     * @summary Sign a crafting payload
+     * @param {string} chainName The name of chain
+     * @param {SignCraftingRequest} signCraftingRequest The request body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    signCraftingPayload: (chainName: string, signCraftingRequest: SignCraftingRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CraftingApi - functional programming interface
+ * @export
+ */
+export declare const CraftingApiFp: (configuration?: Configuration) => {
+    /**
+     * Sign a crafting payload
+     * @summary Sign a crafting payload
+     * @param {string} chainName The name of chain
+     * @param {SignCraftingRequest} signCraftingRequest The request body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    signCraftingPayload(chainName: string, signCraftingRequest: SignCraftingRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignCraftingResult>>;
+};
+/**
+ * CraftingApi - factory interface
+ * @export
+ */
+export declare const CraftingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Sign a crafting payload
+     * @summary Sign a crafting payload
+     * @param {CraftingApiSignCraftingPayloadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    signCraftingPayload(requestParameters: CraftingApiSignCraftingPayloadRequest, options?: AxiosRequestConfig): AxiosPromise<SignCraftingResult>;
+};
+/**
+ * Request parameters for signCraftingPayload operation in CraftingApi.
+ * @export
+ * @interface CraftingApiSignCraftingPayloadRequest
+ */
+export interface CraftingApiSignCraftingPayloadRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof CraftingApiSignCraftingPayload
+     */
+    readonly chainName: string;
+    /**
+     * The request body
+     * @type {SignCraftingRequest}
+     * @memberof CraftingApiSignCraftingPayload
+     */
+    readonly signCraftingRequest: SignCraftingRequest;
+}
+/**
+ * CraftingApi - object-oriented interface
+ * @export
+ * @class CraftingApi
+ * @extends {BaseAPI}
+ */
+export declare class CraftingApi extends BaseAPI {
+    /**
+     * Sign a crafting payload
+     * @summary Sign a crafting payload
+     * @param {CraftingApiSignCraftingPayloadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CraftingApi
+     */
+    signCraftingPayload(requestParameters: CraftingApiSignCraftingPayloadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SignCraftingResult, any>>;
+}