@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/imx/domain/nft-checkout-primary-api.d.ts

@@ -0,0 +1,376 @@
+/**
+ * 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 { ContractCreateAPIRequest } from '../models';
+import { ContractCreateResponse } from '../models';
+import { CurrencyWithLimits } from '../models';
+import { NftprimarytransactionCreateAPIRequest } from '../models';
+import { NftprimarytransactionCreateResponse } from '../models';
+import { NftprimarytransactionGetResponse } from '../models';
+import { NftprimarytransactionListTransactionsResponse } from '../models';
+/**
+ * NftCheckoutPrimaryApi - axios parameter creator
+ * @export
+ */
+export declare const NftCheckoutPrimaryApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Creates a transaction representing minting an NFT with a card payment.
+     * @summary Create NFT primary sale transaction
+     * @param {NftprimarytransactionCreateAPIRequest} createAPIRequest req
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createNftPrimary: (createAPIRequest: NftprimarytransactionCreateAPIRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of supported currencies and their limits
+     * @summary Get currencies with limits
+     * @param {'moonpay'} [provider] Provider name
+     * @param {boolean} [includeLimits] Flag if limits should be included in the response or not
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCurrenciesNFTCheckoutPrimary: (provider?: "moonpay", includeLimits?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * given a transaction id, returns the corresponding transaction representing a mint executed from a card payment
+     * @summary Get NFT primary sale transaction by id
+     * @param {string} transactionId Transaction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNftPrimaryTransaction: (transactionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of NFT primary sales transactions
+     * @summary Get a list of NFT primary sales transactions
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {'transaction_id' | 'status' | 'amount' | 'mint_id'} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {string} [transactionId] Transaction id
+     * @param {string} [contractAddress] Contract address of the asset
+     * @param {string} [sellerWalletAddress] Ethereum address of the seller
+     * @param {string} [userWalletAddress] Ethereum address of the user who wants to create transaction
+     * @param {'created' | 'waitingPayment' | 'pending' | 'completed' | 'failed'} [status] Transaction status
+     * @param {'moonpay'} [provider] Checkout provider name
+     * @param {string} [mintId] Minting transaction ID - see mintTokens response
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNftPrimaryTransactions: (pageSize?: number, cursor?: string, orderBy?: "transaction_id" | "status" | "amount" | "mint_id", direction?: string, transactionId?: string, contractAddress?: string, sellerWalletAddress?: string, userWalletAddress?: string, status?: "created" | "waitingPayment" | "pending" | "completed" | "failed", provider?: "moonpay", mintId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Registers a new contract for use in the minting with fiat card flow
+     * @summary Executes NFT primary sales contract registration
+     * @param {ContractCreateAPIRequest} createAPIRequest req
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    registerNftPrimarySalesContract: (createAPIRequest: ContractCreateAPIRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * NftCheckoutPrimaryApi - functional programming interface
+ * @export
+ */
+export declare const NftCheckoutPrimaryApiFp: (configuration?: Configuration) => {
+    /**
+     * Creates a transaction representing minting an NFT with a card payment.
+     * @summary Create NFT primary sale transaction
+     * @param {NftprimarytransactionCreateAPIRequest} createAPIRequest req
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createNftPrimary(createAPIRequest: NftprimarytransactionCreateAPIRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NftprimarytransactionCreateResponse>>;
+    /**
+     * Returns a list of supported currencies and their limits
+     * @summary Get currencies with limits
+     * @param {'moonpay'} [provider] Provider name
+     * @param {boolean} [includeLimits] Flag if limits should be included in the response or not
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCurrenciesNFTCheckoutPrimary(provider?: "moonpay", includeLimits?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CurrencyWithLimits>>;
+    /**
+     * given a transaction id, returns the corresponding transaction representing a mint executed from a card payment
+     * @summary Get NFT primary sale transaction by id
+     * @param {string} transactionId Transaction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNftPrimaryTransaction(transactionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NftprimarytransactionGetResponse>>;
+    /**
+     * Returns a list of NFT primary sales transactions
+     * @summary Get a list of NFT primary sales transactions
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {'transaction_id' | 'status' | 'amount' | 'mint_id'} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {string} [transactionId] Transaction id
+     * @param {string} [contractAddress] Contract address of the asset
+     * @param {string} [sellerWalletAddress] Ethereum address of the seller
+     * @param {string} [userWalletAddress] Ethereum address of the user who wants to create transaction
+     * @param {'created' | 'waitingPayment' | 'pending' | 'completed' | 'failed'} [status] Transaction status
+     * @param {'moonpay'} [provider] Checkout provider name
+     * @param {string} [mintId] Minting transaction ID - see mintTokens response
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNftPrimaryTransactions(pageSize?: number, cursor?: string, orderBy?: "transaction_id" | "status" | "amount" | "mint_id", direction?: string, transactionId?: string, contractAddress?: string, sellerWalletAddress?: string, userWalletAddress?: string, status?: "created" | "waitingPayment" | "pending" | "completed" | "failed", provider?: "moonpay", mintId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NftprimarytransactionListTransactionsResponse>>;
+    /**
+     * Registers a new contract for use in the minting with fiat card flow
+     * @summary Executes NFT primary sales contract registration
+     * @param {ContractCreateAPIRequest} createAPIRequest req
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    registerNftPrimarySalesContract(createAPIRequest: ContractCreateAPIRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContractCreateResponse>>;
+};
+/**
+ * NftCheckoutPrimaryApi - factory interface
+ * @export
+ */
+export declare const NftCheckoutPrimaryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Creates a transaction representing minting an NFT with a card payment.
+     * @summary Create NFT primary sale transaction
+     * @param {NftprimarytransactionCreateAPIRequest} createAPIRequest req
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createNftPrimary(createAPIRequest: NftprimarytransactionCreateAPIRequest, options?: any): AxiosPromise<NftprimarytransactionCreateResponse>;
+    /**
+     * Returns a list of supported currencies and their limits
+     * @summary Get currencies with limits
+     * @param {'moonpay'} [provider] Provider name
+     * @param {boolean} [includeLimits] Flag if limits should be included in the response or not
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCurrenciesNFTCheckoutPrimary(provider?: "moonpay", includeLimits?: boolean, options?: any): AxiosPromise<CurrencyWithLimits>;
+    /**
+     * given a transaction id, returns the corresponding transaction representing a mint executed from a card payment
+     * @summary Get NFT primary sale transaction by id
+     * @param {string} transactionId Transaction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNftPrimaryTransaction(transactionId: string, options?: any): AxiosPromise<NftprimarytransactionGetResponse>;
+    /**
+     * Returns a list of NFT primary sales transactions
+     * @summary Get a list of NFT primary sales transactions
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {'transaction_id' | 'status' | 'amount' | 'mint_id'} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {string} [transactionId] Transaction id
+     * @param {string} [contractAddress] Contract address of the asset
+     * @param {string} [sellerWalletAddress] Ethereum address of the seller
+     * @param {string} [userWalletAddress] Ethereum address of the user who wants to create transaction
+     * @param {'created' | 'waitingPayment' | 'pending' | 'completed' | 'failed'} [status] Transaction status
+     * @param {'moonpay'} [provider] Checkout provider name
+     * @param {string} [mintId] Minting transaction ID - see mintTokens response
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNftPrimaryTransactions(pageSize?: number, cursor?: string, orderBy?: "transaction_id" | "status" | "amount" | "mint_id", direction?: string, transactionId?: string, contractAddress?: string, sellerWalletAddress?: string, userWalletAddress?: string, status?: "created" | "waitingPayment" | "pending" | "completed" | "failed", provider?: "moonpay", mintId?: string, options?: any): AxiosPromise<NftprimarytransactionListTransactionsResponse>;
+    /**
+     * Registers a new contract for use in the minting with fiat card flow
+     * @summary Executes NFT primary sales contract registration
+     * @param {ContractCreateAPIRequest} createAPIRequest req
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    registerNftPrimarySalesContract(createAPIRequest: ContractCreateAPIRequest, options?: any): AxiosPromise<ContractCreateResponse>;
+};
+/**
+ * Request parameters for createNftPrimary operation in NftCheckoutPrimaryApi.
+ * @export
+ * @interface NftCheckoutPrimaryApiCreateNftPrimaryRequest
+ */
+export interface NftCheckoutPrimaryApiCreateNftPrimaryRequest {
+    /**
+     * req
+     * @type {NftprimarytransactionCreateAPIRequest}
+     * @memberof NftCheckoutPrimaryApiCreateNftPrimary
+     */
+    readonly createAPIRequest: NftprimarytransactionCreateAPIRequest;
+}
+/**
+ * Request parameters for getCurrenciesNFTCheckoutPrimary operation in NftCheckoutPrimaryApi.
+ * @export
+ * @interface NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimaryRequest
+ */
+export interface NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimaryRequest {
+    /**
+     * Provider name
+     * @type {'moonpay'}
+     * @memberof NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimary
+     */
+    readonly provider?: 'moonpay';
+    /**
+     * Flag if limits should be included in the response or not
+     * @type {boolean}
+     * @memberof NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimary
+     */
+    readonly includeLimits?: boolean;
+}
+/**
+ * Request parameters for getNftPrimaryTransaction operation in NftCheckoutPrimaryApi.
+ * @export
+ * @interface NftCheckoutPrimaryApiGetNftPrimaryTransactionRequest
+ */
+export interface NftCheckoutPrimaryApiGetNftPrimaryTransactionRequest {
+    /**
+     * Transaction id
+     * @type {string}
+     * @memberof NftCheckoutPrimaryApiGetNftPrimaryTransaction
+     */
+    readonly transactionId: string;
+}
+/**
+ * Request parameters for getNftPrimaryTransactions operation in NftCheckoutPrimaryApi.
+ * @export
+ * @interface NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest
+ */
+export interface NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest {
+    /**
+     * Page size of the result
+     * @type {number}
+     * @memberof NftCheckoutPrimaryApiGetNftPrimaryTransactions
+     */
+    readonly pageSize?: number;
+    /**
+     * Cursor
+     * @type {string}
+     * @memberof NftCheckoutPrimaryApiGetNftPrimaryTransactions
+     */
+    readonly cursor?: string;
+    /**
+     * Property to sort by
+     * @type {'transaction_id' | 'status' | 'amount' | 'mint_id'}
+     * @memberof NftCheckoutPrimaryApiGetNftPrimaryTransactions
+     */
+    readonly orderBy?: 'transaction_id' | 'status' | 'amount' | 'mint_id';
+    /**
+     * Direction to sort (asc/desc)
+     * @type {string}
+     * @memberof NftCheckoutPrimaryApiGetNftPrimaryTransactions
+     */
+    readonly direction?: string;
+    /**
+     * Transaction id
+     * @type {string}
+     * @memberof NftCheckoutPrimaryApiGetNftPrimaryTransactions
+     */
+    readonly transactionId?: string;
+    /**
+     * Contract address of the asset
+     * @type {string}
+     * @memberof NftCheckoutPrimaryApiGetNftPrimaryTransactions
+     */
+    readonly contractAddress?: string;
+    /**
+     * Ethereum address of the seller
+     * @type {string}
+     * @memberof NftCheckoutPrimaryApiGetNftPrimaryTransactions
+     */
+    readonly sellerWalletAddress?: string;
+    /**
+     * Ethereum address of the user who wants to create transaction
+     * @type {string}
+     * @memberof NftCheckoutPrimaryApiGetNftPrimaryTransactions
+     */
+    readonly userWalletAddress?: string;
+    /**
+     * Transaction status
+     * @type {'created' | 'waitingPayment' | 'pending' | 'completed' | 'failed'}
+     * @memberof NftCheckoutPrimaryApiGetNftPrimaryTransactions
+     */
+    readonly status?: 'created' | 'waitingPayment' | 'pending' | 'completed' | 'failed';
+    /**
+     * Checkout provider name
+     * @type {'moonpay'}
+     * @memberof NftCheckoutPrimaryApiGetNftPrimaryTransactions
+     */
+    readonly provider?: 'moonpay';
+    /**
+     * Minting transaction ID - see mintTokens response
+     * @type {string}
+     * @memberof NftCheckoutPrimaryApiGetNftPrimaryTransactions
+     */
+    readonly mintId?: string;
+}
+/**
+ * Request parameters for registerNftPrimarySalesContract operation in NftCheckoutPrimaryApi.
+ * @export
+ * @interface NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest
+ */
+export interface NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest {
+    /**
+     * req
+     * @type {ContractCreateAPIRequest}
+     * @memberof NftCheckoutPrimaryApiRegisterNftPrimarySalesContract
+     */
+    readonly createAPIRequest: ContractCreateAPIRequest;
+}
+/**
+ * NftCheckoutPrimaryApi - object-oriented interface
+ * @export
+ * @class NftCheckoutPrimaryApi
+ * @extends {BaseAPI}
+ */
+export declare class NftCheckoutPrimaryApi extends BaseAPI {
+    /**
+     * Creates a transaction representing minting an NFT with a card payment.
+     * @summary Create NFT primary sale transaction
+     * @param {NftCheckoutPrimaryApiCreateNftPrimaryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftCheckoutPrimaryApi
+     */
+    createNftPrimary(requestParameters: NftCheckoutPrimaryApiCreateNftPrimaryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NftprimarytransactionCreateResponse, any>>;
+    /**
+     * Returns a list of supported currencies and their limits
+     * @summary Get currencies with limits
+     * @param {NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimaryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftCheckoutPrimaryApi
+     */
+    getCurrenciesNFTCheckoutPrimary(requestParameters?: NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimaryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CurrencyWithLimits, any>>;
+    /**
+     * given a transaction id, returns the corresponding transaction representing a mint executed from a card payment
+     * @summary Get NFT primary sale transaction by id
+     * @param {NftCheckoutPrimaryApiGetNftPrimaryTransactionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftCheckoutPrimaryApi
+     */
+    getNftPrimaryTransaction(requestParameters: NftCheckoutPrimaryApiGetNftPrimaryTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NftprimarytransactionGetResponse, any>>;
+    /**
+     * Returns a list of NFT primary sales transactions
+     * @summary Get a list of NFT primary sales transactions
+     * @param {NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftCheckoutPrimaryApi
+     */
+    getNftPrimaryTransactions(requestParameters?: NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NftprimarytransactionListTransactionsResponse, any>>;
+    /**
+     * Registers a new contract for use in the minting with fiat card flow
+     * @summary Executes NFT primary sales contract registration
+     * @param {NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftCheckoutPrimaryApi
+     */
+    registerNftPrimarySalesContract(requestParameters: NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ContractCreateResponse, any>>;
+}