@imtbl/sdk 0.28.2 → 0.28.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,10 +6,14 @@ declare enum Environment {
6
6
  }
7
7
  declare class ImmutableConfiguration {
8
8
  readonly environment: Environment;
9
+ readonly rateLimitingKey?: string;
9
10
  readonly apiKey?: string;
11
+ readonly clientAppId?: string;
10
12
  constructor(options: {
11
13
  environment: Environment;
14
+ rateLimitingKey?: string;
12
15
  apiKey?: string;
16
+ clientAppId?: string;
13
17
  });
14
18
  }
15
19
  interface ModuleConfiguration<T> {
@@ -1060,6 +1064,25 @@ interface CollectionDetails {
1060
1064
  'name': string;
1061
1065
  }
1062
1066
 
1067
+ /**
1068
+ * Immutable X API
1069
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1070
+ *
1071
+ * The version of the OpenAPI document: 3.0
1072
+ * Contact: support@immutable.com
1073
+ *
1074
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1075
+ * https://openapi-generator.tech
1076
+ * Do not edit the class manually.
1077
+ */
1078
+
1079
+ /**
1080
+ * @type AssetPropertiesCollection
1081
+ * Details of this asset\'s collection
1082
+ * @export
1083
+ */
1084
+ declare type AssetPropertiesCollection = CollectionDetails;
1085
+
1063
1086
  /**
1064
1087
  * Immutable X API
1065
1088
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1080,10 +1103,10 @@ interface CollectionDetails {
1080
1103
  interface AssetProperties {
1081
1104
  /**
1082
1105
  *
1083
- * @type {CollectionDetails}
1106
+ * @type {AssetPropertiesCollection}
1084
1107
  * @memberof AssetProperties
1085
1108
  */
1086
- 'collection'?: CollectionDetails;
1109
+ 'collection'?: AssetPropertiesCollection;
1087
1110
  /**
1088
1111
  * Image URL of this asset
1089
1112
  * @type {string}
@@ -1267,6 +1290,25 @@ interface FeeData {
1267
1290
  'decimals'?: number;
1268
1291
  }
1269
1292
 
1293
+ /**
1294
+ * Immutable X API
1295
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1296
+ *
1297
+ * The version of the OpenAPI document: 3.0
1298
+ * Contact: support@immutable.com
1299
+ *
1300
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1301
+ * https://openapi-generator.tech
1302
+ * Do not edit the class manually.
1303
+ */
1304
+
1305
+ /**
1306
+ * @type FeeTokenData
1307
+ * Fee token data details
1308
+ * @export
1309
+ */
1310
+ declare type FeeTokenData = FeeData;
1311
+
1270
1312
  /**
1271
1313
  * Immutable X API
1272
1314
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1287,10 +1329,10 @@ interface FeeData {
1287
1329
  interface FeeToken {
1288
1330
  /**
1289
1331
  *
1290
- * @type {FeeData}
1332
+ * @type {FeeTokenData}
1291
1333
  * @memberof FeeToken
1292
1334
  */
1293
- 'data'?: FeeData;
1335
+ 'data'?: FeeTokenData;
1294
1336
  /**
1295
1337
  * Fee token type. One of ETH/ERC20
1296
1338
  * @type {string}
@@ -1424,29 +1466,48 @@ interface ApiRegisterPassportUserRequest {
1424
1466
  /**
1425
1467
  *
1426
1468
  * @export
1427
- * @interface Fee
1469
+ * @interface ApiSDKVersionCheckResponse
1428
1470
  */
1429
- interface Fee {
1471
+ interface ApiSDKVersionCheckResponse {
1430
1472
  /**
1431
- * Wallet address
1473
+ *
1432
1474
  * @type {string}
1433
- * @memberof Fee
1475
+ * @memberof ApiSDKVersionCheckResponse
1434
1476
  */
1435
- 'address': string;
1477
+ 'message'?: string;
1436
1478
  /**
1437
- * The percentage of fee
1438
- * @type {number}
1439
- * @memberof Fee
1479
+ *
1480
+ * @type {boolean}
1481
+ * @memberof ApiSDKVersionCheckResponse
1440
1482
  */
1441
- 'percentage': number;
1483
+ 'ok'?: boolean;
1442
1484
  /**
1443
- * Type of fee. Examples: `royalty`, `maker`, `taker` or `protocol`
1485
+ *
1444
1486
  * @type {string}
1445
- * @memberof Fee
1487
+ * @memberof ApiSDKVersionCheckResponse
1446
1488
  */
1447
- 'type': string;
1489
+ 'runtimeId'?: string;
1448
1490
  }
1449
1491
 
1492
+ /**
1493
+ * Immutable X API
1494
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1495
+ *
1496
+ * The version of the OpenAPI document: 3.0
1497
+ * Contact: support@immutable.com
1498
+ *
1499
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1500
+ * https://openapi-generator.tech
1501
+ * Do not edit the class manually.
1502
+ */
1503
+
1504
+ /**
1505
+ * @type AssetCollection
1506
+ * Information about the collection to which this asset belongs
1507
+ * @export
1508
+ */
1509
+ declare type AssetCollection = CollectionDetails;
1510
+
1450
1511
  /**
1451
1512
  * Immutable X API
1452
1513
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1478,6 +1539,62 @@ interface OrderDetails {
1478
1539
  'sell_orders'?: Array<object>;
1479
1540
  }
1480
1541
 
1542
+ /**
1543
+ * Immutable X API
1544
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1545
+ *
1546
+ * The version of the OpenAPI document: 3.0
1547
+ * Contact: support@immutable.com
1548
+ *
1549
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1550
+ * https://openapi-generator.tech
1551
+ * Do not edit the class manually.
1552
+ */
1553
+
1554
+ /**
1555
+ * @type AssetOrders
1556
+ * [DEPRECATED] Open orders for this asset will always return empty. Use GET /orders
1557
+ * @export
1558
+ */
1559
+ declare type AssetOrders = OrderDetails;
1560
+
1561
+ /**
1562
+ * Immutable X API
1563
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1564
+ *
1565
+ * The version of the OpenAPI document: 3.0
1566
+ * Contact: support@immutable.com
1567
+ *
1568
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1569
+ * https://openapi-generator.tech
1570
+ * Do not edit the class manually.
1571
+ */
1572
+ /**
1573
+ *
1574
+ * @export
1575
+ * @interface Fee
1576
+ */
1577
+ interface Fee {
1578
+ /**
1579
+ * Wallet address
1580
+ * @type {string}
1581
+ * @memberof Fee
1582
+ */
1583
+ 'address': string;
1584
+ /**
1585
+ * The percentage of fee
1586
+ * @type {number}
1587
+ * @memberof Fee
1588
+ */
1589
+ 'percentage': number;
1590
+ /**
1591
+ * Type of fee. Examples: `royalty`, `maker`, `taker` or `protocol`
1592
+ * @type {string}
1593
+ * @memberof Fee
1594
+ */
1595
+ 'type': string;
1596
+ }
1597
+
1481
1598
  /**
1482
1599
  * Immutable X API
1483
1600
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1498,10 +1615,10 @@ interface OrderDetails {
1498
1615
  interface Asset {
1499
1616
  /**
1500
1617
  *
1501
- * @type {CollectionDetails}
1618
+ * @type {AssetCollection}
1502
1619
  * @memberof Asset
1503
1620
  */
1504
- 'collection': CollectionDetails;
1621
+ 'collection': AssetCollection;
1505
1622
  /**
1506
1623
  * Timestamp of when the asset was created
1507
1624
  * @type {string}
@@ -1546,10 +1663,10 @@ interface Asset {
1546
1663
  'name': string | null;
1547
1664
  /**
1548
1665
  *
1549
- * @type {OrderDetails}
1666
+ * @type {AssetOrders}
1550
1667
  * @memberof Asset
1551
1668
  */
1552
- 'orders'?: OrderDetails;
1669
+ 'orders'?: AssetOrders;
1553
1670
  /**
1554
1671
  * Status of this asset (where it is in the system)
1555
1672
  * @type {string}
@@ -1588,6 +1705,44 @@ interface Asset {
1588
1705
  'user': string;
1589
1706
  }
1590
1707
 
1708
+ /**
1709
+ * Immutable X API
1710
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1711
+ *
1712
+ * The version of the OpenAPI document: 3.0
1713
+ * Contact: support@immutable.com
1714
+ *
1715
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1716
+ * https://openapi-generator.tech
1717
+ * Do not edit the class manually.
1718
+ */
1719
+
1720
+ /**
1721
+ * @type AssetWithOrdersCollection
1722
+ * Information about the collection to which this asset belongs
1723
+ * @export
1724
+ */
1725
+ declare type AssetWithOrdersCollection = CollectionDetails;
1726
+
1727
+ /**
1728
+ * Immutable X API
1729
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1730
+ *
1731
+ * The version of the OpenAPI document: 3.0
1732
+ * Contact: support@immutable.com
1733
+ *
1734
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1735
+ * https://openapi-generator.tech
1736
+ * Do not edit the class manually.
1737
+ */
1738
+
1739
+ /**
1740
+ * @type AssetWithOrdersOrders
1741
+ * Open orders for this asset
1742
+ * @export
1743
+ */
1744
+ declare type AssetWithOrdersOrders = OrderDetails;
1745
+
1591
1746
  /**
1592
1747
  * Immutable X API
1593
1748
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1608,10 +1763,10 @@ interface Asset {
1608
1763
  interface AssetWithOrders {
1609
1764
  /**
1610
1765
  *
1611
- * @type {CollectionDetails}
1766
+ * @type {AssetWithOrdersCollection}
1612
1767
  * @memberof AssetWithOrders
1613
1768
  */
1614
- 'collection': CollectionDetails;
1769
+ 'collection': AssetWithOrdersCollection;
1615
1770
  /**
1616
1771
  * Timestamp of when the asset was created
1617
1772
  * @type {string}
@@ -1656,10 +1811,10 @@ interface AssetWithOrders {
1656
1811
  'name': string | null;
1657
1812
  /**
1658
1813
  *
1659
- * @type {OrderDetails}
1814
+ * @type {AssetWithOrdersOrders}
1660
1815
  * @memberof AssetWithOrders
1661
1816
  */
1662
- 'orders'?: OrderDetails;
1817
+ 'orders'?: AssetWithOrdersOrders;
1663
1818
  /**
1664
1819
  * Status of this asset (where it is in the system)
1665
1820
  * @type {string}
@@ -1919,6 +2074,25 @@ interface Range {
1919
2074
  'min'?: number;
1920
2075
  }
1921
2076
 
2077
+ /**
2078
+ * Immutable X API
2079
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2080
+ *
2081
+ * The version of the OpenAPI document: 3.0
2082
+ * Contact: support@immutable.com
2083
+ *
2084
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2085
+ * https://openapi-generator.tech
2086
+ * Do not edit the class manually.
2087
+ */
2088
+
2089
+ /**
2090
+ * @type CollectionFilterRange
2091
+ * Range of values for this property
2092
+ * @export
2093
+ */
2094
+ declare type CollectionFilterRange = Range;
2095
+
1922
2096
  /**
1923
2097
  * Immutable X API
1924
2098
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1945,10 +2119,10 @@ interface CollectionFilter {
1945
2119
  'key'?: string;
1946
2120
  /**
1947
2121
  *
1948
- * @type {Range}
2122
+ * @type {CollectionFilterRange}
1949
2123
  * @memberof CollectionFilter
1950
2124
  */
1951
- 'range'?: Range;
2125
+ 'range'?: CollectionFilterRange;
1952
2126
  /**
1953
2127
  * Type of this filter
1954
2128
  * @type {string}
@@ -2270,98 +2444,6 @@ interface FeeEntry {
2270
2444
  'fee_percentage'?: number;
2271
2445
  }
2272
2446
 
2273
- /**
2274
- * Immutable X API
2275
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2276
- *
2277
- * The version of the OpenAPI document: 3.0
2278
- * Contact: support@immutable.com
2279
- *
2280
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2281
- * https://openapi-generator.tech
2282
- * Do not edit the class manually.
2283
- */
2284
-
2285
- /**
2286
- *
2287
- * @export
2288
- * @interface CreateOrderRequest
2289
- */
2290
- interface CreateOrderRequest {
2291
- /**
2292
- * Amount to buy
2293
- * @type {string}
2294
- * @memberof CreateOrderRequest
2295
- */
2296
- 'amount_buy': string;
2297
- /**
2298
- * Amount to sell
2299
- * @type {string}
2300
- * @memberof CreateOrderRequest
2301
- */
2302
- 'amount_sell': string;
2303
- /**
2304
- * ID of the asset to buy
2305
- * @type {string}
2306
- * @memberof CreateOrderRequest
2307
- */
2308
- 'asset_id_buy': string;
2309
- /**
2310
- * ID of the asset to sell
2311
- * @type {string}
2312
- * @memberof CreateOrderRequest
2313
- */
2314
- 'asset_id_sell': string;
2315
- /**
2316
- * Expiration timestamp for this order
2317
- * @type {number}
2318
- * @memberof CreateOrderRequest
2319
- */
2320
- 'expiration_timestamp': number;
2321
- /**
2322
- * Fee information
2323
- * @type {Array<FeeEntry>}
2324
- * @memberof CreateOrderRequest
2325
- */
2326
- 'fees'?: Array<FeeEntry>;
2327
- /**
2328
- * Whether to include fees in order
2329
- * @type {boolean}
2330
- * @memberof CreateOrderRequest
2331
- */
2332
- 'include_fees'?: boolean;
2333
- /**
2334
- * Nonce of the order
2335
- * @type {number}
2336
- * @memberof CreateOrderRequest
2337
- */
2338
- 'nonce': number;
2339
- /**
2340
- * Public stark key of the user creating order
2341
- * @type {string}
2342
- * @memberof CreateOrderRequest
2343
- */
2344
- 'stark_key': string;
2345
- /**
2346
- * Payload signature
2347
- * @type {string}
2348
- * @memberof CreateOrderRequest
2349
- */
2350
- 'stark_signature': string;
2351
- /**
2352
- * ID of the vault into which the bought asset will be placed
2353
- * @type {number}
2354
- * @memberof CreateOrderRequest
2355
- */
2356
- 'vault_id_buy': number;
2357
- /**
2358
- * ID of the vault to sell from
2359
- * @type {number}
2360
- * @memberof CreateOrderRequest
2361
- */
2362
- 'vault_id_sell': number;
2363
- }
2364
-
2365
2447
  /**
2366
2448
  * Immutable X API
2367
2449
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -2552,11 +2634,11 @@ interface CreateProjectRequest {
2552
2634
  */
2553
2635
  interface CreateProjectResponse {
2554
2636
  /**
2555
- * The project ID
2556
- * @type {number}
2637
+ * The project group ID
2638
+ * @type {string}
2557
2639
  * @memberof CreateProjectResponse
2558
2640
  */
2559
- 'id': number;
2641
+ 'id': string;
2560
2642
  }
2561
2643
 
2562
2644
  /**
@@ -2607,133 +2689,10 @@ interface FeeInfo {
2607
2689
  * https://openapi-generator.tech
2608
2690
  * Do not edit the class manually.
2609
2691
  */
2610
-
2611
2692
  /**
2612
- * @type CreateTradeRequestV1FeeInfo
2613
- * Fee details
2693
+ *
2614
2694
  * @export
2615
- */
2616
- declare type CreateTradeRequestV1FeeInfo = FeeInfo;
2617
-
2618
- /**
2619
- * Immutable X API
2620
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2621
- *
2622
- * The version of the OpenAPI document: 3.0
2623
- * Contact: support@immutable.com
2624
- *
2625
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2626
- * https://openapi-generator.tech
2627
- * Do not edit the class manually.
2628
- */
2629
-
2630
- /**
2631
- *
2632
- * @export
2633
- * @interface CreateTradeRequestV1
2634
- */
2635
- interface CreateTradeRequestV1 {
2636
- /**
2637
- * Amount to buy
2638
- * @type {string}
2639
- * @memberof CreateTradeRequestV1
2640
- */
2641
- 'amount_buy': string;
2642
- /**
2643
- * Amount to sell
2644
- * @type {string}
2645
- * @memberof CreateTradeRequestV1
2646
- */
2647
- 'amount_sell': string;
2648
- /**
2649
- * ID of the asset to buy
2650
- * @type {string}
2651
- * @memberof CreateTradeRequestV1
2652
- */
2653
- 'asset_id_buy': string;
2654
- /**
2655
- * ID of the asset to sell
2656
- * @type {string}
2657
- * @memberof CreateTradeRequestV1
2658
- */
2659
- 'asset_id_sell': string;
2660
- /**
2661
- * Expiration timestamp for this trade
2662
- * @type {number}
2663
- * @memberof CreateTradeRequestV1
2664
- */
2665
- 'expiration_timestamp': number;
2666
- /**
2667
- *
2668
- * @type {CreateTradeRequestV1FeeInfo}
2669
- * @memberof CreateTradeRequestV1
2670
- */
2671
- 'fee_info'?: CreateTradeRequestV1FeeInfo;
2672
- /**
2673
- * Fee information
2674
- * @type {Array<FeeEntry>}
2675
- * @memberof CreateTradeRequestV1
2676
- */
2677
- 'fees'?: Array<FeeEntry>;
2678
- /**
2679
- * [deprecated] All orders include fees since the introduction of protocol fees
2680
- * @type {boolean}
2681
- * @memberof CreateTradeRequestV1
2682
- */
2683
- 'include_fees'?: boolean;
2684
- /**
2685
- * Nonce of the trade
2686
- * @type {number}
2687
- * @memberof CreateTradeRequestV1
2688
- */
2689
- 'nonce': number;
2690
- /**
2691
- * ID of the order
2692
- * @type {number}
2693
- * @memberof CreateTradeRequestV1
2694
- */
2695
- 'order_id': number;
2696
- /**
2697
- * Public stark key of the user creating trade
2698
- * @type {string}
2699
- * @memberof CreateTradeRequestV1
2700
- */
2701
- 'stark_key': string;
2702
- /**
2703
- * Payload signature
2704
- * @type {string}
2705
- * @memberof CreateTradeRequestV1
2706
- */
2707
- 'stark_signature': string;
2708
- /**
2709
- * ID of the vault into which the traded asset will be placed
2710
- * @type {number}
2711
- * @memberof CreateTradeRequestV1
2712
- */
2713
- 'vault_id_buy': number;
2714
- /**
2715
- * ID of the vault to sell from
2716
- * @type {number}
2717
- * @memberof CreateTradeRequestV1
2718
- */
2719
- 'vault_id_sell': number;
2720
- }
2721
-
2722
- /**
2723
- * Immutable X API
2724
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2725
- *
2726
- * The version of the OpenAPI document: 3.0
2727
- * Contact: support@immutable.com
2728
- *
2729
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2730
- * https://openapi-generator.tech
2731
- * Do not edit the class manually.
2732
- */
2733
- /**
2734
- *
2735
- * @export
2736
- * @interface CreateTradeResponse
2695
+ * @interface CreateTradeResponse
2737
2696
  */
2738
2697
  interface CreateTradeResponse {
2739
2698
  /**
@@ -2996,6 +2955,31 @@ interface CreateTransferResponseV1 {
2996
2955
  'transfer_id': number;
2997
2956
  }
2998
2957
 
2958
+ /**
2959
+ * Immutable X API
2960
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2961
+ *
2962
+ * The version of the OpenAPI document: 3.0
2963
+ * Contact: support@immutable.com
2964
+ *
2965
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2966
+ * https://openapi-generator.tech
2967
+ * Do not edit the class manually.
2968
+ */
2969
+ /**
2970
+ *
2971
+ * @export
2972
+ * @interface CreateTransferResponseV2
2973
+ */
2974
+ interface CreateTransferResponseV2 {
2975
+ /**
2976
+ * List of transfer IDs
2977
+ * @type {Array<number>}
2978
+ * @memberof CreateTransferResponseV2
2979
+ */
2980
+ 'transfer_ids': Array<number>;
2981
+ }
2982
+
2999
2983
  /**
3000
2984
  * Immutable X API
3001
2985
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3132,6 +3116,25 @@ interface CurrencyWithLimits {
3132
3116
  'symbol'?: string;
3133
3117
  }
3134
3118
 
3119
+ /**
3120
+ * Immutable X API
3121
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3122
+ *
3123
+ * The version of the OpenAPI document: 3.0
3124
+ * Contact: support@immutable.com
3125
+ *
3126
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3127
+ * https://openapi-generator.tech
3128
+ * Do not edit the class manually.
3129
+ */
3130
+
3131
+ /**
3132
+ * @type DepositToken
3133
+ * Details of the asset being deposited
3134
+ * @export
3135
+ */
3136
+ declare type DepositToken = Token;
3137
+
3135
3138
  /**
3136
3139
  * Immutable X API
3137
3140
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3164,10 +3167,10 @@ interface Deposit {
3164
3167
  'timestamp': string;
3165
3168
  /**
3166
3169
  *
3167
- * @type {Token}
3170
+ * @type {DepositToken}
3168
3171
  * @memberof Deposit
3169
3172
  */
3170
- 'token': Token;
3173
+ 'token': DepositToken;
3171
3174
  /**
3172
3175
  * Sequential ID of this transaction within Immutable X
3173
3176
  * @type {number}
@@ -3675,65 +3678,29 @@ interface GetMetadataRefreshes {
3675
3678
  */
3676
3679
  interface Project {
3677
3680
  /**
3678
- * The current period expiry date for collection limit
3679
- * @type {string}
3680
- * @memberof Project
3681
- */
3682
- 'collection_limit_expires_at': string;
3683
- /**
3684
- * The total monthly collection limit
3685
- * @type {number}
3686
- * @memberof Project
3687
- */
3688
- 'collection_monthly_limit': number;
3689
- /**
3690
- * The number of collection remaining in the current period
3691
- * @type {number}
3692
- * @memberof Project
3693
- */
3694
- 'collection_remaining': number;
3695
- /**
3696
- * The company name
3681
+ * The project ChainType
3697
3682
  * @type {string}
3698
3683
  * @memberof Project
3699
3684
  */
3700
- 'company_name': string;
3685
+ 'chain_type'?: string;
3701
3686
  /**
3702
- * The project contact email (must be registered as a developer account with Immutable at https://hub.immutable.com)
3687
+ * The project group ID
3703
3688
  * @type {string}
3704
3689
  * @memberof Project
3705
3690
  */
3706
- 'contact_email': string;
3707
- /**
3708
- * The project ID
3709
- * @type {number}
3710
- * @memberof Project
3711
- */
3712
- 'id': number;
3691
+ 'id': string;
3713
3692
  /**
3714
- * The current period expiry date for mint operation limit
3693
+ * The project group name
3715
3694
  * @type {string}
3716
3695
  * @memberof Project
3717
3696
  */
3718
- 'mint_limit_expires_at': string;
3719
- /**
3720
- * The total monthly mint operation limit
3721
- * @type {number}
3722
- * @memberof Project
3723
- */
3724
- 'mint_monthly_limit': number;
3725
- /**
3726
- * The number of mint operation remaining in the current period
3727
- * @type {number}
3728
- * @memberof Project
3729
- */
3730
- 'mint_remaining': number;
3697
+ 'name': string;
3731
3698
  /**
3732
- * The project name
3699
+ * The organisation ID that the project belongs to
3733
3700
  * @type {string}
3734
3701
  * @memberof Project
3735
3702
  */
3736
- 'name': string;
3703
+ 'org_id'?: string;
3737
3704
  }
3738
3705
 
3739
3706
  /**
@@ -3828,12 +3795,24 @@ interface GetSignableCancelOrderResponse {
3828
3795
  * @memberof GetSignableCancelOrderResponse
3829
3796
  */
3830
3797
  'payload_hash': string;
3798
+ /**
3799
+ * EIP-712 encoding of the StarkEx cancel order request to be displayed to the user
3800
+ * @type {string}
3801
+ * @memberof GetSignableCancelOrderResponse
3802
+ */
3803
+ 'readable_transaction': string;
3831
3804
  /**
3832
3805
  * Message to sign from wallet to confirm cancel order
3833
3806
  * @type {string}
3834
3807
  * @memberof GetSignableCancelOrderResponse
3835
3808
  */
3836
3809
  'signable_message': string;
3810
+ /**
3811
+ * IMX signed readable_transaction and payload_hash
3812
+ * @type {string}
3813
+ * @memberof GetSignableCancelOrderResponse
3814
+ */
3815
+ 'verification_signature': string;
3837
3816
  }
3838
3817
 
3839
3818
  /**
@@ -3867,6 +3846,25 @@ interface SignableToken {
3867
3846
  'type'?: string;
3868
3847
  }
3869
3848
 
3849
+ /**
3850
+ * Immutable X API
3851
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3852
+ *
3853
+ * The version of the OpenAPI document: 3.0
3854
+ * Contact: support@immutable.com
3855
+ *
3856
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3857
+ * https://openapi-generator.tech
3858
+ * Do not edit the class manually.
3859
+ */
3860
+
3861
+ /**
3862
+ * @type GetSignableDepositRequestToken
3863
+ * Details of the token the user is depositing
3864
+ * @export
3865
+ */
3866
+ declare type GetSignableDepositRequestToken = SignableToken;
3867
+
3870
3868
  /**
3871
3869
  * Immutable X API
3872
3870
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3893,10 +3891,10 @@ interface GetSignableDepositRequest {
3893
3891
  'amount': string;
3894
3892
  /**
3895
3893
  *
3896
- * @type {SignableToken}
3894
+ * @type {GetSignableDepositRequestToken}
3897
3895
  * @memberof GetSignableDepositRequest
3898
3896
  */
3899
- 'token': SignableToken;
3897
+ 'token': GetSignableDepositRequestToken;
3900
3898
  /**
3901
3899
  * User who is depositing
3902
3900
  * @type {string}
@@ -4035,7 +4033,7 @@ interface GetSignableOrderRequestV3 {
4035
4033
  */
4036
4034
  'fees'?: Array<FeeEntry>;
4037
4035
  /**
4038
- * SplitFees dictates whether fees will be split between maker & taker, set split_fees to true when submitting signing to v3 endpoints and vice versa for v1
4036
+ * SplitFees is a deprecated field. It\'s value is ignored.
4039
4037
  * @type {boolean}
4040
4038
  * @memberof GetSignableOrderRequestV3
4041
4039
  */
@@ -4145,6 +4143,12 @@ interface GetSignableOrderResponse {
4145
4143
  * @memberof GetSignableOrderResponse
4146
4144
  */
4147
4145
  'payload_hash': string;
4146
+ /**
4147
+ * EIP-712 encoding of the StarkEx order transaction to be displayed to the user
4148
+ * @type {string}
4149
+ * @memberof GetSignableOrderResponse
4150
+ */
4151
+ 'readable_transaction': string;
4148
4152
  /**
4149
4153
  * Message to sign with L1 wallet to confirm order request
4150
4154
  * @type {string}
@@ -4169,6 +4173,12 @@ interface GetSignableOrderResponse {
4169
4173
  * @memberof GetSignableOrderResponse
4170
4174
  */
4171
4175
  'vault_id_sell': number;
4176
+ /**
4177
+ * IMX signed readable_transaction and payload_hash
4178
+ * @type {string}
4179
+ * @memberof GetSignableOrderResponse
4180
+ */
4181
+ 'verification_signature': string;
4172
4182
  }
4173
4183
 
4174
4184
  /**
@@ -4194,12 +4204,24 @@ interface GetSignableRegistrationOffchainResponse {
4194
4204
  * @memberof GetSignableRegistrationOffchainResponse
4195
4205
  */
4196
4206
  'payload_hash': string;
4207
+ /**
4208
+ * EIP-712 encoding of the StarkEx Register User Offchain request to be displayed to the user
4209
+ * @type {string}
4210
+ * @memberof GetSignableRegistrationOffchainResponse
4211
+ */
4212
+ 'readable_transaction': string;
4197
4213
  /**
4198
4214
  * Message to sign with L1 wallet to register user offchain
4199
4215
  * @type {string}
4200
4216
  * @memberof GetSignableRegistrationOffchainResponse
4201
4217
  */
4202
4218
  'signable_message': string;
4219
+ /**
4220
+ * IMX signed readable_transaction and payload_hash
4221
+ * @type {string}
4222
+ * @memberof GetSignableRegistrationOffchainResponse
4223
+ */
4224
+ 'verification_signature': string;
4203
4225
  }
4204
4226
 
4205
4227
  /**
@@ -4262,6 +4284,18 @@ interface GetSignableRegistrationResponse {
4262
4284
  * @memberof GetSignableRegistrationResponse
4263
4285
  */
4264
4286
  'payload_hash': string;
4287
+ /**
4288
+ * EIP-712 encoding of the StarkEx Register User request to be displayed to the user
4289
+ * @type {string}
4290
+ * @memberof GetSignableRegistrationResponse
4291
+ */
4292
+ 'readable_transaction': string;
4293
+ /**
4294
+ * IMX signed readable_transaction and payload_hash
4295
+ * @type {string}
4296
+ * @memberof GetSignableRegistrationResponse
4297
+ */
4298
+ 'verification_signature': string;
4265
4299
  }
