@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/imx/domain/metadata-refreshes-api.d.ts

@@ -0,0 +1,357 @@
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.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 { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateMetadataRefreshRequest } from '../models';
+import { CreateMetadataRefreshResponse } from '../models';
+import { GetMetadataRefreshErrorsResponse } from '../models';
+import { GetMetadataRefreshResponse } from '../models';
+import { GetMetadataRefreshes } from '../models';
+/**
+ * MetadataRefreshesApi - axios parameter creator
+ * @export
+ */
+export declare const MetadataRefreshesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get a list of metadata refreshes
+     * @param {string} xImxEthSignature String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @param {string} xImxEthTimestamp Unix Epoc timestamp
+     * @param {string} xImxEthAddress Wallet Address that signed the signature
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {string} [collectionAddress] Collection address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAListOfMetadataRefreshes: (xImxEthSignature: string, xImxEthTimestamp: string, xImxEthAddress: string, pageSize?: number, cursor?: string, collectionAddress?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get metadata refresh errors
+     * @param {string} refreshId The metadata refresh ID
+     * @param {string} xImxEthSignature String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @param {string} xImxEthTimestamp Unix Epoc timestamp
+     * @param {string} xImxEthAddress Wallet Address that signed the signature
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataRefreshErrors: (refreshId: string, xImxEthSignature: string, xImxEthTimestamp: string, xImxEthAddress: string, pageSize?: number, cursor?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get metadata refresh results
+     * @param {string} refreshId The metadata refresh ID
+     * @param {string} xImxEthSignature String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @param {string} xImxEthTimestamp Unix Epoc timestamp
+     * @param {string} xImxEthAddress Wallet Address that signed the signature
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataRefreshResults: (refreshId: string, xImxEthSignature: string, xImxEthTimestamp: string, xImxEthAddress: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Request metadata refresh for provided tokens
+     * @param {string} xImxEthSignature String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @param {string} xImxEthTimestamp Unix Epoc timestamp
+     * @param {string} xImxEthAddress Wallet Address that signed the signature
+     * @param {CreateMetadataRefreshRequest} createMetadataRefreshRequest Create metadata refresh request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestAMetadataRefresh: (xImxEthSignature: string, xImxEthTimestamp: string, xImxEthAddress: string, createMetadataRefreshRequest: CreateMetadataRefreshRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * MetadataRefreshesApi - functional programming interface
+ * @export
+ */
+export declare const MetadataRefreshesApiFp: (configuration?: Configuration) => {
+    /**
+     * Get a list of metadata refreshes
+     * @param {string} xImxEthSignature String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @param {string} xImxEthTimestamp Unix Epoc timestamp
+     * @param {string} xImxEthAddress Wallet Address that signed the signature
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {string} [collectionAddress] Collection address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAListOfMetadataRefreshes(xImxEthSignature: string, xImxEthTimestamp: string, xImxEthAddress: string, pageSize?: number, cursor?: string, collectionAddress?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMetadataRefreshes>>;
+    /**
+     * Get metadata refresh errors
+     * @param {string} refreshId The metadata refresh ID
+     * @param {string} xImxEthSignature String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @param {string} xImxEthTimestamp Unix Epoc timestamp
+     * @param {string} xImxEthAddress Wallet Address that signed the signature
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataRefreshErrors(refreshId: string, xImxEthSignature: string, xImxEthTimestamp: string, xImxEthAddress: string, pageSize?: number, cursor?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMetadataRefreshErrorsResponse>>;
+    /**
+     * Get metadata refresh results
+     * @param {string} refreshId The metadata refresh ID
+     * @param {string} xImxEthSignature String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @param {string} xImxEthTimestamp Unix Epoc timestamp
+     * @param {string} xImxEthAddress Wallet Address that signed the signature
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataRefreshResults(refreshId: string, xImxEthSignature: string, xImxEthTimestamp: string, xImxEthAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMetadataRefreshResponse>>;
+    /**
+     * Request metadata refresh for provided tokens
+     * @param {string} xImxEthSignature String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @param {string} xImxEthTimestamp Unix Epoc timestamp
+     * @param {string} xImxEthAddress Wallet Address that signed the signature
+     * @param {CreateMetadataRefreshRequest} createMetadataRefreshRequest Create metadata refresh request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestAMetadataRefresh(xImxEthSignature: string, xImxEthTimestamp: string, xImxEthAddress: string, createMetadataRefreshRequest: CreateMetadataRefreshRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMetadataRefreshResponse>>;
+};
+/**
+ * MetadataRefreshesApi - factory interface
+ * @export
+ */
+export declare const MetadataRefreshesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get a list of metadata refreshes
+     * @param {string} xImxEthSignature String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @param {string} xImxEthTimestamp Unix Epoc timestamp
+     * @param {string} xImxEthAddress Wallet Address that signed the signature
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {string} [collectionAddress] Collection address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAListOfMetadataRefreshes(xImxEthSignature: string, xImxEthTimestamp: string, xImxEthAddress: string, pageSize?: number, cursor?: string, collectionAddress?: string, options?: any): AxiosPromise<GetMetadataRefreshes>;
+    /**
+     * Get metadata refresh errors
+     * @param {string} refreshId The metadata refresh ID
+     * @param {string} xImxEthSignature String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @param {string} xImxEthTimestamp Unix Epoc timestamp
+     * @param {string} xImxEthAddress Wallet Address that signed the signature
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataRefreshErrors(refreshId: string, xImxEthSignature: string, xImxEthTimestamp: string, xImxEthAddress: string, pageSize?: number, cursor?: string, options?: any): AxiosPromise<GetMetadataRefreshErrorsResponse>;
+    /**
+     * Get metadata refresh results
+     * @param {string} refreshId The metadata refresh ID
+     * @param {string} xImxEthSignature String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @param {string} xImxEthTimestamp Unix Epoc timestamp
+     * @param {string} xImxEthAddress Wallet Address that signed the signature
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataRefreshResults(refreshId: string, xImxEthSignature: string, xImxEthTimestamp: string, xImxEthAddress: string, options?: any): AxiosPromise<GetMetadataRefreshResponse>;
+    /**
+     * Request metadata refresh for provided tokens
+     * @param {string} xImxEthSignature String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @param {string} xImxEthTimestamp Unix Epoc timestamp
+     * @param {string} xImxEthAddress Wallet Address that signed the signature
+     * @param {CreateMetadataRefreshRequest} createMetadataRefreshRequest Create metadata refresh request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestAMetadataRefresh(xImxEthSignature: string, xImxEthTimestamp: string, xImxEthAddress: string, createMetadataRefreshRequest: CreateMetadataRefreshRequest, options?: any): AxiosPromise<CreateMetadataRefreshResponse>;
+};
+/**
+ * Request parameters for getAListOfMetadataRefreshes operation in MetadataRefreshesApi.
+ * @export
+ * @interface MetadataRefreshesApiGetAListOfMetadataRefreshesRequest
+ */
+export interface MetadataRefreshesApiGetAListOfMetadataRefreshesRequest {
+    /**
+     * String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @type {string}
+     * @memberof MetadataRefreshesApiGetAListOfMetadataRefreshes
+     */
+    readonly xImxEthSignature: string;
+    /**
+     * Unix Epoc timestamp
+     * @type {string}
+     * @memberof MetadataRefreshesApiGetAListOfMetadataRefreshes
+     */
+    readonly xImxEthTimestamp: string;
+    /**
+     * Wallet Address that signed the signature
+     * @type {string}
+     * @memberof MetadataRefreshesApiGetAListOfMetadataRefreshes
+     */
+    readonly xImxEthAddress: string;
+    /**
+     * Page size of the result
+     * @type {number}
+     * @memberof MetadataRefreshesApiGetAListOfMetadataRefreshes
+     */
+    readonly pageSize?: number;
+    /**
+     * Cursor
+     * @type {string}
+     * @memberof MetadataRefreshesApiGetAListOfMetadataRefreshes
+     */
+    readonly cursor?: string;
+    /**
+     * Collection address
+     * @type {string}
+     * @memberof MetadataRefreshesApiGetAListOfMetadataRefreshes
+     */
+    readonly collectionAddress?: string;
+}
+/**
+ * Request parameters for getMetadataRefreshErrors operation in MetadataRefreshesApi.
+ * @export
+ * @interface MetadataRefreshesApiGetMetadataRefreshErrorsRequest
+ */
+export interface MetadataRefreshesApiGetMetadataRefreshErrorsRequest {
+    /**
+     * The metadata refresh ID
+     * @type {string}
+     * @memberof MetadataRefreshesApiGetMetadataRefreshErrors
+     */
+    readonly refreshId: string;
+    /**
+     * String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @type {string}
+     * @memberof MetadataRefreshesApiGetMetadataRefreshErrors
+     */
+    readonly xImxEthSignature: string;
+    /**
+     * Unix Epoc timestamp
+     * @type {string}
+     * @memberof MetadataRefreshesApiGetMetadataRefreshErrors
+     */
+    readonly xImxEthTimestamp: string;
+    /**
+     * Wallet Address that signed the signature
+     * @type {string}
+     * @memberof MetadataRefreshesApiGetMetadataRefreshErrors
+     */
+    readonly xImxEthAddress: string;
+    /**
+     * Page size of the result
+     * @type {number}
+     * @memberof MetadataRefreshesApiGetMetadataRefreshErrors
+     */
+    readonly pageSize?: number;
+    /**
+     * Cursor
+     * @type {string}
+     * @memberof MetadataRefreshesApiGetMetadataRefreshErrors
+     */
+    readonly cursor?: string;
+}
+/**
+ * Request parameters for getMetadataRefreshResults operation in MetadataRefreshesApi.
+ * @export
+ * @interface MetadataRefreshesApiGetMetadataRefreshResultsRequest
+ */
+export interface MetadataRefreshesApiGetMetadataRefreshResultsRequest {
+    /**
+     * The metadata refresh ID
+     * @type {string}
+     * @memberof MetadataRefreshesApiGetMetadataRefreshResults
+     */
+    readonly refreshId: string;
+    /**
+     * String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @type {string}
+     * @memberof MetadataRefreshesApiGetMetadataRefreshResults
+     */
+    readonly xImxEthSignature: string;
+    /**
+     * Unix Epoc timestamp
+     * @type {string}
+     * @memberof MetadataRefreshesApiGetMetadataRefreshResults
+     */
+    readonly xImxEthTimestamp: string;
+    /**
+     * Wallet Address that signed the signature
+     * @type {string}
+     * @memberof MetadataRefreshesApiGetMetadataRefreshResults
+     */
+    readonly xImxEthAddress: string;
+}
+/**
+ * Request parameters for requestAMetadataRefresh operation in MetadataRefreshesApi.
+ * @export
+ * @interface MetadataRefreshesApiRequestAMetadataRefreshRequest
+ */
+export interface MetadataRefreshesApiRequestAMetadataRefreshRequest {
+    /**
+     * String created by signing wallet address and timestamp. See https://docs.x.immutable.com/docs/generate-imx-signature
+     * @type {string}
+     * @memberof MetadataRefreshesApiRequestAMetadataRefresh
+     */
+    readonly xImxEthSignature: string;
+    /**
+     * Unix Epoc timestamp
+     * @type {string}
+     * @memberof MetadataRefreshesApiRequestAMetadataRefresh
+     */
+    readonly xImxEthTimestamp: string;
+    /**
+     * Wallet Address that signed the signature
+     * @type {string}
+     * @memberof MetadataRefreshesApiRequestAMetadataRefresh
+     */
+    readonly xImxEthAddress: string;
+    /**
+     * Create metadata refresh request
+     * @type {CreateMetadataRefreshRequest}
+     * @memberof MetadataRefreshesApiRequestAMetadataRefresh
+     */
+    readonly createMetadataRefreshRequest: CreateMetadataRefreshRequest;
+}
+/**
+ * MetadataRefreshesApi - object-oriented interface
+ * @export
+ * @class MetadataRefreshesApi
+ * @extends {BaseAPI}
+ */
+export declare class MetadataRefreshesApi extends BaseAPI {
+    /**
+     * Get a list of metadata refreshes
+     * @param {MetadataRefreshesApiGetAListOfMetadataRefreshesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataRefreshesApi
+     */
+    getAListOfMetadataRefreshes(requestParameters: MetadataRefreshesApiGetAListOfMetadataRefreshesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMetadataRefreshes, any>>;
+    /**
+     * Get metadata refresh errors
+     * @param {MetadataRefreshesApiGetMetadataRefreshErrorsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataRefreshesApi
+     */
+    getMetadataRefreshErrors(requestParameters: MetadataRefreshesApiGetMetadataRefreshErrorsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMetadataRefreshErrorsResponse, any>>;
+    /**
+     * Get metadata refresh results
+     * @param {MetadataRefreshesApiGetMetadataRefreshResultsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataRefreshesApi
+     */
+    getMetadataRefreshResults(requestParameters: MetadataRefreshesApiGetMetadataRefreshResultsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMetadataRefreshResponse, any>>;
+    /**
+     * Request metadata refresh for provided tokens
+     * @param {MetadataRefreshesApiRequestAMetadataRefreshRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataRefreshesApi
+     */
+    requestAMetadataRefresh(requestParameters: MetadataRefreshesApiRequestAMetadataRefreshRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateMetadataRefreshResponse, any>>;
+}