@imtbl/generated-clients 2.0.0-alpha.0

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

@@ -0,0 +1,287 @@
+/**
+ * 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 { Asset } from '../models';
+import { ListAssetsResponse } from '../models';
+/**
+ * AssetsApi - axios parameter creator
+ * @export
+ */
+export declare const AssetsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get details of an asset
+     * @summary Get details of an asset
+     * @param {string} tokenAddress Address of the ERC721 contract
+     * @param {string} tokenId Either ERC721 token ID or internal IMX ID
+     * @param {boolean} [includeFees] Set flag to include fees associated with the asset
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAsset: (tokenAddress: string, tokenId: string, includeFees?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a list of assets
+     * @summary Get a list of assets
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {'updated_at' | 'name'} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {string} [user] Comma separated list of ethereum address of the users who own these assets
+     * @param {'eth' | 'imx' | 'preparing_withdrawal' | 'withdrawable' | 'burned'} [status] Status of these assets
+     * @param {string} [name] Name of the asset to search
+     * @param {string} [metadata] URL JSON-encoded metadata filters for these assets. Javascript example: encodeURI(JSON.stringify({\&#39;proto\&#39;:[\&#39;1147\&#39;],\&#39;quality\&#39;:[\&#39;Meteorite\&#39;]}))
+     * @param {boolean} [sellOrders] Set flag to true to fetch an array of sell order details with accepted status associated with the asset
+     * @param {boolean} [buyOrders] Set flag to true to fetch an array of buy order details  with accepted status associated with the asset
+     * @param {boolean} [includeFees] Set flag to include fees associated with the asset
+     * @param {string} [collection] Comma separated list of the collections contract address
+     * @param {string} [updatedMinTimestamp] Minimum timestamp for when these assets were last updated, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [updatedMaxTimestamp] Maximum timestamp for when these assets were last updated, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [auxiliaryFeePercentages] Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
+     * @param {string} [auxiliaryFeeRecipients] Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAssets: (pageSize?: number, cursor?: string, orderBy?: "updated_at" | "name", direction?: string, user?: string, status?: "eth" | "imx" | "preparing_withdrawal" | "withdrawable" | "burned", name?: string, metadata?: string, sellOrders?: boolean, buyOrders?: boolean, includeFees?: boolean, collection?: string, updatedMinTimestamp?: string, updatedMaxTimestamp?: string, auxiliaryFeePercentages?: string, auxiliaryFeeRecipients?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AssetsApi - functional programming interface
+ * @export
+ */
+export declare const AssetsApiFp: (configuration?: Configuration) => {
+    /**
+     * Get details of an asset
+     * @summary Get details of an asset
+     * @param {string} tokenAddress Address of the ERC721 contract
+     * @param {string} tokenId Either ERC721 token ID or internal IMX ID
+     * @param {boolean} [includeFees] Set flag to include fees associated with the asset
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAsset(tokenAddress: string, tokenId: string, includeFees?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Asset>>;
+    /**
+     * Get a list of assets
+     * @summary Get a list of assets
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {'updated_at' | 'name'} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {string} [user] Comma separated list of ethereum address of the users who own these assets
+     * @param {'eth' | 'imx' | 'preparing_withdrawal' | 'withdrawable' | 'burned'} [status] Status of these assets
+     * @param {string} [name] Name of the asset to search
+     * @param {string} [metadata] URL JSON-encoded metadata filters for these assets. Javascript example: encodeURI(JSON.stringify({\&#39;proto\&#39;:[\&#39;1147\&#39;],\&#39;quality\&#39;:[\&#39;Meteorite\&#39;]}))
+     * @param {boolean} [sellOrders] Set flag to true to fetch an array of sell order details with accepted status associated with the asset
+     * @param {boolean} [buyOrders] Set flag to true to fetch an array of buy order details  with accepted status associated with the asset
+     * @param {boolean} [includeFees] Set flag to include fees associated with the asset
+     * @param {string} [collection] Comma separated list of the collections contract address
+     * @param {string} [updatedMinTimestamp] Minimum timestamp for when these assets were last updated, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [updatedMaxTimestamp] Maximum timestamp for when these assets were last updated, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [auxiliaryFeePercentages] Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
+     * @param {string} [auxiliaryFeeRecipients] Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAssets(pageSize?: number, cursor?: string, orderBy?: "updated_at" | "name", direction?: string, user?: string, status?: "eth" | "imx" | "preparing_withdrawal" | "withdrawable" | "burned", name?: string, metadata?: string, sellOrders?: boolean, buyOrders?: boolean, includeFees?: boolean, collection?: string, updatedMinTimestamp?: string, updatedMaxTimestamp?: string, auxiliaryFeePercentages?: string, auxiliaryFeeRecipients?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAssetsResponse>>;
+};
+/**
+ * AssetsApi - factory interface
+ * @export
+ */
+export declare const AssetsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get details of an asset
+     * @summary Get details of an asset
+     * @param {string} tokenAddress Address of the ERC721 contract
+     * @param {string} tokenId Either ERC721 token ID or internal IMX ID
+     * @param {boolean} [includeFees] Set flag to include fees associated with the asset
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAsset(tokenAddress: string, tokenId: string, includeFees?: boolean, options?: any): AxiosPromise<Asset>;
+    /**
+     * Get a list of assets
+     * @summary Get a list of assets
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {'updated_at' | 'name'} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {string} [user] Comma separated list of ethereum address of the users who own these assets
+     * @param {'eth' | 'imx' | 'preparing_withdrawal' | 'withdrawable' | 'burned'} [status] Status of these assets
+     * @param {string} [name] Name of the asset to search
+     * @param {string} [metadata] URL JSON-encoded metadata filters for these assets. Javascript example: encodeURI(JSON.stringify({\&#39;proto\&#39;:[\&#39;1147\&#39;],\&#39;quality\&#39;:[\&#39;Meteorite\&#39;]}))
+     * @param {boolean} [sellOrders] Set flag to true to fetch an array of sell order details with accepted status associated with the asset
+     * @param {boolean} [buyOrders] Set flag to true to fetch an array of buy order details  with accepted status associated with the asset
+     * @param {boolean} [includeFees] Set flag to include fees associated with the asset
+     * @param {string} [collection] Comma separated list of the collections contract address
+     * @param {string} [updatedMinTimestamp] Minimum timestamp for when these assets were last updated, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [updatedMaxTimestamp] Maximum timestamp for when these assets were last updated, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [auxiliaryFeePercentages] Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
+     * @param {string} [auxiliaryFeeRecipients] Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAssets(pageSize?: number, cursor?: string, orderBy?: "updated_at" | "name", direction?: string, user?: string, status?: "eth" | "imx" | "preparing_withdrawal" | "withdrawable" | "burned", name?: string, metadata?: string, sellOrders?: boolean, buyOrders?: boolean, includeFees?: boolean, collection?: string, updatedMinTimestamp?: string, updatedMaxTimestamp?: string, auxiliaryFeePercentages?: string, auxiliaryFeeRecipients?: string, options?: any): AxiosPromise<ListAssetsResponse>;
+};
+/**
+ * Request parameters for getAsset operation in AssetsApi.
+ * @export
+ * @interface AssetsApiGetAssetRequest
+ */
+export interface AssetsApiGetAssetRequest {
+    /**
+     * Address of the ERC721 contract
+     * @type {string}
+     * @memberof AssetsApiGetAsset
+     */
+    readonly tokenAddress: string;
+    /**
+     * Either ERC721 token ID or internal IMX ID
+     * @type {string}
+     * @memberof AssetsApiGetAsset
+     */
+    readonly tokenId: string;
+    /**
+     * Set flag to include fees associated with the asset
+     * @type {boolean}
+     * @memberof AssetsApiGetAsset
+     */
+    readonly includeFees?: boolean;
+}
+/**
+ * Request parameters for listAssets operation in AssetsApi.
+ * @export
+ * @interface AssetsApiListAssetsRequest
+ */
+export interface AssetsApiListAssetsRequest {
+    /**
+     * Page size of the result
+     * @type {number}
+     * @memberof AssetsApiListAssets
+     */
+    readonly pageSize?: number;
+    /**
+     * Cursor
+     * @type {string}
+     * @memberof AssetsApiListAssets
+     */
+    readonly cursor?: string;
+    /**
+     * Property to sort by
+     * @type {'updated_at' | 'name'}
+     * @memberof AssetsApiListAssets
+     */
+    readonly orderBy?: 'updated_at' | 'name';
+    /**
+     * Direction to sort (asc/desc)
+     * @type {string}
+     * @memberof AssetsApiListAssets
+     */
+    readonly direction?: string;
+    /**
+     * Comma separated list of ethereum address of the users who own these assets
+     * @type {string}
+     * @memberof AssetsApiListAssets
+     */
+    readonly user?: string;
+    /**
+     * Status of these assets
+     * @type {'eth' | 'imx' | 'preparing_withdrawal' | 'withdrawable' | 'burned'}
+     * @memberof AssetsApiListAssets
+     */
+    readonly status?: 'eth' | 'imx' | 'preparing_withdrawal' | 'withdrawable' | 'burned';
+    /**
+     * Name of the asset to search
+     * @type {string}
+     * @memberof AssetsApiListAssets
+     */
+    readonly name?: string;
+    /**
+     * URL JSON-encoded metadata filters for these assets. Javascript example: encodeURI(JSON.stringify({\&#39;proto\&#39;:[\&#39;1147\&#39;],\&#39;quality\&#39;:[\&#39;Meteorite\&#39;]}))
+     * @type {string}
+     * @memberof AssetsApiListAssets
+     */
+    readonly metadata?: string;
+    /**
+     * Set flag to true to fetch an array of sell order details with accepted status associated with the asset
+     * @type {boolean}
+     * @memberof AssetsApiListAssets
+     */
+    readonly sellOrders?: boolean;
+    /**
+     * Set flag to true to fetch an array of buy order details  with accepted status associated with the asset
+     * @type {boolean}
+     * @memberof AssetsApiListAssets
+     */
+    readonly buyOrders?: boolean;
+    /**
+     * Set flag to include fees associated with the asset
+     * @type {boolean}
+     * @memberof AssetsApiListAssets
+     */
+    readonly includeFees?: boolean;
+    /**
+     * Comma separated list of the collections contract address
+     * @type {string}
+     * @memberof AssetsApiListAssets
+     */
+    readonly collection?: string;
+    /**
+     * Minimum timestamp for when these assets were last updated, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @type {string}
+     * @memberof AssetsApiListAssets
+     */
+    readonly updatedMinTimestamp?: string;
+    /**
+     * Maximum timestamp for when these assets were last updated, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @type {string}
+     * @memberof AssetsApiListAssets
+     */
+    readonly updatedMaxTimestamp?: string;
+    /**
+     * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
+     * @type {string}
+     * @memberof AssetsApiListAssets
+     */
+    readonly auxiliaryFeePercentages?: string;
+    /**
+     * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
+     * @type {string}
+     * @memberof AssetsApiListAssets
+     */
+    readonly auxiliaryFeeRecipients?: string;
+}
+/**
+ * AssetsApi - object-oriented interface
+ * @export
+ * @class AssetsApi
+ * @extends {BaseAPI}
+ */
+export declare class AssetsApi extends BaseAPI {
+    /**
+     * Get details of an asset
+     * @summary Get details of an asset
+     * @param {AssetsApiGetAssetRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssetsApi
+     */
+    getAsset(requestParameters: AssetsApiGetAssetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Asset, any>>;
+    /**
+     * Get a list of assets
+     * @summary Get a list of assets
+     * @param {AssetsApiListAssetsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssetsApi
+     */
+    listAssets(requestParameters?: AssetsApiListAssetsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAssetsResponse, any>>;
+}

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

@@ -0,0 +1,179 @@
+/**
+ * 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 { Balance } from '../models';
+import { ListBalancesResponse } from '../models';
+/**
+ * BalancesApi - axios parameter creator
+ * @export
+ */
+export declare const BalancesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Fetches the token balances of the user
+     * @summary Fetches the token balances of the user
+     * @param {string} owner Address of the owner/user
+     * @param {string} address Token address or \'eth\'
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBalance: (owner: string, address: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a list of balances for given user
+     * @summary Get a list of balances for given user
+     * @param {string} owner Ethereum wallet address for user
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {string} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBalances: (owner: string, pageSize?: number, cursor?: string, orderBy?: string, direction?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * BalancesApi - functional programming interface
+ * @export
+ */
+export declare const BalancesApiFp: (configuration?: Configuration) => {
+    /**
+     * Fetches the token balances of the user
+     * @summary Fetches the token balances of the user
+     * @param {string} owner Address of the owner/user
+     * @param {string} address Token address or \&#39;eth\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBalance(owner: string, address: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Balance>>;
+    /**
+     * Get a list of balances for given user
+     * @summary Get a list of balances for given user
+     * @param {string} owner Ethereum wallet address for user
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {string} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBalances(owner: string, pageSize?: number, cursor?: string, orderBy?: string, direction?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBalancesResponse>>;
+};
+/**
+ * BalancesApi - factory interface
+ * @export
+ */
+export declare const BalancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Fetches the token balances of the user
+     * @summary Fetches the token balances of the user
+     * @param {string} owner Address of the owner/user
+     * @param {string} address Token address or \&#39;eth\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBalance(owner: string, address: string, options?: any): AxiosPromise<Balance>;
+    /**
+     * Get a list of balances for given user
+     * @summary Get a list of balances for given user
+     * @param {string} owner Ethereum wallet address for user
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {string} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBalances(owner: string, pageSize?: number, cursor?: string, orderBy?: string, direction?: string, options?: any): AxiosPromise<ListBalancesResponse>;
+};
+/**
+ * Request parameters for getBalance operation in BalancesApi.
+ * @export
+ * @interface BalancesApiGetBalanceRequest
+ */
+export interface BalancesApiGetBalanceRequest {
+    /**
+     * Address of the owner/user
+     * @type {string}
+     * @memberof BalancesApiGetBalance
+     */
+    readonly owner: string;
+    /**
+     * Token address or \&#39;eth\&#39;
+     * @type {string}
+     * @memberof BalancesApiGetBalance
+     */
+    readonly address: string;
+}
+/**
+ * Request parameters for listBalances operation in BalancesApi.
+ * @export
+ * @interface BalancesApiListBalancesRequest
+ */
+export interface BalancesApiListBalancesRequest {
+    /**
+     * Ethereum wallet address for user
+     * @type {string}
+     * @memberof BalancesApiListBalances
+     */
+    readonly owner: string;
+    /**
+     * Page size of the result
+     * @type {number}
+     * @memberof BalancesApiListBalances
+     */
+    readonly pageSize?: number;
+    /**
+     * Cursor
+     * @type {string}
+     * @memberof BalancesApiListBalances
+     */
+    readonly cursor?: string;
+    /**
+     * Property to sort by
+     * @type {string}
+     * @memberof BalancesApiListBalances
+     */
+    readonly orderBy?: string;
+    /**
+     * Direction to sort (asc/desc)
+     * @type {string}
+     * @memberof BalancesApiListBalances
+     */
+    readonly direction?: string;
+}
+/**
+ * BalancesApi - object-oriented interface
+ * @export
+ * @class BalancesApi
+ * @extends {BaseAPI}
+ */
+export declare class BalancesApi extends BaseAPI {
+    /**
+     * Fetches the token balances of the user
+     * @summary Fetches the token balances of the user
+     * @param {BalancesApiGetBalanceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BalancesApi
+     */
+    getBalance(requestParameters: BalancesApiGetBalanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Balance, any>>;
+    /**
+     * Get a list of balances for given user
+     * @summary Get a list of balances for given user
+     * @param {BalancesApiListBalancesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BalancesApi
+     */
+    listBalances(requestParameters: BalancesApiListBalancesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBalancesResponse, any>>;
+}