4266
4300
 
4267
4301
  /**
@@ -4393,6 +4427,12 @@ interface GetSignableTradeResponse {
4393
4427
  * @memberof GetSignableTradeResponse
4394
4428
  */
4395
4429
  'payload_hash': string;
4430
+ /**
4431
+ * EIP-712 encoding of the StarkEx trade transaction to be displayed to the user
4432
+ * @type {string}
4433
+ * @memberof GetSignableTradeResponse
4434
+ */
4435
+ 'readable_transaction': string;
4396
4436
  /**
4397
4437
  * Message to sign with L1 wallet to confirm trade request
4398
4438
  * @type {string}
@@ -4417,8 +4457,33 @@ interface GetSignableTradeResponse {
4417
4457
  * @memberof GetSignableTradeResponse
4418
4458
  */
4419
4459
  'vault_id_sell': number;
4460
+ /**
4461
+ * IMX signed readable_transaction and payload_hash
4462
+ * @type {string}
4463
+ * @memberof GetSignableTradeResponse
4464
+ */
4465
+ 'verification_signature': string;
4420
4466
  }
4421
4467
 
4468
+ /**
4469
+ * Immutable X API
4470
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4471
+ *
4472
+ * The version of the OpenAPI document: 3.0
4473
+ * Contact: support@immutable.com
4474
+ *
4475
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4476
+ * https://openapi-generator.tech
4477
+ * Do not edit the class manually.
4478
+ */
4479
+
4480
+ /**
4481
+ * @type GetSignableTransferRequestToken
4482
+ * Token to transfer
4483
+ * @export
4484
+ */
4485
+ declare type GetSignableTransferRequestToken = SignableToken;
4486
+
4422
4487
  /**
4423
4488
  * Immutable X API
4424
4489
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4434,27 +4499,33 @@ interface GetSignableTradeResponse {
4434
4499
  /**
4435
4500
  *
4436
4501
  * @export
4437
- * @interface SignableTransferDetails
4502
+ * @interface GetSignableTransferRequest
4438
4503
  */
