@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/imx/domain/exchanges-api.d.ts

@@ -0,0 +1,395 @@
+/**
+ * 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 { CreateExchangeAndURLAPIRequest } from '../models';
+import { CreateTransferRequestV1 } from '../models';
+import { CreateTransferResponseV1 } from '../models';
+import { Exchange } from '../models';
+import { ExchangeCreateExchangeAndURLResponse } from '../models';
+import { GetSignableTransferRequestV1 } from '../models';
+import { GetSignableTransferResponseV1 } from '../models';
+import { GetTransactionsResponse } from '../models';
+/**
+ * ExchangesApi - axios parameter creator
+ * @export
+ */
+export declare const ExchangesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Receive wallet_address, provider, type and widget information to create a base exchange transaction and return widget URL
+     * @summary Create an exchange with URL
+     * @param {CreateExchangeAndURLAPIRequest} createExchangeAPIRequest req
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createExchange: (createExchangeAPIRequest: CreateExchangeAndURLAPIRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Accepts a transfer request and updates the transfer_status after processing transfer (offramp)
+     * @summary Accepts a transfer request and updates the transfer_status after processing transfer (offramp)
+     * @param {string} id Transaction ID
+     * @param {CreateTransferRequestV1} createTransferRequest Create a transfer
+     * @param {string} [xImxEthAddress] eth address
+     * @param {string} [xImxEthSignature] eth signature
+     * @param {string} [authorization] Authorization header
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createExchangeTransfer: (id: string, createTransferRequest: CreateTransferRequestV1, xImxEthAddress?: string, xImxEthSignature?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get an exchange by ID
+     * @summary Get an exchange by ID
+     * @param {string} id Exchange ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExchange: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Send a request for signable-transfer-details (offramp)
+     * @summary Send a request for signable-transfer-details (offramp)
+     * @param {string} id Transaction ID
+     * @param {GetSignableTransferRequestV1} getSignableTransferRequest get details of signable transfer
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExchangeSignableTransfer: (id: string, getSignableTransferRequest: GetSignableTransferRequestV1, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of exchanges based on the request
+     * @summary Returns a list of exchanges based on the request
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {'id' | 'status' | 'exchange' | 'amount' | 'transfer_id'} [orderBy] Property to sort by
+     * @param {'asc' | 'desc'} [direction] Direction to sort
+     * @param {number} [id] Transaction ID
+     * @param {string} [walletAddress] Ethereum address of the user who created transaction
+     * @param {'created' | 'pending' | 'completed' | 'failed' | 'waitingPayment' | 'timedOut'} [status] Transaction status
+     * @param {'moonpay' | 'layerswap'} [provider] Provider name
+     * @param {string} [transferId] Transfer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExchanges: (pageSize?: number, cursor?: string, orderBy?: "id" | "status" | "exchange" | "amount" | "transfer_id", direction?: "asc" | "desc", id?: number, walletAddress?: string, status?: "created" | "pending" | "completed" | "failed" | "waitingPayment" | "timedOut", provider?: "moonpay" | "layerswap", transferId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ExchangesApi - functional programming interface
+ * @export
+ */
+export declare const ExchangesApiFp: (configuration?: Configuration) => {
+    /**
+     * Receive wallet_address, provider, type and widget information to create a base exchange transaction and return widget URL
+     * @summary Create an exchange with URL
+     * @param {CreateExchangeAndURLAPIRequest} createExchangeAPIRequest req
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createExchange(createExchangeAPIRequest: CreateExchangeAndURLAPIRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExchangeCreateExchangeAndURLResponse>>;
+    /**
+     * Accepts a transfer request and updates the transfer_status after processing transfer (offramp)
+     * @summary Accepts a transfer request and updates the transfer_status after processing transfer (offramp)
+     * @param {string} id Transaction ID
+     * @param {CreateTransferRequestV1} createTransferRequest Create a transfer
+     * @param {string} [xImxEthAddress] eth address
+     * @param {string} [xImxEthSignature] eth signature
+     * @param {string} [authorization] Authorization header
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createExchangeTransfer(id: string, createTransferRequest: CreateTransferRequestV1, xImxEthAddress?: string, xImxEthSignature?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTransferResponseV1>>;
+    /**
+     * Get an exchange by ID
+     * @summary Get an exchange by ID
+     * @param {string} id Exchange ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExchange(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Exchange>>;
+    /**
+     * Send a request for signable-transfer-details (offramp)
+     * @summary Send a request for signable-transfer-details (offramp)
+     * @param {string} id Transaction ID
+     * @param {GetSignableTransferRequestV1} getSignableTransferRequest get details of signable transfer
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExchangeSignableTransfer(id: string, getSignableTransferRequest: GetSignableTransferRequestV1, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSignableTransferResponseV1>>;
+    /**
+     * Returns a list of exchanges based on the request
+     * @summary Returns a list of exchanges based on the request
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {'id' | 'status' | 'exchange' | 'amount' | 'transfer_id'} [orderBy] Property to sort by
+     * @param {'asc' | 'desc'} [direction] Direction to sort
+     * @param {number} [id] Transaction ID
+     * @param {string} [walletAddress] Ethereum address of the user who created transaction
+     * @param {'created' | 'pending' | 'completed' | 'failed' | 'waitingPayment' | 'timedOut'} [status] Transaction status
+     * @param {'moonpay' | 'layerswap'} [provider] Provider name
+     * @param {string} [transferId] Transfer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExchanges(pageSize?: number, cursor?: string, orderBy?: "id" | "status" | "exchange" | "amount" | "transfer_id", direction?: "asc" | "desc", id?: number, walletAddress?: string, status?: "created" | "pending" | "completed" | "failed" | "waitingPayment" | "timedOut", provider?: "moonpay" | "layerswap", transferId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTransactionsResponse>>;
+};
+/**
+ * ExchangesApi - factory interface
+ * @export
+ */
+export declare const ExchangesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Receive wallet_address, provider, type and widget information to create a base exchange transaction and return widget URL
+     * @summary Create an exchange with URL
+     * @param {CreateExchangeAndURLAPIRequest} createExchangeAPIRequest req
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createExchange(createExchangeAPIRequest: CreateExchangeAndURLAPIRequest, options?: any): AxiosPromise<ExchangeCreateExchangeAndURLResponse>;
+    /**
+     * Accepts a transfer request and updates the transfer_status after processing transfer (offramp)
+     * @summary Accepts a transfer request and updates the transfer_status after processing transfer (offramp)
+     * @param {string} id Transaction ID
+     * @param {CreateTransferRequestV1} createTransferRequest Create a transfer
+     * @param {string} [xImxEthAddress] eth address
+     * @param {string} [xImxEthSignature] eth signature
+     * @param {string} [authorization] Authorization header
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createExchangeTransfer(id: string, createTransferRequest: CreateTransferRequestV1, xImxEthAddress?: string, xImxEthSignature?: string, authorization?: string, options?: any): AxiosPromise<CreateTransferResponseV1>;
+    /**
+     * Get an exchange by ID
+     * @summary Get an exchange by ID
+     * @param {string} id Exchange ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExchange(id: string, options?: any): AxiosPromise<Exchange>;
+    /**
+     * Send a request for signable-transfer-details (offramp)
+     * @summary Send a request for signable-transfer-details (offramp)
+     * @param {string} id Transaction ID
+     * @param {GetSignableTransferRequestV1} getSignableTransferRequest get details of signable transfer
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExchangeSignableTransfer(id: string, getSignableTransferRequest: GetSignableTransferRequestV1, options?: any): AxiosPromise<GetSignableTransferResponseV1>;
+    /**
+     * Returns a list of exchanges based on the request
+     * @summary Returns a list of exchanges based on the request
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {'id' | 'status' | 'exchange' | 'amount' | 'transfer_id'} [orderBy] Property to sort by
+     * @param {'asc' | 'desc'} [direction] Direction to sort
+     * @param {number} [id] Transaction ID
+     * @param {string} [walletAddress] Ethereum address of the user who created transaction
+     * @param {'created' | 'pending' | 'completed' | 'failed' | 'waitingPayment' | 'timedOut'} [status] Transaction status
+     * @param {'moonpay' | 'layerswap'} [provider] Provider name
+     * @param {string} [transferId] Transfer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExchanges(pageSize?: number, cursor?: string, orderBy?: "id" | "status" | "exchange" | "amount" | "transfer_id", direction?: "asc" | "desc", id?: number, walletAddress?: string, status?: "created" | "pending" | "completed" | "failed" | "waitingPayment" | "timedOut", provider?: "moonpay" | "layerswap", transferId?: string, options?: any): AxiosPromise<GetTransactionsResponse>;
+};
+/**
+ * Request parameters for createExchange operation in ExchangesApi.
+ * @export
+ * @interface ExchangesApiCreateExchangeRequest
+ */
+export interface ExchangesApiCreateExchangeRequest {
+    /**
+     * req
+     * @type {CreateExchangeAndURLAPIRequest}
+     * @memberof ExchangesApiCreateExchange
+     */
+    readonly createExchangeAPIRequest: CreateExchangeAndURLAPIRequest;
+}
+/**
+ * Request parameters for createExchangeTransfer operation in ExchangesApi.
+ * @export
+ * @interface ExchangesApiCreateExchangeTransferRequest
+ */
+export interface ExchangesApiCreateExchangeTransferRequest {
+    /**
+     * Transaction ID
+     * @type {string}
+     * @memberof ExchangesApiCreateExchangeTransfer
+     */
+    readonly id: string;
+    /**
+     * Create a transfer
+     * @type {CreateTransferRequestV1}
+     * @memberof ExchangesApiCreateExchangeTransfer
+     */
+    readonly createTransferRequest: CreateTransferRequestV1;
+    /**
+     * eth address
+     * @type {string}
+     * @memberof ExchangesApiCreateExchangeTransfer
+     */
+    readonly xImxEthAddress?: string;
+    /**
+     * eth signature
+     * @type {string}
+     * @memberof ExchangesApiCreateExchangeTransfer
+     */
+    readonly xImxEthSignature?: string;
+    /**
+     * Authorization header
+     * @type {string}
+     * @memberof ExchangesApiCreateExchangeTransfer
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getExchange operation in ExchangesApi.
+ * @export
+ * @interface ExchangesApiGetExchangeRequest
+ */
+export interface ExchangesApiGetExchangeRequest {
+    /**
+     * Exchange ID
+     * @type {string}
+     * @memberof ExchangesApiGetExchange
+     */
+    readonly id: string;
+}
+/**
+ * Request parameters for getExchangeSignableTransfer operation in ExchangesApi.
+ * @export
+ * @interface ExchangesApiGetExchangeSignableTransferRequest
+ */
+export interface ExchangesApiGetExchangeSignableTransferRequest {
+    /**
+     * Transaction ID
+     * @type {string}
+     * @memberof ExchangesApiGetExchangeSignableTransfer
+     */
+    readonly id: string;
+    /**
+     * get details of signable transfer
+     * @type {GetSignableTransferRequestV1}
+     * @memberof ExchangesApiGetExchangeSignableTransfer
+     */
+    readonly getSignableTransferRequest: GetSignableTransferRequestV1;
+}
+/**
+ * Request parameters for getExchanges operation in ExchangesApi.
+ * @export
+ * @interface ExchangesApiGetExchangesRequest
+ */
+export interface ExchangesApiGetExchangesRequest {
+    /**
+     * Page size of the result
+     * @type {number}
+     * @memberof ExchangesApiGetExchanges
+     */
+    readonly pageSize?: number;
+    /**
+     * Cursor
+     * @type {string}
+     * @memberof ExchangesApiGetExchanges
+     */
+    readonly cursor?: string;
+    /**
+     * Property to sort by
+     * @type {'id' | 'status' | 'exchange' | 'amount' | 'transfer_id'}
+     * @memberof ExchangesApiGetExchanges
+     */
+    readonly orderBy?: 'id' | 'status' | 'exchange' | 'amount' | 'transfer_id';
+    /**
+     * Direction to sort
+     * @type {'asc' | 'desc'}
+     * @memberof ExchangesApiGetExchanges
+     */
+    readonly direction?: 'asc' | 'desc';
+    /**
+     * Transaction ID
+     * @type {number}
+     * @memberof ExchangesApiGetExchanges
+     */
+    readonly id?: number;
+    /**
+     * Ethereum address of the user who created transaction
+     * @type {string}
+     * @memberof ExchangesApiGetExchanges
+     */
+    readonly walletAddress?: string;
+    /**
+     * Transaction status
+     * @type {'created' | 'pending' | 'completed' | 'failed' | 'waitingPayment' | 'timedOut'}
+     * @memberof ExchangesApiGetExchanges
+     */
+    readonly status?: 'created' | 'pending' | 'completed' | 'failed' | 'waitingPayment' | 'timedOut';
+    /**
+     * Provider name
+     * @type {'moonpay' | 'layerswap'}
+     * @memberof ExchangesApiGetExchanges
+     */
+    readonly provider?: 'moonpay' | 'layerswap';
+    /**
+     * Transfer ID
+     * @type {string}
+     * @memberof ExchangesApiGetExchanges
+     */
+    readonly transferId?: string;
+}
+/**
+ * ExchangesApi - object-oriented interface
+ * @export
+ * @class ExchangesApi
+ * @extends {BaseAPI}
+ */
+export declare class ExchangesApi extends BaseAPI {
+    /**
+     * Receive wallet_address, provider, type and widget information to create a base exchange transaction and return widget URL
+     * @summary Create an exchange with URL
+     * @param {ExchangesApiCreateExchangeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExchangesApi
+     */
+    createExchange(requestParameters: ExchangesApiCreateExchangeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeCreateExchangeAndURLResponse, any>>;
+    /**
+     * Accepts a transfer request and updates the transfer_status after processing transfer (offramp)
+     * @summary Accepts a transfer request and updates the transfer_status after processing transfer (offramp)
+     * @param {ExchangesApiCreateExchangeTransferRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExchangesApi
+     */
+    createExchangeTransfer(requestParameters: ExchangesApiCreateExchangeTransferRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTransferResponseV1, any>>;
+    /**
+     * Get an exchange by ID
+     * @summary Get an exchange by ID
+     * @param {ExchangesApiGetExchangeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExchangesApi
+     */
+    getExchange(requestParameters: ExchangesApiGetExchangeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Exchange, any>>;
+    /**
+     * Send a request for signable-transfer-details (offramp)
+     * @summary Send a request for signable-transfer-details (offramp)
+     * @param {ExchangesApiGetExchangeSignableTransferRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExchangesApi
+     */
+    getExchangeSignableTransfer(requestParameters: ExchangesApiGetExchangeSignableTransferRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSignableTransferResponseV1, any>>;
+    /**
+     * Returns a list of exchanges based on the request
+     * @summary Returns a list of exchanges based on the request
+     * @param {ExchangesApiGetExchangesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExchangesApi
+     */
+    getExchanges(requestParameters?: ExchangesApiGetExchangesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTransactionsResponse, any>>;
+}

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

@@ -0,0 +1,245 @@
+/**
+ * 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 { AddMetadataSchemaToCollectionRequest } from '../models';
+import { MetadataSchemaProperty } from '../models';
+import { MetadataSchemaRequest } from '../models';
+import { SuccessResponse } from '../models';
+/**
+ * MetadataApi - axios parameter creator
+ * @export
+ */
+export declare const MetadataApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Add metadata schema to collection
+     * @summary Add metadata schema to collection
+     * @param {string} address Collection contract address
+     * @param {string} iMXSignature String created by signing wallet address and timestamp
+     * @param {string} iMXTimestamp Unix Epoc timestamp
+     * @param {AddMetadataSchemaToCollectionRequest} addMetadataSchemaToCollectionRequest add metadata schema to a collection
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addMetadataSchemaToCollection: (address: string, iMXSignature: string, iMXTimestamp: string, addMetadataSchemaToCollectionRequest: AddMetadataSchemaToCollectionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get collection metadata schema
+     * @summary Get collection metadata schema
+     * @param {string} address Collection contract address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataSchema: (address: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update metadata schema by name
+     * @summary Update metadata schema by name
+     * @param {string} address Collection contract address
+     * @param {string} name Metadata schema name
+     * @param {string} iMXSignature String created by signing wallet address and timestamp
+     * @param {string} iMXTimestamp Unix Epoc timestamp
+     * @param {MetadataSchemaRequest} metadataSchemaRequest update metadata schema
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMetadataSchemaByName: (address: string, name: string, iMXSignature: string, iMXTimestamp: string, metadataSchemaRequest: MetadataSchemaRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * MetadataApi - functional programming interface
+ * @export
+ */
+export declare const MetadataApiFp: (configuration?: Configuration) => {
+    /**
+     * Add metadata schema to collection
+     * @summary Add metadata schema to collection
+     * @param {string} address Collection contract address
+     * @param {string} iMXSignature String created by signing wallet address and timestamp
+     * @param {string} iMXTimestamp Unix Epoc timestamp
+     * @param {AddMetadataSchemaToCollectionRequest} addMetadataSchemaToCollectionRequest add metadata schema to a collection
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addMetadataSchemaToCollection(address: string, iMXSignature: string, iMXTimestamp: string, addMetadataSchemaToCollectionRequest: AddMetadataSchemaToCollectionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponse>>;
+    /**
+     * Get collection metadata schema
+     * @summary Get collection metadata schema
+     * @param {string} address Collection contract address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataSchema(address: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetadataSchemaProperty>>>;
+    /**
+     * Update metadata schema by name
+     * @summary Update metadata schema by name
+     * @param {string} address Collection contract address
+     * @param {string} name Metadata schema name
+     * @param {string} iMXSignature String created by signing wallet address and timestamp
+     * @param {string} iMXTimestamp Unix Epoc timestamp
+     * @param {MetadataSchemaRequest} metadataSchemaRequest update metadata schema
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMetadataSchemaByName(address: string, name: string, iMXSignature: string, iMXTimestamp: string, metadataSchemaRequest: MetadataSchemaRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponse>>;
+};
+/**
+ * MetadataApi - factory interface
+ * @export
+ */
+export declare const MetadataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Add metadata schema to collection
+     * @summary Add metadata schema to collection
+     * @param {string} address Collection contract address
+     * @param {string} iMXSignature String created by signing wallet address and timestamp
+     * @param {string} iMXTimestamp Unix Epoc timestamp
+     * @param {AddMetadataSchemaToCollectionRequest} addMetadataSchemaToCollectionRequest add metadata schema to a collection
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addMetadataSchemaToCollection(address: string, iMXSignature: string, iMXTimestamp: string, addMetadataSchemaToCollectionRequest: AddMetadataSchemaToCollectionRequest, options?: any): AxiosPromise<SuccessResponse>;
+    /**
+     * Get collection metadata schema
+     * @summary Get collection metadata schema
+     * @param {string} address Collection contract address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetadataSchema(address: string, options?: any): AxiosPromise<Array<MetadataSchemaProperty>>;
+    /**
+     * Update metadata schema by name
+     * @summary Update metadata schema by name
+     * @param {string} address Collection contract address
+     * @param {string} name Metadata schema name
+     * @param {string} iMXSignature String created by signing wallet address and timestamp
+     * @param {string} iMXTimestamp Unix Epoc timestamp
+     * @param {MetadataSchemaRequest} metadataSchemaRequest update metadata schema
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMetadataSchemaByName(address: string, name: string, iMXSignature: string, iMXTimestamp: string, metadataSchemaRequest: MetadataSchemaRequest, options?: any): AxiosPromise<SuccessResponse>;
+};
+/**
+ * Request parameters for addMetadataSchemaToCollection operation in MetadataApi.
+ * @export
+ * @interface MetadataApiAddMetadataSchemaToCollectionRequest
+ */
+export interface MetadataApiAddMetadataSchemaToCollectionRequest {
+    /**
+     * Collection contract address
+     * @type {string}
+     * @memberof MetadataApiAddMetadataSchemaToCollection
+     */
+    readonly address: string;
+    /**
+     * String created by signing wallet address and timestamp
+     * @type {string}
+     * @memberof MetadataApiAddMetadataSchemaToCollection
+     */
+    readonly iMXSignature: string;
+    /**
+     * Unix Epoc timestamp
+     * @type {string}
+     * @memberof MetadataApiAddMetadataSchemaToCollection
+     */
+    readonly iMXTimestamp: string;
+    /**
+     * add metadata schema to a collection
+     * @type {AddMetadataSchemaToCollectionRequest}
+     * @memberof MetadataApiAddMetadataSchemaToCollection
+     */
+    readonly addMetadataSchemaToCollectionRequest: AddMetadataSchemaToCollectionRequest;
+}
+/**
+ * Request parameters for getMetadataSchema operation in MetadataApi.
+ * @export
+ * @interface MetadataApiGetMetadataSchemaRequest
+ */
+export interface MetadataApiGetMetadataSchemaRequest {
+    /**
+     * Collection contract address
+     * @type {string}
+     * @memberof MetadataApiGetMetadataSchema
+     */
+    readonly address: string;
+}
+/**
+ * Request parameters for updateMetadataSchemaByName operation in MetadataApi.
+ * @export
+ * @interface MetadataApiUpdateMetadataSchemaByNameRequest
+ */
+export interface MetadataApiUpdateMetadataSchemaByNameRequest {
+    /**
+     * Collection contract address
+     * @type {string}
+     * @memberof MetadataApiUpdateMetadataSchemaByName
+     */
+    readonly address: string;
+    /**
+     * Metadata schema name
+     * @type {string}
+     * @memberof MetadataApiUpdateMetadataSchemaByName
+     */
+    readonly name: string;
+    /**
+     * String created by signing wallet address and timestamp
+     * @type {string}
+     * @memberof MetadataApiUpdateMetadataSchemaByName
+     */
+    readonly iMXSignature: string;
+    /**
+     * Unix Epoc timestamp
+     * @type {string}
+     * @memberof MetadataApiUpdateMetadataSchemaByName
+     */
+    readonly iMXTimestamp: string;
+    /**
+     * update metadata schema
+     * @type {MetadataSchemaRequest}
+     * @memberof MetadataApiUpdateMetadataSchemaByName
+     */
+    readonly metadataSchemaRequest: MetadataSchemaRequest;
+}
+/**
+ * MetadataApi - object-oriented interface
+ * @export
+ * @class MetadataApi
+ * @extends {BaseAPI}
+ */
+export declare class MetadataApi extends BaseAPI {
+    /**
+     * Add metadata schema to collection
+     * @summary Add metadata schema to collection
+     * @param {MetadataApiAddMetadataSchemaToCollectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataApi
+     */
+    addMetadataSchemaToCollection(requestParameters: MetadataApiAddMetadataSchemaToCollectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponse, any>>;
+    /**
+     * Get collection metadata schema
+     * @summary Get collection metadata schema
+     * @param {MetadataApiGetMetadataSchemaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataApi
+     */
+    getMetadataSchema(requestParameters: MetadataApiGetMetadataSchemaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MetadataSchemaProperty[], any>>;
+    /**
+     * Update metadata schema by name
+     * @summary Update metadata schema by name
+     * @param {MetadataApiUpdateMetadataSchemaByNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetadataApi
+     */
+    updateMetadataSchemaByName(requestParameters: MetadataApiUpdateMetadataSchemaByNameRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponse, any>>;
+}