@imtbl/generated-clients 2.0.0-alpha.0

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

@@ -0,0 +1,668 @@
+/**
+ * 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 { CancelOrderRequest } from '../models';
+import { CancelOrderResponse } from '../models';
+import { CreateOrderRequestV3 } from '../models';
+import { CreateOrderResponse } from '../models';
+import { GetSignableCancelOrderRequest } from '../models';
+import { GetSignableCancelOrderResponse } from '../models';
+import { GetSignableOrderRequestV3 } from '../models';
+import { GetSignableOrderResponse } from '../models';
+import { ListOrdersResponseV3 } from '../models';
+import { OrderV3 } from '../models';
+/**
+ * OrdersApi - axios parameter creator
+ * @export
+ */
+export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Cancel an order (V3)
+     * @summary Cancel an order (V3)
+     * @param {string} id Order ID to cancel
+     * @param {CancelOrderRequest} cancelOrderRequest cancel an order
+     * @param {string} [xImxEthAddress] eth address
+     * @param {string} [xImxEthSignature] eth signature
+     * @param {string} [authorization] Authorization header
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelOrderV3: (id: string, cancelOrderRequest: CancelOrderRequest, xImxEthAddress?: string, xImxEthSignature?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create an order using the v3 orderbook.
+     * @summary Create an order (V3)
+     * @param {CreateOrderRequestV3} createOrderRequest create an order
+     * @param {string} [xImxEthAddress] eth address
+     * @param {string} [xImxEthSignature] eth signature
+     * @param {string} [authorization] Authorization header
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrderV3: (createOrderRequest: CreateOrderRequestV3, xImxEthAddress?: string, xImxEthSignature?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get an order (V3)
+     * @summary Get an order (V3)
+     * @param {string} id Order ID
+     * @param {boolean} [includeFees] Set flag to true to include fee body for the order
+     * @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}
+     */
+    getOrderV3: (id: string, includeFees?: boolean, auxiliaryFeePercentages?: string, auxiliaryFeeRecipients?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Generate a signable cancel order message (V3)
+     * @summary Generate a signable cancel order message (V3)
+     * @param {GetSignableCancelOrderRequest} getSignableCancelOrderRequest get a signable cancel order
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignableCancelOrderV3: (getSignableCancelOrderRequest: GetSignableCancelOrderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Generate a signable order request (V3)
+     * @summary Generate a signable order request (V3)
+     * @param {GetSignableOrderRequestV3} getSignableOrderRequestV3 get a signable order v3
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignableOrder: (getSignableOrderRequestV3: GetSignableOrderRequestV3, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a list of orders (V3)
+     * @summary Get a list of orders (V3)
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {string} [user] Ethereum address of the user who submitted this order
+     * @param {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'} [status] Status of this order
+     * @param {string} [minTimestamp] Filter orders to include those with created_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [maxTimestamp] Filter orders to include those with created_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [updatedMinTimestamp] Filter orders to include those with updated_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [updatedMaxTimestamp] Filter orders to include those with updated_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [buyTokenType] Token type of the asset this order buys
+     * @param {string} [buyTokenId] ERC721 Token ID of the asset this order buys
+     * @param {string} [buyAssetId] Internal IMX ID of the asset this order buys
+     * @param {string} [buyTokenAddress] Token address of the asset this order buys
+     * @param {string} [buyTokenName] Token name of the asset this order buys
+     * @param {string} [buyMinQuantity] Min quantity for the asset this order buys
+     * @param {string} [buyMaxQuantity] Max quantity for the asset this order buys
+     * @param {string} [buyMetadata] JSON-encoded metadata filters for the asset this order buys
+     * @param {string} [sellTokenType] Token type of the asset this order sells
+     * @param {string} [sellTokenId] ERC721 Token ID of the asset this order sells
+     * @param {string} [sellAssetId] Internal IMX ID of the asset this order sells
+     * @param {string} [sellTokenAddress] Token address of the asset this order sells
+     * @param {string} [sellTokenName] Token name of the asset this order sells
+     * @param {string} [sellMinQuantity] Min quantity for the asset this order sells
+     * @param {string} [sellMaxQuantity] Max quantity for the asset this order sells
+     * @param {string} [sellMetadata] JSON-encoded metadata filters for the asset this order sells
+     * @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 {boolean} [includeFees] Set flag to true to include fee object for orders
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrdersV3: (pageSize?: number, cursor?: string, orderBy?: "created_at" | "expired_at" | "sell_quantity" | "buy_quantity" | "buy_quantity_with_fees" | "updated_at", direction?: string, user?: string, status?: "active" | "filled" | "cancelled" | "expired" | "inactive", minTimestamp?: string, maxTimestamp?: string, updatedMinTimestamp?: string, updatedMaxTimestamp?: string, buyTokenType?: string, buyTokenId?: string, buyAssetId?: string, buyTokenAddress?: string, buyTokenName?: string, buyMinQuantity?: string, buyMaxQuantity?: string, buyMetadata?: string, sellTokenType?: string, sellTokenId?: string, sellAssetId?: string, sellTokenAddress?: string, sellTokenName?: string, sellMinQuantity?: string, sellMaxQuantity?: string, sellMetadata?: string, auxiliaryFeePercentages?: string, auxiliaryFeeRecipients?: string, includeFees?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * OrdersApi - functional programming interface
+ * @export
+ */
+export declare const OrdersApiFp: (configuration?: Configuration) => {
+    /**
+     * Cancel an order (V3)
+     * @summary Cancel an order (V3)
+     * @param {string} id Order ID to cancel
+     * @param {CancelOrderRequest} cancelOrderRequest cancel an order
+     * @param {string} [xImxEthAddress] eth address
+     * @param {string} [xImxEthSignature] eth signature
+     * @param {string} [authorization] Authorization header
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelOrderV3(id: string, cancelOrderRequest: CancelOrderRequest, xImxEthAddress?: string, xImxEthSignature?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelOrderResponse>>;
+    /**
+     * Create an order using the v3 orderbook.
+     * @summary Create an order (V3)
+     * @param {CreateOrderRequestV3} createOrderRequest create an order
+     * @param {string} [xImxEthAddress] eth address
+     * @param {string} [xImxEthSignature] eth signature
+     * @param {string} [authorization] Authorization header
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrderV3(createOrderRequest: CreateOrderRequestV3, xImxEthAddress?: string, xImxEthSignature?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderResponse>>;
+    /**
+     * Get an order (V3)
+     * @summary Get an order (V3)
+     * @param {string} id Order ID
+     * @param {boolean} [includeFees] Set flag to true to include fee body for the order
+     * @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}
+     */
+    getOrderV3(id: string, includeFees?: boolean, auxiliaryFeePercentages?: string, auxiliaryFeeRecipients?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderV3>>;
+    /**
+     * Generate a signable cancel order message (V3)
+     * @summary Generate a signable cancel order message (V3)
+     * @param {GetSignableCancelOrderRequest} getSignableCancelOrderRequest get a signable cancel order
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignableCancelOrderV3(getSignableCancelOrderRequest: GetSignableCancelOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSignableCancelOrderResponse>>;
+    /**
+     * Generate a signable order request (V3)
+     * @summary Generate a signable order request (V3)
+     * @param {GetSignableOrderRequestV3} getSignableOrderRequestV3 get a signable order v3
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignableOrder(getSignableOrderRequestV3: GetSignableOrderRequestV3, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSignableOrderResponse>>;
+    /**
+     * Get a list of orders (V3)
+     * @summary Get a list of orders (V3)
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {string} [user] Ethereum address of the user who submitted this order
+     * @param {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'} [status] Status of this order
+     * @param {string} [minTimestamp] Filter orders to include those with created_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [maxTimestamp] Filter orders to include those with created_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [updatedMinTimestamp] Filter orders to include those with updated_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [updatedMaxTimestamp] Filter orders to include those with updated_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [buyTokenType] Token type of the asset this order buys
+     * @param {string} [buyTokenId] ERC721 Token ID of the asset this order buys
+     * @param {string} [buyAssetId] Internal IMX ID of the asset this order buys
+     * @param {string} [buyTokenAddress] Token address of the asset this order buys
+     * @param {string} [buyTokenName] Token name of the asset this order buys
+     * @param {string} [buyMinQuantity] Min quantity for the asset this order buys
+     * @param {string} [buyMaxQuantity] Max quantity for the asset this order buys
+     * @param {string} [buyMetadata] JSON-encoded metadata filters for the asset this order buys
+     * @param {string} [sellTokenType] Token type of the asset this order sells
+     * @param {string} [sellTokenId] ERC721 Token ID of the asset this order sells
+     * @param {string} [sellAssetId] Internal IMX ID of the asset this order sells
+     * @param {string} [sellTokenAddress] Token address of the asset this order sells
+     * @param {string} [sellTokenName] Token name of the asset this order sells
+     * @param {string} [sellMinQuantity] Min quantity for the asset this order sells
+     * @param {string} [sellMaxQuantity] Max quantity for the asset this order sells
+     * @param {string} [sellMetadata] JSON-encoded metadata filters for the asset this order sells
+     * @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 {boolean} [includeFees] Set flag to true to include fee object for orders
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrdersV3(pageSize?: number, cursor?: string, orderBy?: "created_at" | "expired_at" | "sell_quantity" | "buy_quantity" | "buy_quantity_with_fees" | "updated_at", direction?: string, user?: string, status?: "active" | "filled" | "cancelled" | "expired" | "inactive", minTimestamp?: string, maxTimestamp?: string, updatedMinTimestamp?: string, updatedMaxTimestamp?: string, buyTokenType?: string, buyTokenId?: string, buyAssetId?: string, buyTokenAddress?: string, buyTokenName?: string, buyMinQuantity?: string, buyMaxQuantity?: string, buyMetadata?: string, sellTokenType?: string, sellTokenId?: string, sellAssetId?: string, sellTokenAddress?: string, sellTokenName?: string, sellMinQuantity?: string, sellMaxQuantity?: string, sellMetadata?: string, auxiliaryFeePercentages?: string, auxiliaryFeeRecipients?: string, includeFees?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrdersResponseV3>>;
+};
+/**
+ * OrdersApi - factory interface
+ * @export
+ */
+export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Cancel an order (V3)
+     * @summary Cancel an order (V3)
+     * @param {string} id Order ID to cancel
+     * @param {CancelOrderRequest} cancelOrderRequest cancel an order
+     * @param {string} [xImxEthAddress] eth address
+     * @param {string} [xImxEthSignature] eth signature
+     * @param {string} [authorization] Authorization header
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelOrderV3(id: string, cancelOrderRequest: CancelOrderRequest, xImxEthAddress?: string, xImxEthSignature?: string, authorization?: string, options?: any): AxiosPromise<CancelOrderResponse>;
+    /**
+     * Create an order using the v3 orderbook.
+     * @summary Create an order (V3)
+     * @param {CreateOrderRequestV3} createOrderRequest create an order
+     * @param {string} [xImxEthAddress] eth address
+     * @param {string} [xImxEthSignature] eth signature
+     * @param {string} [authorization] Authorization header
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrderV3(createOrderRequest: CreateOrderRequestV3, xImxEthAddress?: string, xImxEthSignature?: string, authorization?: string, options?: any): AxiosPromise<CreateOrderResponse>;
+    /**
+     * Get an order (V3)
+     * @summary Get an order (V3)
+     * @param {string} id Order ID
+     * @param {boolean} [includeFees] Set flag to true to include fee body for the order
+     * @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}
+     */
+    getOrderV3(id: string, includeFees?: boolean, auxiliaryFeePercentages?: string, auxiliaryFeeRecipients?: string, options?: any): AxiosPromise<OrderV3>;
+    /**
+     * Generate a signable cancel order message (V3)
+     * @summary Generate a signable cancel order message (V3)
+     * @param {GetSignableCancelOrderRequest} getSignableCancelOrderRequest get a signable cancel order
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignableCancelOrderV3(getSignableCancelOrderRequest: GetSignableCancelOrderRequest, options?: any): AxiosPromise<GetSignableCancelOrderResponse>;
+    /**
+     * Generate a signable order request (V3)
+     * @summary Generate a signable order request (V3)
+     * @param {GetSignableOrderRequestV3} getSignableOrderRequestV3 get a signable order v3
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSignableOrder(getSignableOrderRequestV3: GetSignableOrderRequestV3, options?: any): AxiosPromise<GetSignableOrderResponse>;
+    /**
+     * Get a list of orders (V3)
+     * @summary Get a list of orders (V3)
+     * @param {number} [pageSize] Page size of the result
+     * @param {string} [cursor] Cursor
+     * @param {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'} [orderBy] Property to sort by
+     * @param {string} [direction] Direction to sort (asc/desc)
+     * @param {string} [user] Ethereum address of the user who submitted this order
+     * @param {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'} [status] Status of this order
+     * @param {string} [minTimestamp] Filter orders to include those with created_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [maxTimestamp] Filter orders to include those with created_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [updatedMinTimestamp] Filter orders to include those with updated_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [updatedMaxTimestamp] Filter orders to include those with updated_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @param {string} [buyTokenType] Token type of the asset this order buys
+     * @param {string} [buyTokenId] ERC721 Token ID of the asset this order buys
+     * @param {string} [buyAssetId] Internal IMX ID of the asset this order buys
+     * @param {string} [buyTokenAddress] Token address of the asset this order buys
+     * @param {string} [buyTokenName] Token name of the asset this order buys
+     * @param {string} [buyMinQuantity] Min quantity for the asset this order buys
+     * @param {string} [buyMaxQuantity] Max quantity for the asset this order buys
+     * @param {string} [buyMetadata] JSON-encoded metadata filters for the asset this order buys
+     * @param {string} [sellTokenType] Token type of the asset this order sells
+     * @param {string} [sellTokenId] ERC721 Token ID of the asset this order sells
+     * @param {string} [sellAssetId] Internal IMX ID of the asset this order sells
+     * @param {string} [sellTokenAddress] Token address of the asset this order sells
+     * @param {string} [sellTokenName] Token name of the asset this order sells
+     * @param {string} [sellMinQuantity] Min quantity for the asset this order sells
+     * @param {string} [sellMaxQuantity] Max quantity for the asset this order sells
+     * @param {string} [sellMetadata] JSON-encoded metadata filters for the asset this order sells
+     * @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 {boolean} [includeFees] Set flag to true to include fee object for orders
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrdersV3(pageSize?: number, cursor?: string, orderBy?: "created_at" | "expired_at" | "sell_quantity" | "buy_quantity" | "buy_quantity_with_fees" | "updated_at", direction?: string, user?: string, status?: "active" | "filled" | "cancelled" | "expired" | "inactive", minTimestamp?: string, maxTimestamp?: string, updatedMinTimestamp?: string, updatedMaxTimestamp?: string, buyTokenType?: string, buyTokenId?: string, buyAssetId?: string, buyTokenAddress?: string, buyTokenName?: string, buyMinQuantity?: string, buyMaxQuantity?: string, buyMetadata?: string, sellTokenType?: string, sellTokenId?: string, sellAssetId?: string, sellTokenAddress?: string, sellTokenName?: string, sellMinQuantity?: string, sellMaxQuantity?: string, sellMetadata?: string, auxiliaryFeePercentages?: string, auxiliaryFeeRecipients?: string, includeFees?: boolean, options?: any): AxiosPromise<ListOrdersResponseV3>;
+};
+/**
+ * Request parameters for cancelOrderV3 operation in OrdersApi.
+ * @export
+ * @interface OrdersApiCancelOrderV3Request
+ */
+export interface OrdersApiCancelOrderV3Request {
+    /**
+     * Order ID to cancel
+     * @type {string}
+     * @memberof OrdersApiCancelOrderV3
+     */
+    readonly id: string;
+    /**
+     * cancel an order
+     * @type {CancelOrderRequest}
+     * @memberof OrdersApiCancelOrderV3
+     */
+    readonly cancelOrderRequest: CancelOrderRequest;
+    /**
+     * eth address
+     * @type {string}
+     * @memberof OrdersApiCancelOrderV3
+     */
+    readonly xImxEthAddress?: string;
+    /**
+     * eth signature
+     * @type {string}
+     * @memberof OrdersApiCancelOrderV3
+     */
+    readonly xImxEthSignature?: string;
+    /**
+     * Authorization header
+     * @type {string}
+     * @memberof OrdersApiCancelOrderV3
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for createOrderV3 operation in OrdersApi.
+ * @export
+ * @interface OrdersApiCreateOrderV3Request
+ */
+export interface OrdersApiCreateOrderV3Request {
+    /**
+     * create an order
+     * @type {CreateOrderRequestV3}
+     * @memberof OrdersApiCreateOrderV3
+     */
+    readonly createOrderRequest: CreateOrderRequestV3;
+    /**
+     * eth address
+     * @type {string}
+     * @memberof OrdersApiCreateOrderV3
+     */
+    readonly xImxEthAddress?: string;
+    /**
+     * eth signature
+     * @type {string}
+     * @memberof OrdersApiCreateOrderV3
+     */
+    readonly xImxEthSignature?: string;
+    /**
+     * Authorization header
+     * @type {string}
+     * @memberof OrdersApiCreateOrderV3
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getOrderV3 operation in OrdersApi.
+ * @export
+ * @interface OrdersApiGetOrderV3Request
+ */
+export interface OrdersApiGetOrderV3Request {
+    /**
+     * Order ID
+     * @type {string}
+     * @memberof OrdersApiGetOrderV3
+     */
+    readonly id: string;
+    /**
+     * Set flag to true to include fee body for the order
+     * @type {boolean}
+     * @memberof OrdersApiGetOrderV3
+     */
+    readonly includeFees?: boolean;
+    /**
+     * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
+     * @type {string}
+     * @memberof OrdersApiGetOrderV3
+     */
+    readonly auxiliaryFeePercentages?: string;
+    /**
+     * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
+     * @type {string}
+     * @memberof OrdersApiGetOrderV3
+     */
+    readonly auxiliaryFeeRecipients?: string;
+}
+/**
+ * Request parameters for getSignableCancelOrderV3 operation in OrdersApi.
+ * @export
+ * @interface OrdersApiGetSignableCancelOrderV3Request
+ */
+export interface OrdersApiGetSignableCancelOrderV3Request {
+    /**
+     * get a signable cancel order
+     * @type {GetSignableCancelOrderRequest}
+     * @memberof OrdersApiGetSignableCancelOrderV3
+     */
+    readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
+}
+/**
+ * Request parameters for getSignableOrder operation in OrdersApi.
+ * @export
+ * @interface OrdersApiGetSignableOrderRequest
+ */
+export interface OrdersApiGetSignableOrderRequest {
+    /**
+     * get a signable order v3
+     * @type {GetSignableOrderRequestV3}
+     * @memberof OrdersApiGetSignableOrder
+     */
+    readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
+}
+/**
+ * Request parameters for listOrdersV3 operation in OrdersApi.
+ * @export
+ * @interface OrdersApiListOrdersV3Request
+ */
+export interface OrdersApiListOrdersV3Request {
+    /**
+     * Page size of the result
+     * @type {number}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly pageSize?: number;
+    /**
+     * Cursor
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly cursor?: string;
+    /**
+     * Property to sort by
+     * @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
+    /**
+     * Direction to sort (asc/desc)
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly direction?: string;
+    /**
+     * Ethereum address of the user who submitted this order
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly user?: string;
+    /**
+     * Status of this order
+     * @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
+    /**
+     * Filter orders to include those with created_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly minTimestamp?: string;
+    /**
+     * Filter orders to include those with created_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly maxTimestamp?: string;
+    /**
+     * Filter orders to include those with updated_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly updatedMinTimestamp?: string;
+    /**
+     * Filter orders to include those with updated_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly updatedMaxTimestamp?: string;
+    /**
+     * Token type of the asset this order buys
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly buyTokenType?: string;
+    /**
+     * ERC721 Token ID of the asset this order buys
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly buyTokenId?: string;
+    /**
+     * Internal IMX ID of the asset this order buys
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly buyAssetId?: string;
+    /**
+     * Token address of the asset this order buys
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly buyTokenAddress?: string;
+    /**
+     * Token name of the asset this order buys
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly buyTokenName?: string;
+    /**
+     * Min quantity for the asset this order buys
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly buyMinQuantity?: string;
+    /**
+     * Max quantity for the asset this order buys
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly buyMaxQuantity?: string;
+    /**
+     * JSON-encoded metadata filters for the asset this order buys
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly buyMetadata?: string;
+    /**
+     * Token type of the asset this order sells
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly sellTokenType?: string;
+    /**
+     * ERC721 Token ID of the asset this order sells
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly sellTokenId?: string;
+    /**
+     * Internal IMX ID of the asset this order sells
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly sellAssetId?: string;
+    /**
+     * Token address of the asset this order sells
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly sellTokenAddress?: string;
+    /**
+     * Token name of the asset this order sells
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly sellTokenName?: string;
+    /**
+     * Min quantity for the asset this order sells
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly sellMinQuantity?: string;
+    /**
+     * Max quantity for the asset this order sells
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly sellMaxQuantity?: string;
+    /**
+     * JSON-encoded metadata filters for the asset this order sells
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly sellMetadata?: string;
+    /**
+     * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly auxiliaryFeePercentages?: string;
+    /**
+     * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
+     * @type {string}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly auxiliaryFeeRecipients?: string;
+    /**
+     * Set flag to true to include fee object for orders
+     * @type {boolean}
+     * @memberof OrdersApiListOrdersV3
+     */
+    readonly includeFees?: boolean;
+}
+/**
+ * OrdersApi - object-oriented interface
+ * @export
+ * @class OrdersApi
+ * @extends {BaseAPI}
+ */
+export declare class OrdersApi extends BaseAPI {
+    /**
+     * Cancel an order (V3)
+     * @summary Cancel an order (V3)
+     * @param {OrdersApiCancelOrderV3Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelOrderResponse, any>>;
+    /**
+     * Create an order using the v3 orderbook.
+     * @summary Create an order (V3)
+     * @param {OrdersApiCreateOrderV3Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    createOrderV3(requestParameters: OrdersApiCreateOrderV3Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderResponse, any>>;
+    /**
+     * Get an order (V3)
+     * @summary Get an order (V3)
+     * @param {OrdersApiGetOrderV3Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    getOrderV3(requestParameters: OrdersApiGetOrderV3Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderV3, any>>;
+    /**
+     * Generate a signable cancel order message (V3)
+     * @summary Generate a signable cancel order message (V3)
+     * @param {OrdersApiGetSignableCancelOrderV3Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    getSignableCancelOrderV3(requestParameters: OrdersApiGetSignableCancelOrderV3Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSignableCancelOrderResponse, any>>;
+    /**
+     * Generate a signable order request (V3)
+     * @summary Generate a signable order request (V3)
+     * @param {OrdersApiGetSignableOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    getSignableOrder(requestParameters: OrdersApiGetSignableOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSignableOrderResponse, any>>;
+    /**
+     * Get a list of orders (V3)
+     * @summary Get a list of orders (V3)
+     * @param {OrdersApiListOrdersV3Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    listOrdersV3(requestParameters?: OrdersApiListOrdersV3Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListOrdersResponseV3, any>>;
+}