4439
- interface SignableTransferDetails {
4504
+ interface GetSignableTransferRequest {
4440
4505
  /**
4441
4506
  * Amount of the token to transfer
4442
4507
  * @type {string}
4443
- * @memberof SignableTransferDetails
4508
+ * @memberof GetSignableTransferRequest
4444
4509
  */
4445
4510
  'amount': string;
4446
4511
  /**
4447
4512
  * Ethereum address of the receiving user
4448
4513
  * @type {string}
4449
- * @memberof SignableTransferDetails
4514
+ * @memberof GetSignableTransferRequest
4450
4515
  */
4451
4516
  'receiver': string;
4517
+ /**
4518
+ * Ethereum address of the transferring user
4519
+ * @type {string}
4520
+ * @memberof GetSignableTransferRequest
4521
+ */
4522
+ 'sender': string;
4452
4523
  /**
4453
4524
  *
4454
- * @type {SignableToken}
4455
- * @memberof SignableTransferDetails
4525
+ * @type {GetSignableTransferRequestToken}
4526
+ * @memberof GetSignableTransferRequest
4456
4527
  */
4457
- 'token': SignableToken;
4528
+ 'token': GetSignableTransferRequestToken;
4458
4529
  }
4459
4530
 
4460
4531
  /**
@@ -4472,23 +4543,54 @@ interface SignableTransferDetails {
4472
4543
  /**
4473
4544
  *
4474
4545
  * @export
4475
- * @interface GetSignableTransferRequest
4546
+ * @interface GetSignableTransferRequestV1
4476
4547
  */
4477
- interface GetSignableTransferRequest {
4548
+ interface GetSignableTransferRequestV1 {
4549
+ /**
4550
+ * Amount of the token to transfer
4551
+ * @type {string}
4552
+ * @memberof GetSignableTransferRequestV1
4553
+ */
4554
+ 'amount': string;
4555
+ /**
4556
+ * Ethereum address of the receiving user
4557
+ * @type {string}
4558
+ * @memberof GetSignableTransferRequestV1
4559
+ */
4560
+ 'receiver': string;
4478
4561
  /**
4479
4562
  * Ethereum address of the transferring user
4480
4563
  * @type {string}
4481
- * @memberof GetSignableTransferRequest
4564
+ * @memberof GetSignableTransferRequestV1
4482
4565
  */
4483
- 'sender_ether_key': string;
4566
+ 'sender': string;
4484
4567
  /**
4485
- * List of signable transfer details
4486
- * @type {Array<SignableTransferDetails>}
4487
- * @memberof GetSignableTransferRequest
4568
+ *
4569
+ * @type {SignableToken}
4570
+ * @memberof GetSignableTransferRequestV1
4488
4571
  */
4489
- 'signable_requests': Array<SignableTransferDetails>;
4572
+ 'token': SignableToken;
4490
4573
  }
4491
4574
 
4575
+ /**
4576
+ * Immutable X API
4577
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4578
+ *
4579
+ * The version of the OpenAPI document: 3.0
4580
+ * Contact: support@immutable.com
4581
+ *
4582
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4583
+ * https://openapi-generator.tech
4584
+ * Do not edit the class manually.
4585
+ */
4586
+
4587
+ /**
4588
+ * @type SignableTransferDetailsV2Token
4589
+ * Token to transfer
4590
+ * @export
4591
+ */
4592
+ declare type SignableTransferDetailsV2Token = SignableToken;
4593
+
4492
4594
  /**
4493
4595
  * Immutable X API
4494
4596
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4504,35 +4606,80 @@ interface GetSignableTransferRequest {
4504
4606
  /**
4505
4607
  *
4506
4608
  * @export
4507
- * @interface GetSignableTransferRequestV1
4609
+ * @interface SignableTransferDetailsV2
4508
4610
  */
4509
- interface GetSignableTransferRequestV1 {
4611
+ interface SignableTransferDetailsV2 {
4510
4612
  /**
4511
4613
  * Amount of the token to transfer
4512
4614
  * @type {string}
4513
- * @memberof GetSignableTransferRequestV1
4615
+ * @memberof SignableTransferDetailsV2
4514
4616
  */
4515
4617
  'amount': string;
4516
4618
  /**
4517
4619
  * Ethereum address of the receiving user
4518
4620
  * @type {string}
4519
- * @memberof GetSignableTransferRequestV1
4621
+ * @memberof SignableTransferDetailsV2
4520
4622
  */
4521
4623
  'receiver': string;
4624
+ /**
4625
+ *
4626
+ * @type {SignableTransferDetailsV2Token}
4627
+ * @memberof SignableTransferDetailsV2
4628
+ */
4629
+ 'token': SignableTransferDetailsV2Token;
4630
+ }
4631
+
4632
+ /**
4633
+ * Immutable X API
4634
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4635
+ *
4636
+ * The version of the OpenAPI document: 3.0
4637
+ * Contact: support@immutable.com
4638
+ *
4639
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4640
+ * https://openapi-generator.tech
4641
+ * Do not edit the class manually.
4642
+ */
4643
+
4644
+ /**
4645
+ *
4646
+ * @export
4647
+ * @interface GetSignableTransferRequestV2
4648
+ */
4649
+ interface GetSignableTransferRequestV2 {
4522
4650
  /**
4523
4651
  * Ethereum address of the transferring user
4524
4652
  * @type {string}
4525
- * @memberof GetSignableTransferRequestV1
4653
+ * @memberof GetSignableTransferRequestV2
4526
4654
  */
4527
- 'sender': string;
4655
+ 'sender_ether_key': string;
4528
4656
  /**
4529
- *
4530
- * @type {SignableToken}
4531
- * @memberof GetSignableTransferRequestV1
4657
+ * List of signable transfer details
4658
+ * @type {Array<SignableTransferDetailsV2>}
4659
+ * @memberof GetSignableTransferRequestV2
4532
4660
  */
4533
- 'token': SignableToken;
4661
+ 'signable_requests': Array<SignableTransferDetailsV2>;
4534
4662
  }
4535
4663
 
4664
+ /**
4665
+ * Immutable X API
4666
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4667
+ *
4668
+ * The version of the OpenAPI document: 3.0
4669
+ * Contact: support@immutable.com
4670
+ *
4671
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4672
+ * https://openapi-generator.tech
4673
+ * Do not edit the class manually.
4674
+ */
4675
+
4676
+ /**
4677
+ * @type SignableTransferResponseDetailsToken
4678
+ * Token in request to match in SDK implementation
4679
+ * @export
4680
+ */
4681
+ declare type SignableTransferResponseDetailsToken = SignableToken;
4682
+
4536
4683
  /**
4537
4684
  * Immutable X API
4538
4685
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4581,6 +4728,12 @@ interface SignableTransferResponseDetails {
4581
4728
  * @memberof SignableTransferResponseDetails
4582
4729
  */
4583
4730
  'payload_hash': string;
4731
+ /**
4732
+ * EIP-712 encoding of the StarkEx transfer request to be displayed to the user
4733
+ * @type {string}
4734
+ * @memberof SignableTransferResponseDetails
4735
+ */
4736
+ 'readable_transaction': string;
4584
4737
  /**
4585
4738
  * Receiver of the transfer
4586
4739
  * @type {string}
@@ -4601,48 +4754,16 @@ interface SignableTransferResponseDetails {
4601
4754
  'sender_vault_id': number;
4602
4755
  /**
4603
4756
  *
4604
- * @type {SignableToken}
4757
+ * @type {SignableTransferResponseDetailsToken}
4605
4758
  * @memberof SignableTransferResponseDetails
4606
4759
  */
4607
- 'token': SignableToken;
4608
- }
4609
-
4610
- /**
4611
- * Immutable X API
4612
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4613
- *
4614
- * The version of the OpenAPI document: 3.0
4615
- * Contact: support@immutable.com
4616
- *
4617
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4618
- * https://openapi-generator.tech
4619
- * Do not edit the class manually.
4620
- */
4621
-
4622
- /**
4623
- *
4624
- * @export
4625
- * @interface GetSignableTransferResponse
4626
- */
4627
- interface GetSignableTransferResponse {
4628
- /**
4629
- * Sender of the transfer
4630
- * @type {string}
4631
- * @memberof GetSignableTransferResponse
4632
- */
4633
- 'sender_stark_key': string;
4760
+ 'token': SignableTransferResponseDetailsToken;
4634
4761
  /**
4635
- * Message to sign with L1 wallet to confirm transfer request
4762
+ * IMX signed readable_transaction and payload_hash
4636
4763
  * @type {string}
4637
- * @memberof GetSignableTransferResponse
4638
- */
4639
- 'signable_message': string;
4640
- /**
4641
- * List of transfer responses without the sender stark key
4642
- * @type {Array<SignableTransferResponseDetails>}
4643
- * @memberof GetSignableTransferResponse
4764
+ * @memberof SignableTransferResponseDetails
4644
4765
  */
4645
- 'signable_responses': Array<SignableTransferResponseDetails>;
4766
+ 'verification_signature': string;
4646
4767
  }
4647
4768
 
4648
4769
  /**
@@ -4692,6 +4813,12 @@ interface GetSignableTransferResponseV1 {
4692
4813
  * @memberof GetSignableTransferResponseV1
4693
4814
  */
4694
4815
  'payload_hash': string;
4816
+ /**
4817
+ * EIP-712 encoding of the StarkEx transfer transaction to be displayed to the user
4818
+ * @type {string}
4819
+ * @memberof GetSignableTransferResponseV1
4820
+ */
4821
+ 'readable_transaction': string;
4695
4822
  /**
4696
4823
  * Receiver of the transfer
4697
4824
  * @type {string}
@@ -4722,8 +4849,71 @@ interface GetSignableTransferResponseV1 {
4722
4849
  * @memberof GetSignableTransferResponseV1
4723
4850
  */
4724
4851
  'signable_message': string;
4852
+ /**
4853
+ * IMX signed readable_transaction and payload_hash
4854
+ * @type {string}
4855
+ * @memberof GetSignableTransferResponseV1
4856
+ */
4857
+ 'verification_signature': string;
4858
+ }
4859
+
4860
+ /**
4861
+ * Immutable X API
4862
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4863
+ *
4864
+ * The version of the OpenAPI document: 3.0
4865
+ * Contact: support@immutable.com
4866
+ *
4867
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4868
+ * https://openapi-generator.tech
4869
+ * Do not edit the class manually.
4870
+ */
4871
+
4872
+ /**
4873
+ *
4874
+ * @export
4875
+ * @interface GetSignableTransferResponseV2
4876
+ */
4877
+ interface GetSignableTransferResponseV2 {
4878
+ /**
4879
+ * Sender of the transfer
4880
+ * @type {string}
4881
+ * @memberof GetSignableTransferResponseV2
4882
+ */
4883
+ 'sender_stark_key': string;
4884
+ /**
4885
+ * Message to sign with L1 wallet to confirm transfer request
4886
+ * @type {string}
4887
+ * @memberof GetSignableTransferResponseV2
4888
+ */
4889
+ 'signable_message': string;
4890
+ /**
4891
+ * List of transfer responses without the sender stark key
4892
+ * @type {Array<SignableTransferResponseDetails>}
4893
+ * @memberof GetSignableTransferResponseV2
4894
+ */
4895
+ 'signable_responses': Array<SignableTransferResponseDetails>;
4725
4896
  }
4726
4897
 
4898
+ /**
4899
+ * Immutable X API
4900
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4901
+ *
4902
+ * The version of the OpenAPI document: 3.0
4903
+ * Contact: support@immutable.com
4904
+ *
4905
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4906
+ * https://openapi-generator.tech
4907
+ * Do not edit the class manually.
4908
+ */
4909
+
4910
+ /**
4911
+ * @type GetSignableWithdrawalRequestToken
4912
+ * Token to withdraw
4913
+ * @export
4914
+ */
4915
+ declare type GetSignableWithdrawalRequestToken = SignableToken;
4916
+
4727
4917
  /**
4728
4918
  * Immutable X API
4729
4919
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4750,10 +4940,10 @@ interface GetSignableWithdrawalRequest {
4750
4940
  'amount': string;
4751
4941
  /**
4752
4942
  *
4753
- * @type {SignableToken}
4943
+ * @type {GetSignableWithdrawalRequestToken}
4754
4944
  * @memberof GetSignableWithdrawalRequest
4755
4945
  */
4756
- 'token': SignableToken;
4946
+ 'token': GetSignableWithdrawalRequestToken;
4757
4947
  /**
4758
4948
  * Ethereum address of the user who is making this withdrawal
4759
4949
  * @type {string}
@@ -4803,6 +4993,12 @@ interface GetSignableWithdrawalResponse {
4803
4993
  * @memberof GetSignableWithdrawalResponse
4804
4994
  */
4805
4995
  'payload_hash': string;
4996
+ /**
4997
+ * EIP-712 encoding of the StarkEx withdrawal request to be displayed to the user
4998
+ * @type {string}
4999
+ * @memberof GetSignableWithdrawalResponse
5000
+ */
5001
+ 'readable_transaction': string;
4806
5002
  /**
4807
5003
  * Message to sign with L1 wallet to verity withdrawal request
4808
5004
  * @type {string}
@@ -4821,6 +5017,12 @@ interface GetSignableWithdrawalResponse {
4821
5017
  * @memberof GetSignableWithdrawalResponse
4822
5018
  */
4823
5019
  'vault_id': number;
5020
+ /**
5021
+ * IMX signed readable_transaction and payload_hash
5022
+ * @type {string}
5023
+ * @memberof GetSignableWithdrawalResponse
5024
+ */
5025
+ 'verification_signature': string;
4824
5026
  }
