@imtbl/sdk 0.4.0-alpha.3 → 0.4.1-alpha

package/dist/checkout_widgets.js

@@ -4,7 +4,7 @@ import { useEffect } from 'react';
 function $parcel$export(e, n, v, s) {
   Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
 }
-const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.4.0-alpha.3";
+const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.4.1-alpha";
 const $d663162fd5a0853f$export$83bf90b30cdfd29f = ()=>false;
 const $d663162fd5a0853f$export$1169f5475725171b = ()=>$d663162fd5a0853f$export$38a083d9fb5551ca;
 

package/dist/immutablex_client.d.ts

@@ -825,7 +825,7 @@ interface TokenData {
      */
     'quantity': string;
     /**
-     * Quantity of this asset with the sum of all fees applied to the asset
+     * [DEPRECATED for v3 endpoints] Quantity of this asset with the sum of all fees applied to the asset. Replaced by quantity_with_fees in maker_fees / taker_fees depending on the type of order. Refer https://docs.x.immutable.com/docs/maker-taker-fees/#new-maker-taker-fields-and-the-deprecation-of-quantity_with_fees-in-buy-and-sell.
      * @type {string}
      * @memberof TokenData
      */
@@ -3688,7 +3688,7 @@ interface GetSignableOrderRequestV3 {
      */
     'amount_sell': string;
     /**
-     * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
      * @type {number}
      * @memberof GetSignableOrderRequestV3
      */
@@ -3787,7 +3787,7 @@ interface GetSignableOrderResponse {
      */
     'asset_id_sell': string;
     /**
-     * Expiration timestamp for this order
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
      * @type {number}
      * @memberof GetSignableOrderResponse
      */
@@ -3948,7 +3948,7 @@ interface GetSignableRegistrationResponse {
  */
 interface GetSignableTradeRequest {
     /**
-     * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
      * @type {number}
      * @memberof GetSignableTradeRequest
      */
@@ -4035,7 +4035,7 @@ interface GetSignableTradeResponse {
      */
     'asset_id_sell': string;
     /**
-     * Expiration timestamp for this order
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
      * @type {number}
      * @memberof GetSignableTradeResponse
      */
@@ -5122,7 +5122,7 @@ interface OrderV3 {
      */
     'expiration_timestamp': string | null;
     /**
-     * Fee information for the order
+     * [DEPRECATED] Fee information for the order. Replaced by maker_fees / taker_fees depending on the type of order. Refer https://docs.x.immutable.com/docs/maker-taker-fees/#new-maker-taker-fields-and-the-deprecation-of-quantity_with_fees-in-buy-and-sell.
      * @type {Array<OrderFeeInfo>}
      * @memberof OrderV3
      */
@@ -8676,10 +8676,11 @@ interface OrdersApiListOrdersV3Request {
  */
 declare class OrdersApi extends BaseAPI {
     /**
-     * Cancel an order. Use https://docs.x.immutable.com/reference#/operations/getSignableCancelOrder to get request body params.
+     * Cancel an order. Use https://docs.x.immutable.com/reference#/operations/getSignableCancelOrder to get request body params.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/cancelOrderV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Cancel an order
      * @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
@@ -8694,10 +8695,11 @@ declare class OrdersApi extends BaseAPI {
      */
     cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
     /**
-     * Create an order. Use https://docs.x.immutable.com/reference#/operations/getSignableOrder to get request body params.
+     * Create an order. Use https://docs.x.immutable.com/reference#/operations/getSignableOrder to get request body params.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/createOrderV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Create an order
      * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
@@ -8712,10 +8714,11 @@ declare class OrdersApi extends BaseAPI {
      */
     createOrderV3(requestParameters: OrdersApiCreateOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
     /**
-     * Get an order
+     * Get an order.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/getOrderV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Get an order
      * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
@@ -8730,17 +8733,18 @@ declare class OrdersApi extends BaseAPI {
      */
     getOrderV3(requestParameters: OrdersApiGetOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<OrderV3, any>>;
     /**
-     * Get a signable cancel order message
-     * @summary Get a signable cancel order message
+     * Sign cancel order message.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/getSignableCancelOrderV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
+     * @summary Sign cancel order message
      * @param {OrdersApiGetSignableCancelOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
     getSignableCancelOrder(requestParameters: OrdersApiGetSignableCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
     /**
-     * Get a signable cancel order message (V3)
-     * @summary Get a signable cancel order message (V3)
+     * 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}
@@ -8748,8 +8752,8 @@ declare class OrdersApi extends BaseAPI {
      */
     getSignableCancelOrderV3(requestParameters: OrdersApiGetSignableCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
     /**
-     * Get a signable order request (V3)
-     * @summary Get a signable order request (V3)
+     * 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}
@@ -8757,10 +8761,11 @@ declare class OrdersApi extends BaseAPI {
      */
     getSignableOrder(requestParameters: OrdersApiGetSignableOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableOrderResponse, any>>;
     /**
-     * Get a list of orders
-     * @summary Get a list of orders
+     * Get a list of orders  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/listOrdersV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
+     * @summary Get a list of orders.
      * @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
@@ -9123,10 +9128,10 @@ interface TradesApiListTradesRequest {
     readonly cursor?: string;
     /**
      * Property to sort by
-     * @type {'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
+     * @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
      * @memberof TradesApiListTrades
      */
-    readonly orderBy?: 'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
+    readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
     /**
      * Direction to sort (asc/desc)
      * @type {string}
@@ -9196,10 +9201,10 @@ interface TradesApiListTradesV3Request {
     readonly cursor?: string;
     /**
      * Property to sort by
-     * @type {'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp'}
+     * @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp'}
      * @memberof TradesApiListTradesV3
      */
-    readonly orderBy?: 'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp';
+    readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp';
     /**
      * Direction to sort (asc/desc)
      * @type {string}
@@ -9227,10 +9232,11 @@ interface TradesApiListTradesV3Request {
  */
 declare class TradesApi extends BaseAPI {
     /**
-     * Create a trade. Use https://docs.x.immutable.com/reference#/operations/getSignableTrade to get request body params.
+     * Create a trade. Use https://docs.x.immutable.com/reference#/operations/getSignableTrade to get request body params.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/createTradeV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Create a Trade between two parties
      * @param {TradesApiCreateTradeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof TradesApi
      */
@@ -9245,8 +9251,8 @@ declare class TradesApi extends BaseAPI {
      */
     createTradeV3(requestParameters: TradesApiCreateTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
     /**
-     * Get a signable trade V3 message
-     * @summary Get a signable trade V3 message
+     * Generate a signable trade message (V3)
+     * @summary Generate a signable trade message (V3)
      * @param {TradesApiGetSignableTradeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -9263,10 +9269,11 @@ declare class TradesApi extends BaseAPI {
      */
     getTrade(requestParameters: TradesApiGetTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
     /**
-     * Get a list of trades
+     * Get a list of trades.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/listTradesV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Get a list of trades
      * @param {TradesApiListTradesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof TradesApi
      */
@@ -9499,7 +9506,7 @@ interface TransfersApiListTransfersRequest {
  */
 declare class TransfersApi extends BaseAPI {
     /**
-     * Create a new transfer request.
+     * Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransfer to get request body params.
      * @summary Creates a transfer of multiple tokens between two parties
      * @param {TransfersApiCreateTransferRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -9508,7 +9515,7 @@ declare class TransfersApi extends BaseAPI {
      */
     createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
     /**
-     * Create a new transfer request.
+     * Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransferV1 to get request body params.
      * @summary Creates a transfer of tokens between two parties
      * @param {TransfersApiCreateTransferV1Request} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/immutablex_client.js

@@ -16,7 +16,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.4.0-alpha.3',
+    sdkVersion: 'ts-immutable-sdk-0.4.1-alpha',
 });
 /**
  * Sets `sdkVersion` at the time of build