4825
5027
 
4826
5028
  /**
@@ -5038,6 +5240,25 @@ interface ListDepositsResponse {
5038
5240
  'result': Array<Deposit>;
5039
5241
  }
5040
5242
 
5243
+ /**
5244
+ * Immutable X API
5245
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5246
+ *
5247
+ * The version of the OpenAPI document: 3.0
5248
+ * Contact: support@immutable.com
5249
+ *
5250
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5251
+ * https://openapi-generator.tech
5252
+ * Do not edit the class manually.
5253
+ */
5254
+
5255
+ /**
5256
+ * @type MintToken
5257
+ * Details of the asset which has been minted
5258
+ * @export
5259
+ */
5260
+ declare type MintToken = Token;
5261
+
5041
5262
  /**
5042
5263
  * Immutable X API
5043
5264
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -5076,10 +5297,10 @@ interface Mint {
5076
5297
  'timestamp': string;
5077
5298
  /**
5078
5299
  *
5079
- * @type {Token}
5300
+ * @type {MintToken}
5080
5301
  * @memberof Mint
5081
5302
  */
5082
- 'token': Token;
5303
+ 'token': MintToken;
5083
5304
  /**
5084
5305
  * Sequential ID of transaction in Immutable X
5085
5306
  * @type {number}
@@ -5145,11 +5366,11 @@ interface ListMintsResponse {
5145
5366
  */
5146
5367
 
5147
5368
  /**
5148
- * @type OrderBuy
5369
+ * @type OrderV3Buy
5149
5370
  * Details of the asset being bought
5150
5371
  * @export
5151
5372
  */
5152
- declare type OrderBuy = Token;
5373
+ declare type OrderV3Buy = Token;
5153
5374
 
5154
5375
  /**
5155
5376
  * Immutable X API
@@ -5164,11 +5385,48 @@ declare type OrderBuy = Token;
5164
5385
  */
5165
5386
 
5166
5387
  /**
5167
- * @type OrderSell
5168
- * Details of the asset being sold
5388
+ *
5169
5389
  * @export
5390
+ * @interface OrdersMakerTakerFee
5170
5391
  */
5171
- declare type OrderSell = Token;
5392
+ interface OrdersMakerTakerFee {
5393
+ /**
5394
+ * Number of Decimals supported the fee token
5395
+ * @type {number}
5396
+ * @memberof OrdersMakerTakerFee
5397
+ */
5398
+ 'decimals'?: number;
5399
+ /**
5400
+ * Fees
5401
+ * @type {Array<OrderFeeInfo>}
5402
+ * @memberof OrdersMakerTakerFee
5403
+ */
5404
+ 'fees'?: Array<OrderFeeInfo>;
5405
+ /**
5406
+ * Quantity of this asset with the sum of all fees applied to the asset
5407
+ * @type {string}
5408
+ * @memberof OrdersMakerTakerFee
5409
+ */
5410
+ 'quantity_with_fees': string;
5411
+ /**
5412
+ * Symbol of the fee token
5413
+ * @type {string}
5414
+ * @memberof OrdersMakerTakerFee
5415
+ */
5416
+ 'symbol'?: string;
5417
+ /**
5418
+ * Address of the ERC20 contract for the fee token
5419
+ * @type {string}
5420
+ * @memberof OrdersMakerTakerFee
5421
+ */
5422
+ 'token_address'?: string;
5423
+ /**
5424
+ * Type of the fee token (ETH/ERC20)
5425
+ * @type {string}
5426
+ * @memberof OrdersMakerTakerFee
5427
+ */
5428
+ 'token_type'?: string;
5429
+ }
5172
5430
 
5173
5431
  /**
5174
5432
  * Immutable X API
@@ -5183,201 +5441,8 @@ declare type OrderSell = Token;
5183
5441
  */
5184
5442
 
5185
5443
  /**
5186
- *
5187
- * @export
5188
- * @interface Order
5189
- */
5190
- interface Order {
5191
- /**
5192
- * Amount of the asset already sold by this order
5193
- * @type {string}
5194
- * @memberof Order
5195
- */
5196
- 'amount_sold': string | null;
5197
- /**
5198
- *
5199
- * @type {OrderBuy}
5200
- * @memberof Order
5201
- */
5202
- 'buy': OrderBuy;
5203
- /**
5204
- * Expiration timestamp of this order
5205
- * @type {string}
5206
- * @memberof Order
5207
- */
5208
- 'expiration_timestamp': string | null;
5209
- /**
5210
- * Fee information for the order
5211
- * @type {Array<OrderFeeInfo>}
5212
- * @memberof Order
5213
- */
5214
- 'fees'?: Array<OrderFeeInfo>;
5215
- /**
5216
- * ID of the order
5217
- * @type {number}
5218
- * @memberof Order
5219
- */
5220
- 'order_id': number;
5221
- /**
5222
- *
5223
- * @type {OrderSell}
5224
- * @memberof Order
5225
- */
5226
- 'sell': OrderSell;
5227
- /**
5228
- * Status of the order
5229
- * @type {string}
5230
- * @memberof Order
5231
- */
5232
- 'status': string;
5233
- /**
5234
- * Timestamp this order was created
5235
- * @type {string}
5236
- * @memberof Order
5237
- */
5238
- 'timestamp': string | null;
5239
- /**
5240
- * Updated timestamp of this order
5241
- * @type {string}
5242
- * @memberof Order
5243
- */
5244
- 'updated_timestamp': string | null;
5245
- /**
5246
- * Ethereum address of the user who submitted the order
5247
- * @type {string}
5248
- * @memberof Order
5249
- */
5250
- 'user': string;
5251
- }
5252
-
5253
- /**
5254
- * Immutable X API
5255
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5256
- *
5257
- * The version of the OpenAPI document: 3.0
5258
- * Contact: support@immutable.com
5259
- *
5260
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5261
- * https://openapi-generator.tech
5262
- * Do not edit the class manually.
5263
- */
5264
-
5265
- /**
5266
- *
5267
- * @export
5268
- * @interface ListOrdersResponse
5269
- */
5270
- interface ListOrdersResponse {
5271
- /**
5272
- * Generated cursor returned by previous query
5273
- * @type {string}
5274
- * @memberof ListOrdersResponse
5275
- */
5276
- 'cursor': string;
5277
- /**
5278
- * Remaining results flag. 1: there are remaining results matching this query, 0: no remaining results
5279
- * @type {number}
5280
- * @memberof ListOrdersResponse
5281
- */
5282
- 'remaining': number;
5283
- /**
5284
- * Orders matching query parameters
5285
- * @type {Array<Order>}
5286
- * @memberof ListOrdersResponse
5287
- */
5288
- 'result': Array<Order>;
5289
- }
5290
-
5291
- /**
5292
- * Immutable X API
5293
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5294
- *
5295
- * The version of the OpenAPI document: 3.0
5296
- * Contact: support@immutable.com
5297
- *
5298
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5299
- * https://openapi-generator.tech
5300
- * Do not edit the class manually.
5301
- */
5302
-
5303
- /**
5304
- * @type OrderV3Buy
5305
- * Details of the asset being bought
5306
- * @export
5307
- */
5308
- declare type OrderV3Buy = Token;
5309
-
5310
- /**
5311
- * Immutable X API
5312
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5313
- *
5314
- * The version of the OpenAPI document: 3.0
5315
- * Contact: support@immutable.com
5316
- *
5317
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5318
- * https://openapi-generator.tech
5319
- * Do not edit the class manually.
5320
- */
5321
-
5322
- /**
5323
- *
5324
- * @export
5325
- * @interface OrdersMakerTakerFee
5326
- */
5327
- interface OrdersMakerTakerFee {
5328
- /**
5329
- * Number of Decimals supported the fee token
5330
- * @type {number}
5331
- * @memberof OrdersMakerTakerFee
5332
- */
5333
- 'decimals'?: number;
5334
- /**
5335
- * Fees
5336
- * @type {Array<OrderFeeInfo>}
5337
- * @memberof OrdersMakerTakerFee
5338
- */
5339
- 'fees'?: Array<OrderFeeInfo>;
5340
- /**
5341
- * Quantity of this asset with the sum of all fees applied to the asset
5342
- * @type {string}
5343
- * @memberof OrdersMakerTakerFee
5344
- */
5345
- 'quantity_with_fees': string;
5346
- /**
5347
- * Symbol of the fee token
5348
- * @type {string}
5349
- * @memberof OrdersMakerTakerFee
5350
- */
5351
- 'symbol'?: string;
5352
- /**
5353
- * Address of the ERC20 contract for the fee token
5354
- * @type {string}
5355
- * @memberof OrdersMakerTakerFee
5356
- */
5357
- 'token_address'?: string;
5358
- /**
5359
- * Type of the fee token (ETH/ERC20)
5360
- * @type {string}
5361
- * @memberof OrdersMakerTakerFee
5362
- */
5363
- 'token_type'?: string;
5364
- }
5365
-
5366
- /**
5367
- * Immutable X API
5368
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5369
- *
5370
- * The version of the OpenAPI document: 3.0
5371
- * Contact: support@immutable.com
5372
- *
5373
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5374
- * https://openapi-generator.tech
5375
- * Do not edit the class manually.
5376
- */
5377
-
5378
- /**
5379
- * @type OrderV3MakerFees
5380
- * MakerFees is the information about the fees that needs to be paid by the maker (liquidity)
5444
+ * @type OrderV3MakerFees
5445
+ * MakerFees is the information about the fees that needs to be paid by the maker (liquidity)
5381
5446
  * @export
5382
5447
  */
5383
5448
  declare type OrderV3MakerFees = OrdersMakerTakerFee;
@@ -5604,7 +5669,7 @@ interface TokenDetails {
5604
5669
  */
5605
5670
  'symbol': string;
5606
5671
  /**
5607
- * Address of the ERC721 contract
5672
+ * Address of the ERC20 contract
5608
5673
  * @type {string}
5609
5674
  * @memberof TokenDetails
5610
5675
  */
@@ -5818,6 +5883,25 @@ interface ListTradesResponse {
5818
5883
  'result': Array<Trade>;
5819
5884
  }
5820
5885
 
5886
+ /**
5887
+ * Immutable X API
5888
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5889
+ *
5890
+ * The version of the OpenAPI document: 3.0
5891
+ * Contact: support@immutable.com
5892
+ *
5893
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5894
+ * https://openapi-generator.tech
5895
+ * Do not edit the class manually.
5896
+ */
5897
+
5898
+ /**
5899
+ * @type TransferToken
5900
+ * Token transferred by the user
5901
+ * @export
5902
+ */
5903
+ declare type TransferToken = Token;
5904
+
5821
5905
  /**
5822
5906
  * Immutable X API
5823
5907
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -5856,10 +5940,10 @@ interface Transfer {
5856
5940
  'timestamp': string | null;
5857
5941
  /**
5858
5942
  *
5859
- * @type {Token}
5943
+ * @type {TransferToken}
5860
5944
  * @memberof Transfer
5861
5945
  */
5862
- 'token': Token;
5946
+ 'token': TransferToken;
5863
5947
  /**
5864
5948
  * Sequential transaction ID
5865
5949
  * @type {number}
@@ -5912,6 +5996,25 @@ interface ListTransfersResponse {
5912
5996
  'result': Array<Transfer>;
5913
5997
  }
5914
5998
 
5999
+ /**
6000
+ * Immutable X API
6001
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6002
+ *
6003
+ * The version of the OpenAPI document: 3.0
6004
+ * Contact: support@immutable.com
6005
+ *
6006
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6007
+ * https://openapi-generator.tech
6008
+ * Do not edit the class manually.
6009
+ */
6010
+
6011
+ /**
6012
+ * @type WithdrawalToken
6013
+ * Details of the asset this user is withdrawing
6014
+ * @export
6015
+ */
6016
+ declare type WithdrawalToken = Token;
6017
+
5915
6018
  /**
5916
6019
  * Immutable X API
5917
6020
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -5956,10 +6059,10 @@ interface Withdrawal {
5956
6059
  'timestamp': string;
5957
6060
  /**
5958
6061
  *
5959
- * @type {Token}
6062
+ * @type {WithdrawalToken}
5960
6063
  * @memberof Withdrawal
5961
6064
  */
5962
- 'token': Token;
6065
+ 'token': WithdrawalToken;
5963
6066
  /**
5964
6067
  * Sequential ID of this transaction
5965
6068
  * @type {number}
@@ -6668,6 +6771,43 @@ interface NftprimarytransactionListTransactionsResponse {
6668
6771
  'result'?: Array<NftprimarytransactionTransactionData>;
6669
6772
  }
6670
6773
 
6774
+ /**
6775
+ * Immutable X API
6776
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6777
+ *
6778
+ * The version of the OpenAPI document: 3.0
6779
+ * Contact: support@immutable.com
6780
+ *
6781
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6782
+ * https://openapi-generator.tech
6783
+ * Do not edit the class manually.
6784
+ */
6785
+ /**
6786
+ *
6787
+ * @export
6788
+ * @interface RegisterPassportUserResult
6789
+ */
6790
+ interface RegisterPassportUserResult {
6791
+ /**
6792
+ * The ether key of the user
6793
+ * @type {string}
6794
+ * @memberof RegisterPassportUserResult
6795
+ */
6796
+ 'ether_key'?: string;
6797
+ /**
6798
+ * The stark key of the user
6799
+ * @type {string}
6800
+ * @memberof RegisterPassportUserResult
6801
+ */
6802
+ 'stark_key'?: string;
6803
+ /**
6804
+ * The admin key of the user
6805
+ * @type {string}
6806
+ * @memberof RegisterPassportUserResult
6807
+ */
6808
+ 'user_admin_key'?: string;
6809
+ }
6810
+
6671
6811
  /**
6672
6812
  * Immutable X API
6673
6813
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -8404,43 +8544,6 @@ declare class NftCheckoutPrimaryApi extends BaseAPI {
8404
8544
  */
8405
8545
  registerNftPrimarySalesContract(requestParameters: NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ContractCreateResponse, any>>;
8406
8546
  }
8407
- /**
8408
- * Request parameters for cancelOrder operation in OrdersApi.
8409
- * @export
8410
- * @interface OrdersApiCancelOrderRequest
8411
- */
8412
- interface OrdersApiCancelOrderRequest {
8413
- /**
8414
- * Order ID to cancel
8415
- * @type {string}
8416
- * @memberof OrdersApiCancelOrder
8417
- */
8418
- readonly id: string;
8419
- /**
8420
- * cancel an order
8421
- * @type {CancelOrderRequest}
8422
- * @memberof OrdersApiCancelOrder
8423
- */
8424
- readonly cancelOrderRequest: CancelOrderRequest;
8425
- /**
8426
- * eth address
8427
- * @type {string}
8428
- * @memberof OrdersApiCancelOrder
8429
- */
8430
- readonly xImxEthAddress?: string;
8431
- /**
8432
- * eth signature
8433
- * @type {string}
8434
- * @memberof OrdersApiCancelOrder
8435
- */
8436
- readonly xImxEthSignature?: string;
8437
- /**
8438
- * Authorization header
8439
- * @type {string}
8440
- * @memberof OrdersApiCancelOrder
8441
- */
8442
- readonly authorization?: string;
8443
- }
8444
8547
  /**
8445
8548
  * Request parameters for cancelOrderV3 operation in OrdersApi.
8446
8549
  * @export
@@ -8448,379 +8551,123 @@ interface OrdersApiCancelOrderRequest {
8448
8551
  */
8449
8552
  interface OrdersApiCancelOrderV3Request {
8450
8553
  /**
8451
- * Order ID to cancel
8452
- * @type {string}
8453
- * @memberof OrdersApiCancelOrderV3
8454
- */
8455
- readonly id: string;
8456
- /**
8457
- * cancel an order
8458
- * @type {CancelOrderRequest}
8459
- * @memberof OrdersApiCancelOrderV3
8460
- */
8461
- readonly cancelOrderRequest: CancelOrderRequest;
8462
- /**
8463
- * eth address
8464
- * @type {string}
8465
- * @memberof OrdersApiCancelOrderV3
8466
- */
8467
- readonly xImxEthAddress?: string;
8468
- /**
8469
- * eth signature
8470
- * @type {string}
8471
- * @memberof OrdersApiCancelOrderV3
8472
- */
8473
- readonly xImxEthSignature?: string;
8474
- /**
8475
- * Authorization header
8476
- * @type {string}
8477
- * @memberof OrdersApiCancelOrderV3
8478
- */
8479
- readonly authorization?: string;
8480
- }
8481
- /**
8482
- * Request parameters for createOrder operation in OrdersApi.
8483
- * @export
8484
- * @interface OrdersApiCreateOrderRequest
8485
- */
8486
- interface OrdersApiCreateOrderRequest {
8487
- /**
8488
- * create an order
8489
- * @type {CreateOrderRequest}
8490
- * @memberof OrdersApiCreateOrder
8491
- */
8492
- readonly createOrderRequest: CreateOrderRequest;
8493
- /**
8494
- * eth address
8495
- * @type {string}
8496
- * @memberof OrdersApiCreateOrder
8497
- */
8498
- readonly xImxEthAddress?: string;
8499
- /**
8500
- * eth signature
8501
- * @type {string}
8502
- * @memberof OrdersApiCreateOrder
8503
- */
8504
- readonly xImxEthSignature?: string;
8505
- /**
8506
- * Authorization header
8507
- * @type {string}
8508
- * @memberof OrdersApiCreateOrder
8509
- */
8510
- readonly authorization?: string;
8511
- }
8512
- /**
8513
- * Request parameters for createOrderV3 operation in OrdersApi.
8514
- * @export
8515
- * @interface OrdersApiCreateOrderV3Request
8516
- */
8517
- interface OrdersApiCreateOrderV3Request {
8518
- /**
8519
- * create an order
8520
- * @type {CreateOrderRequestV3}
8521
- * @memberof OrdersApiCreateOrderV3
8522
- */
8523
- readonly createOrderRequest: CreateOrderRequestV3;
8524
- /**
8525
- * eth address
8526
- * @type {string}
8527
- * @memberof OrdersApiCreateOrderV3
8528
- */
8529
- readonly xImxEthAddress?: string;
8530
- /**
8531
- * eth signature
8532
- * @type {string}
8533
- * @memberof OrdersApiCreateOrderV3
8534
- */
8535
- readonly xImxEthSignature?: string;
8536
- /**
8537
- * Authorization header
8538
- * @type {string}
8539
- * @memberof OrdersApiCreateOrderV3
8540
- */
8541
- readonly authorization?: string;
8542
- }
8543
- /**
8544
- * Request parameters for getOrder operation in OrdersApi.
8545
- * @export
8546
- * @interface OrdersApiGetOrderRequest
8547
- */
8548
- interface OrdersApiGetOrderRequest {
8549
- /**
8550
- * Order ID
8551
- * @type {string}
8552
- * @memberof OrdersApiGetOrder
8553
- */
8554
- readonly id: string;
8555
- /**
8556
- * Set flag to true to include fee body for the order
8557
- * @type {boolean}
8558
- * @memberof OrdersApiGetOrder
8559
- */
8560
- readonly includeFees?: boolean;
8561
- /**
8562
- * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
8563
- * @type {string}
8564
- * @memberof OrdersApiGetOrder
8565
- */
8566
- readonly auxiliaryFeePercentages?: string;
8567
- /**
8568
- * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
8569
- * @type {string}
8570
- * @memberof OrdersApiGetOrder
8571
- */
8572
- readonly auxiliaryFeeRecipients?: string;
8573
- }
8574
- /**
8575
- * Request parameters for getOrderV3 operation in OrdersApi.
8576
- * @export
8577
- * @interface OrdersApiGetOrderV3Request
8578
- */
8579
- interface OrdersApiGetOrderV3Request {
8580
- /**
8581
- * Order ID
8582
- * @type {string}
8583
- * @memberof OrdersApiGetOrderV3
8584
- */
8585
- readonly id: string;
8586
- /**
8587
- * Set flag to true to include fee body for the order
8588
- * @type {boolean}
8589
- * @memberof OrdersApiGetOrderV3
8590
- */
8591
- readonly includeFees?: boolean;
8592
- /**
8593
- * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
8594
- * @type {string}
8595
- * @memberof OrdersApiGetOrderV3
8596
- */
8597
- readonly auxiliaryFeePercentages?: string;
8598
- /**
8599
- * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
8600
- * @type {string}
8601
- * @memberof OrdersApiGetOrderV3
8602
- */
8603
- readonly auxiliaryFeeRecipients?: string;
8604
- }
8605
- /**
8606
- * Request parameters for getSignableCancelOrder operation in OrdersApi.
8607
- * @export
8608
- * @interface OrdersApiGetSignableCancelOrderRequest
8609
- */
8610
- interface OrdersApiGetSignableCancelOrderRequest {
8611
- /**
8612
- * get a signable cancel order
8613
- * @type {GetSignableCancelOrderRequest}
8614
- * @memberof OrdersApiGetSignableCancelOrder
8615
- */
8616
- readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
8617
- }
8618
- /**
8619
- * Request parameters for getSignableCancelOrderV3 operation in OrdersApi.
8620
- * @export
8621
- * @interface OrdersApiGetSignableCancelOrderV3Request
8622
- */
8623
- interface OrdersApiGetSignableCancelOrderV3Request {
8624
- /**
8625
- * get a signable cancel order
8626
- * @type {GetSignableCancelOrderRequest}
8627
- * @memberof OrdersApiGetSignableCancelOrderV3
8628
- */
8629
- readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
8630
- }
8631
- /**
8632
- * Request parameters for getSignableOrder operation in OrdersApi.
8633
- * @export
8634
- * @interface OrdersApiGetSignableOrderRequest
8635
- */
8636
- interface OrdersApiGetSignableOrderRequest {
8637
- /**
8638
- * get a signable order v3
8639
- * @type {GetSignableOrderRequestV3}
8640
- * @memberof OrdersApiGetSignableOrder
8641
- */
8642
- readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
8643
- }
8644
- /**
8645
- * Request parameters for listOrders operation in OrdersApi.
8646
- * @export
8647
- * @interface OrdersApiListOrdersRequest
8648
- */
8649
- interface OrdersApiListOrdersRequest {
8650
- /**
8651
- * Page size of the result
8652
- * @type {number}
8653
- * @memberof OrdersApiListOrders
8654
- */
8655
- readonly pageSize?: number;
8656
- /**
8657
- * Cursor
8658
- * @type {string}
8659
- * @memberof OrdersApiListOrders
8660
- */
8661
- readonly cursor?: string;
8662
- /**
8663
- * Property to sort by
8664
- * @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
8665
- * @memberof OrdersApiListOrders
8666
- */
8667
- readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
8668
- /**
8669
- * Direction to sort (asc/desc)
8670
- * @type {string}
8671
- * @memberof OrdersApiListOrders
8672
- */
8673
- readonly direction?: string;
8674
- /**
8675
- * Ethereum address of the user who submitted this order
8676
- * @type {string}
8677
- * @memberof OrdersApiListOrders
8678
- */
8679
- readonly user?: string;
8680
- /**
8681
- * Status of this order
8682
- * @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
8683
- * @memberof OrdersApiListOrders
8684
- */
8685
- readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
8686
- /**
8687
- * 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;
8688
- * @type {string}
8689
- * @memberof OrdersApiListOrders
8690
- */
8691
- readonly minTimestamp?: string;
8692
- /**
8693
- * 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;
8694
- * @type {string}
8695
- * @memberof OrdersApiListOrders
8696
- */
8697
- readonly maxTimestamp?: string;
8698
- /**
8699
- * 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;
8700
- * @type {string}
8701
- * @memberof OrdersApiListOrders
8702
- */
8703
- readonly updatedMinTimestamp?: string;
8704
- /**
8705
- * 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;
8706
- * @type {string}
8707
- * @memberof OrdersApiListOrders
8708
- */
8709
- readonly updatedMaxTimestamp?: string;
8710
- /**
8711
- * Token type of the asset this order buys
8712
- * @type {string}
8713
- * @memberof OrdersApiListOrders
8714
- */
8715
- readonly buyTokenType?: string;
8716
- /**
8717
- * ERC721 Token ID of the asset this order buys
8718
- * @type {string}
8719
- * @memberof OrdersApiListOrders
8720
- */
8721
- readonly buyTokenId?: string;
8722
- /**
8723
- * Internal IMX ID of the asset this order buys
8724
- * @type {string}
8725
- * @memberof OrdersApiListOrders
8726
- */
8727
- readonly buyAssetId?: string;
8728
- /**
8729
- * Token address of the asset this order buys
8730
- * @type {string}
8731
- * @memberof OrdersApiListOrders
8732
- */
8733
- readonly buyTokenAddress?: string;
8734
- /**
8735
- * Token name of the asset this order buys
8736
- * @type {string}
8737
- * @memberof OrdersApiListOrders
8738
- */
8739
- readonly buyTokenName?: string;
8740
- /**
8741
- * Min quantity for the asset this order buys
8554
+ * Order ID to cancel
8742
8555
  * @type {string}
8743
- * @memberof OrdersApiListOrders
8556
+ * @memberof OrdersApiCancelOrderV3
8744
8557
  */
8745
- readonly buyMinQuantity?: string;
8558
+ readonly id: string;
8746
8559
  /**
8747
- * Max quantity for the asset this order buys
8748
- * @type {string}
8749
- * @memberof OrdersApiListOrders
8560
+ * cancel an order
8561
+ * @type {CancelOrderRequest}
8562
+ * @memberof OrdersApiCancelOrderV3
8750
8563
  */
8751
- readonly buyMaxQuantity?: string;
8564
+ readonly cancelOrderRequest: CancelOrderRequest;
8752
8565
  /**
8753
- * JSON-encoded metadata filters for the asset this order buys
8566
+ * eth address
8754
8567
  * @type {string}
8755
- * @memberof OrdersApiListOrders
8568
+ * @memberof OrdersApiCancelOrderV3
8756
8569
  */
8757
- readonly buyMetadata?: string;
8570
+ readonly xImxEthAddress?: string;
8758
8571
  /**
8759
- * Token type of the asset this order sells
8572
+ * eth signature
8760
8573
  * @type {string}
8761
- * @memberof OrdersApiListOrders
8574
+ * @memberof OrdersApiCancelOrderV3
8762
8575
  */
8763
- readonly sellTokenType?: string;
8576
+ readonly xImxEthSignature?: string;
8764
8577
  /**
8765
- * ERC721 Token ID of the asset this order sells
8578
+ * Authorization header
8766
8579
  * @type {string}
8767
- * @memberof OrdersApiListOrders
8580
+ * @memberof OrdersApiCancelOrderV3
8768
8581
  */
8769
- readonly sellTokenId?: string;
8582
+ readonly authorization?: string;
8583
+ }
8584
+ /**
8585
+ * Request parameters for createOrderV3 operation in OrdersApi.
8586
+ * @export
8587
+ * @interface OrdersApiCreateOrderV3Request
8588
+ */
8589
+ interface OrdersApiCreateOrderV3Request {
8770
8590
  /**
8771
- * Internal IMX ID of the asset this order sells
8772
- * @type {string}
8773
- * @memberof OrdersApiListOrders
8591
+ * create an order
8592
+ * @type {CreateOrderRequestV3}
8593
+ * @memberof OrdersApiCreateOrderV3
8774
8594
  */
8775
- readonly sellAssetId?: string;
8595
+ readonly createOrderRequest: CreateOrderRequestV3;
8776
8596
  /**
8777
- * Token address of the asset this order sells
8597
+ * eth address
8778
8598
  * @type {string}
8779
- * @memberof OrdersApiListOrders
8599
+ * @memberof OrdersApiCreateOrderV3
8780
8600
  */
8781
- readonly sellTokenAddress?: string;
8601
+ readonly xImxEthAddress?: string;
8782
8602
  /**
8783
- * Token name of the asset this order sells
8603
+ * eth signature
8784
8604
  * @type {string}
8785
- * @memberof OrdersApiListOrders
8605
+ * @memberof OrdersApiCreateOrderV3
8786
8606
  */
8787
- readonly sellTokenName?: string;
8607
+ readonly xImxEthSignature?: string;
8788
8608
  /**
8789
- * Min quantity for the asset this order sells
8609
+ * Authorization header
8790
8610
  * @type {string}
8791
- * @memberof OrdersApiListOrders
8611
+ * @memberof OrdersApiCreateOrderV3
8792
8612
  */
8793
- readonly sellMinQuantity?: string;
8613
+ readonly authorization?: string;
8614
+ }
8615
+ /**
8616
+ * Request parameters for getOrderV3 operation in OrdersApi.
8617
+ * @export
8618
+ * @interface OrdersApiGetOrderV3Request
8619
+ */
8620
+ interface OrdersApiGetOrderV3Request {
8794
8621
  /**
8795
- * Max quantity for the asset this order sells
8622
+ * Order ID
8796
8623
  * @type {string}
8797
- * @memberof OrdersApiListOrders
8624
+ * @memberof OrdersApiGetOrderV3
8798
8625
  */
8799
- readonly sellMaxQuantity?: string;
8626
+ readonly id: string;
8800
8627
  /**
8801
- * JSON-encoded metadata filters for the asset this order sells
8802
- * @type {string}
8803
- * @memberof OrdersApiListOrders
8628
+ * Set flag to true to include fee body for the order
8629
+ * @type {boolean}
8630
+ * @memberof OrdersApiGetOrderV3
8804
8631
  */
8805
- readonly sellMetadata?: string;
8632
+ readonly includeFees?: boolean;
8806
8633
  /**
8807
8634
  * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
8808
8635
  * @type {string}
8809
- * @memberof OrdersApiListOrders
8636
+ * @memberof OrdersApiGetOrderV3
8810
8637
  */
8811
8638
  readonly auxiliaryFeePercentages?: string;
8812
8639
  /**
8813
8640
  * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
8814
8641
  * @type {string}
8815
- * @memberof OrdersApiListOrders
8642
+ * @memberof OrdersApiGetOrderV3
8816
8643
  */
8817
8644
  readonly auxiliaryFeeRecipients?: string;
8645
+ }
8646
+ /**
8647
+ * Request parameters for getSignableCancelOrderV3 operation in OrdersApi.
8648
+ * @export
8649
+ * @interface OrdersApiGetSignableCancelOrderV3Request
8650
+ */
8651
+ interface OrdersApiGetSignableCancelOrderV3Request {
8818
8652
  /**
8819
- * Set flag to true to include fee object for orders
8820
- * @type {boolean}
8821
- * @memberof OrdersApiListOrders
8653
+ * get a signable cancel order
8654
+ * @type {GetSignableCancelOrderRequest}
8655
+ * @memberof OrdersApiGetSignableCancelOrderV3
8822
8656
  */
8823
- readonly includeFees?: boolean;
8657
+ readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
8658
+ }
8659
+ /**
8660
+ * Request parameters for getSignableOrder operation in OrdersApi.
8661
+ * @export
8662
+ * @interface OrdersApiGetSignableOrderRequest
8663
+ */
8664
+ interface OrdersApiGetSignableOrderRequest {
8665
+ /**
8666
+ * get a signable order v3
8667
+ * @type {GetSignableOrderRequestV3}
8668
+ * @memberof OrdersApiGetSignableOrder
8669
+ */
8670
+ readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
8824
8671
  }
8825
8672
  /**
8826
8673
  * Request parameters for listOrdersV3 operation in OrdersApi.
@@ -9010,16 +8857,6 @@ interface OrdersApiListOrdersV3Request {
9010
8857
  * @extends {BaseAPI}
9011
8858
  */
9012
8859
  declare class OrdersApi extends BaseAPI {
9013
- /**
9014
- * 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
9015
- * @summary Cancel an order
9016
- * @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
9017
- * @param {*} [options] Override http request option.
9018
- * @deprecated
9019
- * @throws {RequiredError}
9020
- * @memberof OrdersApi
9021
- */
9022
- cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
9023
8860
  /**
9024
8861
  * Cancel an order (V3)
9025
8862
  * @summary Cancel an order (V3)
@@ -9030,17 +8867,7 @@ declare class OrdersApi extends BaseAPI {
9030
8867
  */
9031
8868
  cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
9032
8869
  /**
9033
- * 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
9034
- * @summary Create an order
9035
- * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
9036
- * @param {*} [options] Override http request option.
9037
- * @deprecated
9038
- * @throws {RequiredError}
9039
- * @memberof OrdersApi
9040
- */
9041
- createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
9042
- /**
9043
- * Create an order using the v3 orderbook. Currently only buy NFT orders are supported.
8870
+ * Create an order using the v3 orderbook.
9044
8871
  * @summary Create an order (V3)
9045
8872
  * @param {OrdersApiCreateOrderV3Request} requestParameters Request parameters.
9046
8873
  * @param {*} [options] Override http request option.
@@ -9048,16 +8875,6 @@ declare class OrdersApi extends BaseAPI {
9048
8875
  * @memberof OrdersApi
9049
8876
  */
9050
8877
  createOrderV3(requestParameters: OrdersApiCreateOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
9051
- /**
9052
- * 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
9053
- * @summary Get an order
9054
- * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
9055
- * @param {*} [options] Override http request option.
9056
- * @deprecated
9057
- * @throws {RequiredError}
9058
- * @memberof OrdersApi
9059
- */
9060
- getOrder(requestParameters: OrdersApiGetOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Order, any>>;
9061
8878
  /**
9062
8879
  * Get an order (V3)
9063
8880
  * @summary Get an order (V3)
@@ -9067,16 +8884,6 @@ declare class OrdersApi extends BaseAPI {
9067
8884
  * @memberof OrdersApi
9068
8885
  */
9069
8886
  getOrderV3(requestParameters: OrdersApiGetOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<OrderV3, any>>;
9070
- /**
9071
- * 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
9072
- * @summary Sign cancel order message
9073
- * @param {OrdersApiGetSignableCancelOrderRequest} requestParameters Request parameters.
9074
- * @param {*} [options] Override http request option.
9075
- * @deprecated
9076
- * @throws {RequiredError}
9077
- * @memberof OrdersApi
9078
- */
9079
- getSignableCancelOrder(requestParameters: OrdersApiGetSignableCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
9080
8887
  /**
9081
8888
  * Generate a signable cancel order message (V3)
9082
8889
  * @summary Generate a signable cancel order message (V3)
@@ -9095,16 +8902,6 @@ declare class OrdersApi extends BaseAPI {
9095
8902
  * @memberof OrdersApi
9096
8903
  */
9097
8904
  getSignableOrder(requestParameters: OrdersApiGetSignableOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableOrderResponse, any>>;
9098
- /**
9099
- * 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
9100
- * @summary Get a list of orders.
9101
- * @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
9102
- * @param {*} [options] Override http request option.
9103
- * @deprecated
9104
- * @throws {RequiredError}
9105
- * @memberof OrdersApi
9106
- */
9107
- listOrders(requestParameters?: OrdersApiListOrdersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponse, any>>;
9108
8905
  /**
9109
8906
  * Get a list of orders (V3)
9110
8907
  * @summary Get a list of orders (V3)
@@ -9208,6 +9005,31 @@ interface ProjectsApiGetProjectsRequest {
9208
9005
  */
9209
9006
  readonly direction?: string;
9210
9007
  }
9008
+ /**
9009
+ * Request parameters for getSdkVersion operation in ProjectsApi.
9010
+ * @export
9011
+ * @interface ProjectsApiGetSdkVersionRequest
9012
+ */
9013
+ interface ProjectsApiGetSdkVersionRequest {
9014
+ /**
9015
+ * Runtime Details
9016
+ * @type {string}
9017
+ * @memberof ProjectsApiGetSdkVersion
9018
+ */
9019
+ readonly details: string;
9020
+ /**
9021
+ * SDK Version
9022
+ * @type {string}
9023
+ * @memberof ProjectsApiGetSdkVersion
9024
+ */
9025
+ readonly version?: string;
9026
+ /**
9027
+ * Runtime ID
9028
+ * @type {string}
9029
+ * @memberof ProjectsApiGetSdkVersion
9030
+ */
9031
+ readonly id?: string;
9032
+ }
9211
9033
  /**
9212
9034
  * ProjectsApi - object-oriented interface
9213
9035
  * @export
@@ -9220,6 +9042,7 @@ declare class ProjectsApi extends BaseAPI {
9220
9042
  * @summary Create a project
9221
9043
  * @param {ProjectsApiCreateProjectRequest} requestParameters Request parameters.
9222
9044
  * @param {*} [options] Override http request option.
9045
+ * @deprecated
9223
9046
  * @throws {RequiredError}
9224
9047
  * @memberof ProjectsApi
9225
9048
  */
@@ -9242,6 +9065,15 @@ declare class ProjectsApi extends BaseAPI {
9242
9065
  * @memberof ProjectsApi
9243
9066
  */
9244
9067
  getProjects(requestParameters: ProjectsApiGetProjectsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetProjectsResponse, any>>;
9068
+ /**
9069
+ * Checks the SDK Version of caller against the current SDK Version and returns a message.
9070
+ * @summary Checks the SDK Version of caller against the current SDK Version
9071
+ * @param {ProjectsApiGetSdkVersionRequest} requestParameters Request parameters.
9072
+ * @param {*} [options] Override http request option.
9073
+ * @throws {RequiredError}
9074
+ * @memberof ProjectsApi
9075
+ */
9076
+ getSdkVersion(requestParameters: ProjectsApiGetSdkVersionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ApiSDKVersionCheckResponse, any>>;
9245
9077
  }
9246
9078
  /**
9247
9079
  * Request parameters for getToken operation in TokensApi.
@@ -9325,37 +9157,6 @@ declare class TokensApi extends BaseAPI {
9325
9157
  */
9326
9158
  listTokens(requestParameters?: TokensApiListTokensRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTokensResponse, any>>;
9327
9159
  }
9328
- /**
9329
- * Request parameters for createTrade operation in TradesApi.
9330
- * @export
9331
- * @interface TradesApiCreateTradeRequest
9332
- */
9333
- interface TradesApiCreateTradeRequest {
9334
- /**
9335
- * create a trade
9336
- * @type {CreateTradeRequestV1}
9337
- * @memberof TradesApiCreateTrade
9338
- */
9339
- readonly createTradeRequest: CreateTradeRequestV1;
9340
- /**
9341
- * eth address
9342
- * @type {string}
9343
- * @memberof TradesApiCreateTrade
9344
- */
9345
- readonly xImxEthAddress?: string;
9346
- /**
9347
- * eth signature
9348
- * @type {string}
9349
- * @memberof TradesApiCreateTrade
9350
- */
9351
- readonly xImxEthSignature?: string;
9352
- /**
9353
- * Authorization header
9354
- * @type {string}
9355
- * @memberof TradesApiCreateTrade
9356
- */
9357
- readonly authorization?: string;
9358
- }
9359
9160
  /**
9360
9161
  * Request parameters for createTradeV3 operation in TradesApi.
9361
9162
  * @export
@@ -9401,91 +9202,18 @@ interface TradesApiGetSignableTradeRequest {
9401
9202
  readonly getSignableTradeRequest: GetSignableTradeRequest;
9402
9203
  }
9403
9204
  /**
9404
- * Request parameters for getTrade operation in TradesApi.
9205
+ * Request parameters for getTradeV3 operation in TradesApi.
9405
9206
  * @export
9406
- * @interface TradesApiGetTradeRequest
9207
+ * @interface TradesApiGetTradeV3Request
9407
9208
  */
9408
- interface TradesApiGetTradeRequest {
9209
+ interface TradesApiGetTradeV3Request {
9409
9210
  /**
9410
9211
  * Trade ID
9411
9212
  * @type {string}
9412
- * @memberof TradesApiGetTrade
9213
+ * @memberof TradesApiGetTradeV3
9413
9214
  */
9414
9215
  readonly id: string;
9415
9216
  }
9416
- /**
9417
- * Request parameters for listTrades operation in TradesApi.
9418
- * @export
9419
- * @interface TradesApiListTradesRequest
9420
- */
9421
- interface TradesApiListTradesRequest {
9422
- /**
9423
- * Party A\&#39;s (buy order) token type of currency used to buy
9424
- * @type {string}
9425
- * @memberof TradesApiListTrades
9426
- */
9427
- readonly partyATokenType?: string;
9428
- /**
9429
- * Party A\&#39;s (buy order) token address of currency used to buy
9430
- * @type {string}
9431
- * @memberof TradesApiListTrades
9432
- */
9433
- readonly partyATokenAddress?: string;
9434
- /**
9435
- * Party B\&#39;s (sell order) token type of NFT sold - always ERC721
9436
- * @type {string}
9437
- * @memberof TradesApiListTrades
9438
- */
9439
- readonly partyBTokenType?: string;
9440
- /**
9441
- * Party B\&#39;s (sell order) collection address of NFT sold
9442
- * @type {string}
9443
- * @memberof TradesApiListTrades
9444
- */
9445
- readonly partyBTokenAddress?: string;
9446
- /**
9447
- * Party B\&#39;s (sell order) token id of NFT sold
9448
- * @type {string}
9449
- * @memberof TradesApiListTrades
9450
- */
9451
- readonly partyBTokenId?: string;
9452
- /**
9453
- * Page size of the result
9454
- * @type {number}
9455
- * @memberof TradesApiListTrades
9456
- */
9457
- readonly pageSize?: number;
9458
- /**
9459
- * Cursor
9460
- * @type {string}
9461
- * @memberof TradesApiListTrades
9462
- */
9463
- readonly cursor?: string;
9464
- /**
9465
- * Property to sort by
9466
- * @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
9467
- * @memberof TradesApiListTrades
9468
- */
9469
- readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
9470
- /**
9471
- * Direction to sort (asc/desc)
9472
- * @type {string}
9473
- * @memberof TradesApiListTrades
9474
- */
9475
- readonly direction?: string;
9476
- /**
9477
- * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
9478
- * @type {string}
9479
- * @memberof TradesApiListTrades
9480
- */
9481
- readonly minTimestamp?: string;
9482
- /**
9483
- * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
9484
- * @type {string}
9485
- * @memberof TradesApiListTrades
9486
- */
9487
- readonly maxTimestamp?: string;
9488
- }
9489
9217
  /**
9490
9218
  * Request parameters for listTradesV3 operation in TradesApi.
9491
9219
  * @export
@@ -9547,13 +9275,13 @@ interface TradesApiListTradesV3Request {
9547
9275
  */
9548
9276
  readonly direction?: string;
9549
9277
  /**
9550
- * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
9278
+ * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-06-27T00:10:22Z\&#39;
9551
9279
  * @type {string}
9552
9280
  * @memberof TradesApiListTradesV3
9553
9281
  */
9554
9282
  readonly minTimestamp?: string;
9555
9283
  /**
9556
- * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
9284
+ * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-06-27T00:10:22Z\&#39;
9557
9285
  * @type {string}
9558
9286
  * @memberof TradesApiListTradesV3
9559
9287
  */
@@ -9567,17 +9295,7 @@ interface TradesApiListTradesV3Request {
9567
9295
  */
9568
9296
  declare class TradesApi extends BaseAPI {
9569
9297
  /**
9570
- * 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
9571
- * @summary Create a Trade between two parties
9572
- * @param {TradesApiCreateTradeRequest} requestParameters Request parameters.
9573
- * @param {*} [options] Override http request option.
9574
- * @deprecated
9575
- * @throws {RequiredError}
9576
- * @memberof TradesApi
9577
- */
9578
- createTrade(requestParameters: TradesApiCreateTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
9579
- /**
9580
- * Create a Trade. Currently only buy order is supported.
9298
+ * Create a Trade.
9581
9299
  * @summary Create a Trade (V3)
9582
9300
  * @param {TradesApiCreateTradeV3Request} requestParameters Request parameters.
9583
9301
  * @param {*} [options] Override http request option.
@@ -9597,22 +9315,12 @@ declare class TradesApi extends BaseAPI {
9597
9315
  /**
9598
9316
  * Get details of a trade with the given ID
9599
9317
  * @summary Get details of a trade with the given ID
9600
- * @param {TradesApiGetTradeRequest} requestParameters Request parameters.
9601
- * @param {*} [options] Override http request option.
9602
- * @throws {RequiredError}
9603
- * @memberof TradesApi
9604
- */
9605
- getTrade(requestParameters: TradesApiGetTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
9606
- /**
9607
- * 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
9608
- * @summary Get a list of trades
9609
- * @param {TradesApiListTradesRequest} requestParameters Request parameters.
9318
+ * @param {TradesApiGetTradeV3Request} requestParameters Request parameters.
9610
9319
  * @param {*} [options] Override http request option.
9611
- * @deprecated
9612
9320
  * @throws {RequiredError}
9613
9321
  * @memberof TradesApi
9614
9322
  */
9615
- listTrades(requestParameters?: TradesApiListTradesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTradesResponse, any>>;
9323
+ getTradeV3(requestParameters: TradesApiGetTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
9616
9324
  /**
9617
9325
  * Get a list of trades (V3)
9618
9326
  * @summary Get a list of trades (V3)
@@ -9693,10 +9401,10 @@ interface TransfersApiCreateTransferV1Request {
9693
9401
  interface TransfersApiGetSignableTransferRequest {
9694
9402
  /**
9695
9403
  * get details of signable transfer
9696
- * @type {GetSignableTransferRequest}
9404
+ * @type {GetSignableTransferRequestV2}
9697
9405
  * @memberof TransfersApiGetSignableTransfer
9698
9406
  */
9699
- readonly getSignableTransferRequestV2: GetSignableTransferRequest;
9407
+ readonly getSignableTransferRequestV2: GetSignableTransferRequestV2;
9700
9408
  }
9701
9409
  /**
9702
9410
  * Request parameters for getSignableTransferV1 operation in TransfersApi.
@@ -9706,10 +9414,10 @@ interface TransfersApiGetSignableTransferRequest {
9706
9414
  interface TransfersApiGetSignableTransferV1Request {
9707
9415
  /**
9708
9416
  * get details of signable transfer
9709
- * @type {GetSignableTransferRequestV1}
9417
+ * @type {GetSignableTransferRequest}
9710
9418
  * @memberof TransfersApiGetSignableTransferV1
9711
9419
  */
9712
- readonly getSignableTransferRequest: GetSignableTransferRequestV1;
9420
+ readonly getSignableTransferRequest: GetSignableTransferRequest;
9713
9421
  }
9714
9422
  /**
9715
9423
  * Request parameters for getTransfer operation in TransfersApi.
@@ -9744,10 +9452,10 @@ interface TransfersApiListTransfersRequest {
9744
9452
  readonly cursor?: string;
9745
9453
  /**
9746
9454
  * Property to sort by
9747
- * @type {'transaction_id' | 'updated_at' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key'}
9455
+ * @type {'transaction_id' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key'}
9748
9456
  * @memberof TransfersApiListTransfers
9749
9457
  */
9750
- readonly orderBy?: 'transaction_id' | 'updated_at' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key';
9458
+ readonly orderBy?: 'transaction_id' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key';
9751
9459
  /**
9752
9460
  * Direction to sort (asc/desc)
9753
9461
  * @type {string}
@@ -9848,7 +9556,7 @@ declare class TransfersApi extends BaseAPI {
9848
9556
  * @throws {RequiredError}
9849
9557
  * @memberof TransfersApi
9850
9558
  */
9851
- createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
9559
+ createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponseV2, any>>;
9852
9560
  /**
9853
9561
  * Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransferV1 to get request body params.
9854
9562
  * @summary Creates a transfer of tokens between two parties
@@ -9866,7 +9574,7 @@ declare class TransfersApi extends BaseAPI {
9866
9574
  * @throws {RequiredError}
9867
9575
  * @memberof TransfersApi
9868
9576
  */
9869
- getSignableTransfer(requestParameters: TransfersApiGetSignableTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTransferResponse, any>>;
9577
+ getSignableTransfer(requestParameters: TransfersApiGetSignableTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTransferResponseV2, any>>;
9870
9578
  /**
9871
9579
  * Gets details of a signable transfer
9872
9580
  * @summary Gets details of a signable transfer
@@ -10008,7 +9716,7 @@ declare class UsersApi extends BaseAPI {
10008
9716
  * @throws {RequiredError}
10009
9717
  * @memberof UsersApi
10010
9718
  */
10011
- registerPassportUser(requestParameters: UsersApiRegisterPassportUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<object, any>>;
9719
+ registerPassportUser(requestParameters: UsersApiRegisterPassportUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<RegisterPassportUserResult, any>>;
10012
9720
  /**
10013
9721
  * Registers a user
10014
9722
  * @summary Registers a user
@@ -10193,7 +9901,7 @@ interface WithdrawalsApiListWithdrawalsRequest {
10193
9901
  */
10194
9902
  declare class WithdrawalsApi extends BaseAPI {
10195
9903
  /**
10196
- * Creates a withdrawal.
9904
+ * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
10197
9905
  * @summary Creates a withdrawal of a token
10198
9906
  * @param {WithdrawalsApiCreateWithdrawalRequest} requestParameters Request parameters.
10199
9907
  * @param {*} [options] Override http request option.
@@ -10646,28 +10354,28 @@ declare class ImmutableXClient {
10646
10354
  * @returns a promise that resolves with the requested Order
10647
10355
  * @throws {@link index.IMXError}
10648
10356
  */
10649
- getOrder(request: OrdersApiGetOrderRequest): Promise<OrderV3>;
10357
+ getOrder(request: OrdersApiGetOrderV3Request): Promise<OrderV3>;
10650
10358
  /**
10651
10359
  * Get a list of Orders
10652
10360
  * @param request - optional object containing the parameters to be provided in the API request
10653
10361
  * @returns a promise that resolves with the requested list of Orders
10654
10362
  * @throws {@link index.IMXError}
10655
10363
  */
10656
- listOrders(request?: OrdersApiListOrdersRequest): Promise<ListOrdersResponseV3>;
10364
+ listOrders(request?: OrdersApiListOrdersV3Request): Promise<ListOrdersResponseV3>;
10657
10365
  /**
10658
10366
  * Get details of a Trade with the given ID
10659
10367
  * @param request - the request object containing the parameters to be provided in the API request
10660
10368
  * @returns a promise that resolves with the requested Trade
10661
10369
  * @throws {@link index.IMXError}
10662
10370
  */
10663
- getTrade(request: TradesApiGetTradeRequest): Promise<Trade>;
10371
+ getTrade(request: TradesApiGetTradeV3Request): Promise<Trade>;
10664
10372
  /**
10665
10373
  * Get a list of Trades
10666
10374
  * @param request - optional object containing the parameters to be provided in the API request
10667
10375
  * @returns a promise that resolves with the requested list of Trades
10668
10376
  * @throws {@link index.IMXError}
10669
10377
  */
10670
- listTrades(request?: TradesApiListTradesRequest): Promise<ListTradesResponse>;
10378
+ listTrades(request?: TradesApiListTradesV3Request): Promise<ListTradesResponse>;
10671
10379
  /**
10672
10380
  * Get details of a Token
10673
10381
  * @param request - the request object containing the parameters to be provided in the API request
@@ -10869,15 +10577,12 @@ declare class Passport {
10869
10577
  private readonly passportImxProviderFactory;
10870
10578
  private readonly passportEventEmitter;
10871
10579
  constructor(passportModuleConfiguration: PassportModuleConfiguration);
10872
- signIn(options?: {
10873
- useCachedSession: boolean;
10874
- }): Promise<UserProfile | null>;
10875
10580
  /**
10876
- * @deprecated The method connectImx(useCachedSession) should be used instead
10581
+ * @deprecated The method `login` with an argument of `{ useCachedSession: true }` should be used in conjunction with
10582
+ * `connectImx` instead.
10877
10583
  */
10878
10584
  connectImxSilent(): Promise<IMXProvider | null>;
10879
10585
  connectImx(): Promise<IMXProvider>;
10880
- loginWithDeviceFlow(): Promise<DeviceConnectResponse>;
10881
10586
  connectImxDeviceFlow(deviceCode: string, interval: number, timeoutMs?: number): Promise<IMXProvider | null>;
10882
10587
  getPKCEAuthorizationUrl(): string;
10883
10588
  connectImxPKCEFlow(authorizationCode: string, state: string): Promise<IMXProvider | null>;
@@ -10887,6 +10592,18 @@ declare class Passport {
10887
10592
  checkStoredDeviceFlowCredentials(): DeviceTokenResponse | null;
10888
10593
  connectImxWithCredentials(tokenResponse: DeviceTokenResponse): Promise<IMXProvider | null>;
10889
10594
  connectEvm(): Provider;
10595
+ /**
10596
+ *
10597
+ * Initiates the authorisation flow.
10598
+ *
10599
+ * @param options.useCachedSession = false - If true, and no active session exists, then the user will not be
10600
+ * prompted to log in and the Promise will resolve with a null value.
10601
+ * @returns {Promise<UserProfile | null>} the user profile if the user is logged in, otherwise null
10602
+ */
10603
+ login(options?: {
10604
+ useCachedSession: boolean;
10605
+ }): Promise<UserProfile | null>;
10606
+ loginWithDeviceFlow(): Promise<DeviceConnectResponse>;
10890
10607
  loginCallback(): Promise<void>;
10891
10608
  logout(): Promise<void>;
10892
10609
  /**