@imtbl/sdk 0.28.3-alpha.1 → 0.28.4

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.
@@ -757,6 +757,25 @@ interface CollectionDetails {
757
757
  'name': string;
758
758
  }
759
759
 
760
+ /**
761
+ * Immutable X API
762
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
763
+ *
764
+ * The version of the OpenAPI document: 3.0
765
+ * Contact: support@immutable.com
766
+ *
767
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
768
+ * https://openapi-generator.tech
769
+ * Do not edit the class manually.
770
+ */
771
+
772
+ /**
773
+ * @type AssetPropertiesCollection
774
+ * Details of this asset\'s collection
775
+ * @export
776
+ */
777
+ declare type AssetPropertiesCollection = CollectionDetails;
778
+
760
779
  /**
761
780
  * Immutable X API
762
781
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -777,10 +796,10 @@ interface CollectionDetails {
777
796
  interface AssetProperties {
778
797
  /**
779
798
  *
780
- * @type {CollectionDetails}
799
+ * @type {AssetPropertiesCollection}
781
800
  * @memberof AssetProperties
782
801
  */
783
- 'collection'?: CollectionDetails;
802
+ 'collection'?: AssetPropertiesCollection;
784
803
  /**
785
804
  * Image URL of this asset
786
805
  * @type {string}
@@ -964,6 +983,25 @@ interface FeeData {
964
983
  'decimals'?: number;
965
984
  }
966
985
 
986
+ /**
987
+ * Immutable X API
988
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
989
+ *
990
+ * The version of the OpenAPI document: 3.0
991
+ * Contact: support@immutable.com
992
+ *
993
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
994
+ * https://openapi-generator.tech
995
+ * Do not edit the class manually.
996
+ */
997
+
998
+ /**
999
+ * @type FeeTokenData
1000
+ * Fee token data details
1001
+ * @export
1002
+ */
1003
+ declare type FeeTokenData = FeeData;
1004
+
967
1005
  /**
968
1006
  * Immutable X API
969
1007
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -984,10 +1022,10 @@ interface FeeData {
984
1022
  interface FeeToken {
985
1023
  /**
986
1024
  *
987
- * @type {FeeData}
1025
+ * @type {FeeTokenData}
988
1026
  * @memberof FeeToken
989
1027
  */
990
- 'data'?: FeeData;
1028
+ 'data'?: FeeTokenData;
991
1029
  /**
992
1030
  * Fee token type. One of ETH/ERC20
993
1031
  * @type {string}
@@ -1121,29 +1159,48 @@ interface ApiRegisterPassportUserRequest {
1121
1159
  /**
1122
1160
  *
1123
1161
  * @export
1124
- * @interface Fee
1162
+ * @interface ApiSDKVersionCheckResponse
1125
1163
  */
1126
- interface Fee {
1164
+ interface ApiSDKVersionCheckResponse {
1127
1165
  /**
1128
- * Wallet address
1166
+ *
1129
1167
  * @type {string}
1130
- * @memberof Fee
1168
+ * @memberof ApiSDKVersionCheckResponse
1131
1169
  */
1132
- 'address': string;
1170
+ 'message'?: string;
1133
1171
  /**
1134
- * The percentage of fee
1135
- * @type {number}
1136
- * @memberof Fee
1172
+ *
1173
+ * @type {boolean}
1174
+ * @memberof ApiSDKVersionCheckResponse
1137
1175
  */
1138
- 'percentage': number;
1176
+ 'ok'?: boolean;
1139
1177
  /**
1140
- * Type of fee. Examples: `royalty`, `maker`, `taker` or `protocol`
1178
+ *
1141
1179
  * @type {string}
1142
- * @memberof Fee
1180
+ * @memberof ApiSDKVersionCheckResponse
1143
1181
  */
1144
- 'type': string;
1182
+ 'runtimeId'?: string;
1145
1183
  }
1146
1184
 
1185
+ /**
1186
+ * Immutable X API
1187
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1188
+ *
1189
+ * The version of the OpenAPI document: 3.0
1190
+ * Contact: support@immutable.com
1191
+ *
1192
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1193
+ * https://openapi-generator.tech
1194
+ * Do not edit the class manually.
1195
+ */
1196
+
1197
+ /**
1198
+ * @type AssetCollection
1199
+ * Information about the collection to which this asset belongs
1200
+ * @export
1201
+ */
1202
+ declare type AssetCollection = CollectionDetails;
1203
+
1147
1204
  /**
1148
1205
  * Immutable X API
1149
1206
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1175,6 +1232,62 @@ interface OrderDetails {
1175
1232
  'sell_orders'?: Array<object>;
1176
1233
  }
1177
1234
 
1235
+ /**
1236
+ * Immutable X API
1237
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1238
+ *
1239
+ * The version of the OpenAPI document: 3.0
1240
+ * Contact: support@immutable.com
1241
+ *
1242
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1243
+ * https://openapi-generator.tech
1244
+ * Do not edit the class manually.
1245
+ */
1246
+
1247
+ /**
1248
+ * @type AssetOrders
1249
+ * [DEPRECATED] Open orders for this asset will always return empty. Use GET /orders
1250
+ * @export
1251
+ */
1252
+ declare type AssetOrders = OrderDetails;
1253
+
1254
+ /**
1255
+ * Immutable X API
1256
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1257
+ *
1258
+ * The version of the OpenAPI document: 3.0
1259
+ * Contact: support@immutable.com
1260
+ *
1261
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1262
+ * https://openapi-generator.tech
1263
+ * Do not edit the class manually.
1264
+ */
1265
+ /**
1266
+ *
1267
+ * @export
1268
+ * @interface Fee
1269
+ */
1270
+ interface Fee {
1271
+ /**
1272
+ * Wallet address
1273
+ * @type {string}
1274
+ * @memberof Fee
1275
+ */
1276
+ 'address': string;
1277
+ /**
1278
+ * The percentage of fee
1279
+ * @type {number}
1280
+ * @memberof Fee
1281
+ */
1282
+ 'percentage': number;
1283
+ /**
1284
+ * Type of fee. Examples: `royalty`, `maker`, `taker` or `protocol`
1285
+ * @type {string}
1286
+ * @memberof Fee
1287
+ */
1288
+ 'type': string;
1289
+ }
1290
+
1178
1291
  /**
1179
1292
  * Immutable X API
1180
1293
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1195,10 +1308,10 @@ interface OrderDetails {
1195
1308
  interface Asset {
1196
1309
  /**
1197
1310
  *
1198
- * @type {CollectionDetails}
1311
+ * @type {AssetCollection}
1199
1312
  * @memberof Asset
1200
1313
  */
1201
- 'collection': CollectionDetails;
1314
+ 'collection': AssetCollection;
1202
1315
  /**
1203
1316
  * Timestamp of when the asset was created
1204
1317
  * @type {string}
@@ -1243,10 +1356,10 @@ interface Asset {
1243
1356
  'name': string | null;
1244
1357
  /**
1245
1358
  *
1246
- * @type {OrderDetails}
1359
+ * @type {AssetOrders}
1247
1360
  * @memberof Asset
1248
1361
  */
1249
- 'orders'?: OrderDetails;
1362
+ 'orders'?: AssetOrders;
1250
1363
  /**
1251
1364
  * Status of this asset (where it is in the system)
1252
1365
  * @type {string}
@@ -1285,6 +1398,44 @@ interface Asset {
1285
1398
  'user': string;
1286
1399
  }
1287
1400
 
1401
+ /**
1402
+ * Immutable X API
1403
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1404
+ *
1405
+ * The version of the OpenAPI document: 3.0
1406
+ * Contact: support@immutable.com
1407
+ *
1408
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1409
+ * https://openapi-generator.tech
1410
+ * Do not edit the class manually.
1411
+ */
1412
+
1413
+ /**
1414
+ * @type AssetWithOrdersCollection
1415
+ * Information about the collection to which this asset belongs
1416
+ * @export
1417
+ */
1418
+ declare type AssetWithOrdersCollection = CollectionDetails;
1419
+
1420
+ /**
1421
+ * Immutable X API
1422
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1423
+ *
1424
+ * The version of the OpenAPI document: 3.0
1425
+ * Contact: support@immutable.com
1426
+ *
1427
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1428
+ * https://openapi-generator.tech
1429
+ * Do not edit the class manually.
1430
+ */
1431
+
1432
+ /**
1433
+ * @type AssetWithOrdersOrders
1434
+ * Open orders for this asset
1435
+ * @export
1436
+ */
1437
+ declare type AssetWithOrdersOrders = OrderDetails;
1438
+
1288
1439
  /**
1289
1440
  * Immutable X API
1290
1441
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1305,10 +1456,10 @@ interface Asset {
1305
1456
  interface AssetWithOrders {
1306
1457
  /**
1307
1458
  *
1308
- * @type {CollectionDetails}
1459
+ * @type {AssetWithOrdersCollection}
1309
1460
  * @memberof AssetWithOrders
1310
1461
  */
1311
- 'collection': CollectionDetails;
1462
+ 'collection': AssetWithOrdersCollection;
1312
1463
  /**
1313
1464
  * Timestamp of when the asset was created
1314
1465
  * @type {string}
@@ -1353,10 +1504,10 @@ interface AssetWithOrders {
1353
1504
  'name': string | null;
1354
1505
  /**
1355
1506
  *
1356
- * @type {OrderDetails}
1507
+ * @type {AssetWithOrdersOrders}
1357
1508
  * @memberof AssetWithOrders
1358
1509
  */
1359
- 'orders'?: OrderDetails;
1510
+ 'orders'?: AssetWithOrdersOrders;
1360
1511
  /**
1361
1512
  * Status of this asset (where it is in the system)
1362
1513
  * @type {string}
@@ -1616,6 +1767,25 @@ interface Range {
1616
1767
  'min'?: number;
1617
1768
  }
1618
1769
 
1770
+ /**
1771
+ * Immutable X API
1772
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1773
+ *
1774
+ * The version of the OpenAPI document: 3.0
1775
+ * Contact: support@immutable.com
1776
+ *
1777
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1778
+ * https://openapi-generator.tech
1779
+ * Do not edit the class manually.
1780
+ */
1781
+
1782
+ /**
1783
+ * @type CollectionFilterRange
1784
+ * Range of values for this property
1785
+ * @export
1786
+ */
1787
+ declare type CollectionFilterRange = Range;
1788
+
1619
1789
  /**
1620
1790
  * Immutable X API
1621
1791
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1642,10 +1812,10 @@ interface CollectionFilter {
1642
1812
  'key'?: string;
1643
1813
  /**
1644
1814
  *
1645
- * @type {Range}
1815
+ * @type {CollectionFilterRange}
1646
1816
  * @memberof CollectionFilter
1647
1817
  */
1648
- 'range'?: Range;
1818
+ 'range'?: CollectionFilterRange;
1649
1819
  /**
1650
1820
  * Type of this filter
1651
1821
  * @type {string}
@@ -1967,98 +2137,6 @@ interface FeeEntry {
1967
2137
  'fee_percentage'?: number;
1968
2138
  }
1969
2139
 
1970
- /**
1971
- * Immutable X API
1972
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1973
- *
1974
- * The version of the OpenAPI document: 3.0
1975
- * Contact: support@immutable.com
1976
- *
1977
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1978
- * https://openapi-generator.tech
1979
- * Do not edit the class manually.
1980
- */
1981
-
1982
- /**
1983
- *
1984
- * @export
1985
- * @interface CreateOrderRequest
1986
- */
1987
- interface CreateOrderRequest {
1988
- /**
1989
- * Amount to buy
1990
- * @type {string}
1991
- * @memberof CreateOrderRequest
1992
- */
1993
- 'amount_buy': string;
1994
- /**
1995
- * Amount to sell
1996
- * @type {string}
1997
- * @memberof CreateOrderRequest
1998
- */
1999
- 'amount_sell': string;
2000
- /**
2001
- * ID of the asset to buy
2002
- * @type {string}
2003
- * @memberof CreateOrderRequest
2004
- */
2005
- 'asset_id_buy': string;
2006
- /**
2007
- * ID of the asset to sell
2008
- * @type {string}
2009
- * @memberof CreateOrderRequest
2010
- */
2011
- 'asset_id_sell': string;
2012
- /**
2013
- * Expiration timestamp for this order
2014
- * @type {number}
2015
- * @memberof CreateOrderRequest
2016
- */
2017
- 'expiration_timestamp': number;
2018
- /**
2019
- * Fee information
2020
- * @type {Array<FeeEntry>}
2021
- * @memberof CreateOrderRequest
2022
- */
2023
- 'fees'?: Array<FeeEntry>;
2024
- /**
2025
- * Whether to include fees in order
2026
- * @type {boolean}
2027
- * @memberof CreateOrderRequest
2028
- */
2029
- 'include_fees'?: boolean;
2030
- /**
2031
- * Nonce of the order
2032
- * @type {number}
2033
- * @memberof CreateOrderRequest
2034
- */
2035
- 'nonce': number;
2036
- /**
2037
- * Public stark key of the user creating order
2038
- * @type {string}
2039
- * @memberof CreateOrderRequest
2040
- */
2041
- 'stark_key': string;
2042
- /**
2043
- * Payload signature
2044
- * @type {string}
2045
- * @memberof CreateOrderRequest
2046
- */
2047
- 'stark_signature': string;
2048
- /**
2049
- * ID of the vault into which the bought asset will be placed
2050
- * @type {number}
2051
- * @memberof CreateOrderRequest
2052
- */
2053
- 'vault_id_buy': number;
2054
- /**
2055
- * ID of the vault to sell from
2056
- * @type {number}
2057
- * @memberof CreateOrderRequest
2058
- */
2059
- 'vault_id_sell': number;
2060
- }
2061
-
2062
2140
  /**
2063
2141
  * Immutable X API
2064
2142
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -2249,11 +2327,11 @@ interface CreateProjectRequest {
2249
2327
  */
2250
2328
  interface CreateProjectResponse {
2251
2329
  /**
2252
- * The project ID
2253
- * @type {number}
2330
+ * The project group ID
2331
+ * @type {string}
2254
2332
  * @memberof CreateProjectResponse
2255
2333
  */
2256
- 'id': number;
2334
+ 'id': string;
2257
2335
  }
2258
2336
 
2259
2337
  /**
@@ -2304,133 +2382,10 @@ interface FeeInfo {
2304
2382
  * https://openapi-generator.tech
2305
2383
  * Do not edit the class manually.
2306
2384
  */
2307
-
2308
2385
  /**
2309
- * @type CreateTradeRequestV1FeeInfo
2310
- * Fee details
2386
+ *
2311
2387
  * @export
2312
- */
2313
- declare type CreateTradeRequestV1FeeInfo = FeeInfo;
2314
-
2315
- /**
2316
- * Immutable X API
2317
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2318
- *
2319
- * The version of the OpenAPI document: 3.0
2320
- * Contact: support@immutable.com
2321
- *
2322
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2323
- * https://openapi-generator.tech
2324
- * Do not edit the class manually.
2325
- */
2326
-
2327
- /**
2328
- *
2329
- * @export
2330
- * @interface CreateTradeRequestV1
2331
- */
2332
- interface CreateTradeRequestV1 {
2333
- /**
2334
- * Amount to buy
2335
- * @type {string}
2336
- * @memberof CreateTradeRequestV1
2337
- */
2338
- 'amount_buy': string;
2339
- /**
2340
- * Amount to sell
2341
- * @type {string}
2342
- * @memberof CreateTradeRequestV1
2343
- */
2344
- 'amount_sell': string;
2345
- /**
2346
- * ID of the asset to buy
2347
- * @type {string}
2348
- * @memberof CreateTradeRequestV1
2349
- */
2350
- 'asset_id_buy': string;
2351
- /**
2352
- * ID of the asset to sell
2353
- * @type {string}
2354
- * @memberof CreateTradeRequestV1
2355
- */
2356
- 'asset_id_sell': string;
2357
- /**
2358
- * Expiration timestamp for this trade
2359
- * @type {number}
2360
- * @memberof CreateTradeRequestV1
2361
- */
2362
- 'expiration_timestamp': number;
2363
- /**
2364
- *
2365
- * @type {CreateTradeRequestV1FeeInfo}
2366
- * @memberof CreateTradeRequestV1
2367
- */
2368
- 'fee_info'?: CreateTradeRequestV1FeeInfo;
2369
- /**
2370
- * Fee information
2371
- * @type {Array<FeeEntry>}
2372
- * @memberof CreateTradeRequestV1
2373
- */
2374
- 'fees'?: Array<FeeEntry>;
2375
- /**
2376
- * [deprecated] All orders include fees since the introduction of protocol fees
2377
- * @type {boolean}
2378
- * @memberof CreateTradeRequestV1
2379
- */
2380
- 'include_fees'?: boolean;
2381
- /**
2382
- * Nonce of the trade
2383
- * @type {number}
2384
- * @memberof CreateTradeRequestV1
2385
- */
2386
- 'nonce': number;
2387
- /**
2388
- * ID of the order
2389
- * @type {number}
2390
- * @memberof CreateTradeRequestV1
2391
- */
2392
- 'order_id': number;
2393
- /**
2394
- * Public stark key of the user creating trade
2395
- * @type {string}
2396
- * @memberof CreateTradeRequestV1
2397
- */
2398
- 'stark_key': string;
2399
- /**
2400
- * Payload signature
2401
- * @type {string}
2402
- * @memberof CreateTradeRequestV1
2403
- */
2404
- 'stark_signature': string;
2405
- /**
2406
- * ID of the vault into which the traded asset will be placed
2407
- * @type {number}
2408
- * @memberof CreateTradeRequestV1
2409
- */
2410
- 'vault_id_buy': number;
2411
- /**
2412
- * ID of the vault to sell from
2413
- * @type {number}
2414
- * @memberof CreateTradeRequestV1
2415
- */
2416
- 'vault_id_sell': number;
2417
- }
2418
-
2419
- /**
2420
- * Immutable X API
2421
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2422
- *
2423
- * The version of the OpenAPI document: 3.0
2424
- * Contact: support@immutable.com
2425
- *
2426
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2427
- * https://openapi-generator.tech
2428
- * Do not edit the class manually.
2429
- */
2430
- /**
2431
- *
2432
- * @export
2433
- * @interface CreateTradeResponse
2388
+ * @interface CreateTradeResponse
2434
2389
  */
2435
2390
  interface CreateTradeResponse {
2436
2391
  /**
@@ -2693,6 +2648,31 @@ interface CreateTransferResponseV1 {
2693
2648
  'transfer_id': number;
2694
2649
  }
2695
2650
 
2651
+ /**
2652
+ * Immutable X API
2653
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2654
+ *
2655
+ * The version of the OpenAPI document: 3.0
2656
+ * Contact: support@immutable.com
2657
+ *
2658
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2659
+ * https://openapi-generator.tech
2660
+ * Do not edit the class manually.
2661
+ */
2662
+ /**
2663
+ *
2664
+ * @export
2665
+ * @interface CreateTransferResponseV2
2666
+ */
2667
+ interface CreateTransferResponseV2 {
2668
+ /**
2669
+ * List of transfer IDs
2670
+ * @type {Array<number>}
2671
+ * @memberof CreateTransferResponseV2
2672
+ */
2673
+ 'transfer_ids': Array<number>;
2674
+ }
2675
+
2696
2676
  /**
2697
2677
  * Immutable X API
2698
2678
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -2829,6 +2809,25 @@ interface CurrencyWithLimits {
2829
2809
  'symbol'?: string;
2830
2810
  }
2831
2811
 
2812
+ /**
2813
+ * Immutable X API
2814
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2815
+ *
2816
+ * The version of the OpenAPI document: 3.0
2817
+ * Contact: support@immutable.com
2818
+ *
2819
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2820
+ * https://openapi-generator.tech
2821
+ * Do not edit the class manually.
2822
+ */
2823
+
2824
+ /**
2825
+ * @type DepositToken
2826
+ * Details of the asset being deposited
2827
+ * @export
2828
+ */
2829
+ declare type DepositToken = Token;
2830
+
2832
2831
  /**
2833
2832
  * Immutable X API
2834
2833
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -2861,10 +2860,10 @@ interface Deposit {
2861
2860
  'timestamp': string;
2862
2861
  /**
2863
2862
  *
2864
- * @type {Token}
2863
+ * @type {DepositToken}
2865
2864
  * @memberof Deposit
2866
2865
  */
2867
- 'token': Token;
2866
+ 'token': DepositToken;
2868
2867
  /**
2869
2868
  * Sequential ID of this transaction within Immutable X
2870
2869
  * @type {number}
@@ -3372,65 +3371,29 @@ interface GetMetadataRefreshes {
3372
3371
  */
3373
3372
  interface Project {
3374
3373
  /**
3375
- * The current period expiry date for collection limit
3376
- * @type {string}
3377
- * @memberof Project
3378
- */
3379
- 'collection_limit_expires_at': string;
3380
- /**
3381
- * The total monthly collection limit
3382
- * @type {number}
3383
- * @memberof Project
3384
- */
3385
- 'collection_monthly_limit': number;
3386
- /**
3387
- * The number of collection remaining in the current period
3388
- * @type {number}
3389
- * @memberof Project
3390
- */
3391
- 'collection_remaining': number;
3392
- /**
3393
- * The company name
3374
+ * The project ChainType
3394
3375
  * @type {string}
3395
3376
  * @memberof Project
3396
3377
  */
3397
- 'company_name': string;
3378
+ 'chain_type'?: string;
3398
3379
  /**
3399
- * The project contact email (must be registered as a developer account with Immutable at https://hub.immutable.com)
3380
+ * The project group ID
3400
3381
  * @type {string}
3401
3382
  * @memberof Project
3402
3383
  */
3403
- 'contact_email': string;
3404
- /**
3405
- * The project ID
3406
- * @type {number}
3407
- * @memberof Project
3408
- */
3409
- 'id': number;
3384
+ 'id': string;
3410
3385
  /**
3411
- * The current period expiry date for mint operation limit
3386
+ * The project group name
3412
3387
  * @type {string}
3413
3388
  * @memberof Project
3414
3389
  */
3415
- 'mint_limit_expires_at': string;
3416
- /**
3417
- * The total monthly mint operation limit
3418
- * @type {number}
3419
- * @memberof Project
3420
- */
3421
- 'mint_monthly_limit': number;
3422
- /**
3423
- * The number of mint operation remaining in the current period
3424
- * @type {number}
3425
- * @memberof Project
3426
- */
3427
- 'mint_remaining': number;
3390
+ 'name': string;
3428
3391
  /**
3429
- * The project name
3392
+ * The organisation ID that the project belongs to
3430
3393
  * @type {string}
3431
3394
  * @memberof Project
3432
3395
  */
3433
- 'name': string;
3396
+ 'org_id'?: string;
3434
3397
  }
3435
3398
 
3436
3399
  /**
@@ -3525,12 +3488,24 @@ interface GetSignableCancelOrderResponse {
3525
3488
  * @memberof GetSignableCancelOrderResponse
3526
3489
  */
3527
3490
  'payload_hash': string;
3491
+ /**
3492
+ * EIP-712 encoding of the StarkEx cancel order request to be displayed to the user
3493
+ * @type {string}
3494
+ * @memberof GetSignableCancelOrderResponse
3495
+ */
3496
+ 'readable_transaction': string;
3528
3497
  /**
3529
3498
  * Message to sign from wallet to confirm cancel order
3530
3499
  * @type {string}
3531
3500
  * @memberof GetSignableCancelOrderResponse
3532
3501
  */
3533
3502
  'signable_message': string;
3503
+ /**
3504
+ * IMX signed readable_transaction and payload_hash
3505
+ * @type {string}
3506
+ * @memberof GetSignableCancelOrderResponse
3507
+ */
3508
+ 'verification_signature': string;
3534
3509
  }
3535
3510
 
3536
3511
  /**
@@ -3564,6 +3539,25 @@ interface SignableToken {
3564
3539
  'type'?: string;
3565
3540
  }
3566
3541
 
3542
+ /**
3543
+ * Immutable X API
3544
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3545
+ *
3546
+ * The version of the OpenAPI document: 3.0
3547
+ * Contact: support@immutable.com
3548
+ *
3549
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3550
+ * https://openapi-generator.tech
3551
+ * Do not edit the class manually.
3552
+ */
3553
+
3554
+ /**
3555
+ * @type GetSignableDepositRequestToken
3556
+ * Details of the token the user is depositing
3557
+ * @export
3558
+ */
3559
+ declare type GetSignableDepositRequestToken = SignableToken;
3560
+
3567
3561
  /**
3568
3562
  * Immutable X API
3569
3563
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3590,10 +3584,10 @@ interface GetSignableDepositRequest {
3590
3584
  'amount': string;
3591
3585
  /**
3592
3586
  *
3593
- * @type {SignableToken}
3587
+ * @type {GetSignableDepositRequestToken}
3594
3588
  * @memberof GetSignableDepositRequest
3595
3589
  */
3596
- 'token': SignableToken;
3590
+ 'token': GetSignableDepositRequestToken;
3597
3591
  /**
3598
3592
  * User who is depositing
3599
3593
  * @type {string}
@@ -3732,7 +3726,7 @@ interface GetSignableOrderRequestV3 {
3732
3726
  */
3733
3727
  'fees'?: Array<FeeEntry>;
3734
3728
  /**
3735
- * 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
3729
+ * SplitFees is a deprecated field. It\'s value is ignored.
3736
3730
  * @type {boolean}
3737
3731
  * @memberof GetSignableOrderRequestV3
3738
3732
  */
@@ -3842,6 +3836,12 @@ interface GetSignableOrderResponse {
3842
3836
  * @memberof GetSignableOrderResponse
3843
3837
  */
3844
3838
  'payload_hash': string;
3839
+ /**
3840
+ * EIP-712 encoding of the StarkEx order transaction to be displayed to the user
3841
+ * @type {string}
3842
+ * @memberof GetSignableOrderResponse
3843
+ */
3844
+ 'readable_transaction': string;
3845
3845
  /**
3846
3846
  * Message to sign with L1 wallet to confirm order request
3847
3847
  * @type {string}
@@ -3866,6 +3866,12 @@ interface GetSignableOrderResponse {
3866
3866
  * @memberof GetSignableOrderResponse
3867
3867
  */
3868
3868
  'vault_id_sell': number;
3869
+ /**
3870
+ * IMX signed readable_transaction and payload_hash
3871
+ * @type {string}
3872
+ * @memberof GetSignableOrderResponse
3873
+ */
3874
+ 'verification_signature': string;
3869
3875
  }
3870
3876
 
3871
3877
  /**
@@ -3891,12 +3897,24 @@ interface GetSignableRegistrationOffchainResponse {
3891
3897
  * @memberof GetSignableRegistrationOffchainResponse
3892
3898
  */
3893
3899
  'payload_hash': string;
3900
+ /**
3901
+ * EIP-712 encoding of the StarkEx Register User Offchain request to be displayed to the user
3902
+ * @type {string}
3903
+ * @memberof GetSignableRegistrationOffchainResponse
3904
+ */
3905
+ 'readable_transaction': string;
3894
3906
  /**
3895
3907
  * Message to sign with L1 wallet to register user offchain
3896
3908
  * @type {string}
3897
3909
  * @memberof GetSignableRegistrationOffchainResponse
3898
3910
  */
3899
3911
  'signable_message': string;
3912
+ /**
3913
+ * IMX signed readable_transaction and payload_hash
3914
+ * @type {string}
3915
+ * @memberof GetSignableRegistrationOffchainResponse
3916
+ */
3917
+ 'verification_signature': string;
3900
3918
  }
3901
3919
 
3902
3920
  /**
@@ -3959,6 +3977,18 @@ interface GetSignableRegistrationResponse {
3959
3977
  * @memberof GetSignableRegistrationResponse
3960
3978
  */
3961
3979
  'payload_hash': string;
3980
+ /**
3981
+ * EIP-712 encoding of the StarkEx Register User request to be displayed to the user
3982
+ * @type {string}
3983
+ * @memberof GetSignableRegistrationResponse
3984
+ */
3985
+ 'readable_transaction': string;
3986
+ /**
3987
+ * IMX signed readable_transaction and payload_hash
3988
+ * @type {string}
3989
+ * @memberof GetSignableRegistrationResponse
3990
+ */
3991
+ 'verification_signature': string;
3962
3992
  }
3963
3993
 
3964
3994
  /**
@@ -4090,6 +4120,12 @@ interface GetSignableTradeResponse {
4090
4120
  * @memberof GetSignableTradeResponse
4091
4121
  */
4092
4122
  'payload_hash': string;
4123
+ /**
4124
+ * EIP-712 encoding of the StarkEx trade transaction to be displayed to the user
4125
+ * @type {string}
4126
+ * @memberof GetSignableTradeResponse
4127
+ */
4128
+ 'readable_transaction': string;
4093
4129
  /**
4094
4130
  * Message to sign with L1 wallet to confirm trade request
4095
4131
  * @type {string}
@@ -4114,8 +4150,33 @@ interface GetSignableTradeResponse {
4114
4150
  * @memberof GetSignableTradeResponse
4115
4151
  */
4116
4152
  'vault_id_sell': number;
4153
+ /**
4154
+ * IMX signed readable_transaction and payload_hash
4155
+ * @type {string}
4156
+ * @memberof GetSignableTradeResponse
4157
+ */
4158
+ 'verification_signature': string;
4117
4159
  }
4118
4160
 
4161
+ /**
4162
+ * Immutable X API
4163
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4164
+ *
4165
+ * The version of the OpenAPI document: 3.0
4166
+ * Contact: support@immutable.com
4167
+ *
4168
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4169
+ * https://openapi-generator.tech
4170
+ * Do not edit the class manually.
4171
+ */
4172
+
4173
+ /**
4174
+ * @type GetSignableTransferRequestToken
4175
+ * Token to transfer
4176
+ * @export
4177
+ */
4178
+ declare type GetSignableTransferRequestToken = SignableToken;
4179
+
4119
4180
  /**
4120
4181
  * Immutable X API
4121
4182
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4131,27 +4192,33 @@ interface GetSignableTradeResponse {
4131
4192
  /**
4132
4193
  *
4133
4194
  * @export
4134
- * @interface SignableTransferDetails
4195
+ * @interface GetSignableTransferRequest
4135
4196
  */
4136
- interface SignableTransferDetails {
4197
+ interface GetSignableTransferRequest {
4137
4198
  /**
4138
4199
  * Amount of the token to transfer
4139
4200
  * @type {string}
4140
- * @memberof SignableTransferDetails
4201
+ * @memberof GetSignableTransferRequest
4141
4202
  */
4142
4203
  'amount': string;
4143
4204
  /**
4144
4205
  * Ethereum address of the receiving user
4145
4206
  * @type {string}
4146
- * @memberof SignableTransferDetails
4207
+ * @memberof GetSignableTransferRequest
4147
4208
  */
4148
4209
  'receiver': string;
4210
+ /**
4211
+ * Ethereum address of the transferring user
4212
+ * @type {string}
4213
+ * @memberof GetSignableTransferRequest
4214
+ */
4215
+ 'sender': string;
4149
4216
  /**
4150
4217
  *
4151
- * @type {SignableToken}
4152
- * @memberof SignableTransferDetails
4218
+ * @type {GetSignableTransferRequestToken}
4219
+ * @memberof GetSignableTransferRequest
4153
4220
  */
4154
- 'token': SignableToken;
4221
+ 'token': GetSignableTransferRequestToken;
4155
4222
  }
4156
4223
 
4157
4224
  /**
@@ -4169,23 +4236,54 @@ interface SignableTransferDetails {
4169
4236
  /**
4170
4237
  *
4171
4238
  * @export
4172
- * @interface GetSignableTransferRequest
4239
+ * @interface GetSignableTransferRequestV1
4173
4240
  */
4174
- interface GetSignableTransferRequest {
4241
+ interface GetSignableTransferRequestV1 {
4242
+ /**
4243
+ * Amount of the token to transfer
4244
+ * @type {string}
4245
+ * @memberof GetSignableTransferRequestV1
4246
+ */
4247
+ 'amount': string;
4248
+ /**
4249
+ * Ethereum address of the receiving user
4250
+ * @type {string}
4251
+ * @memberof GetSignableTransferRequestV1
4252
+ */
4253
+ 'receiver': string;
4175
4254
  /**
4176
4255
  * Ethereum address of the transferring user
4177
4256
  * @type {string}
4178
- * @memberof GetSignableTransferRequest
4257
+ * @memberof GetSignableTransferRequestV1
4179
4258
  */
4180
- 'sender_ether_key': string;
4259
+ 'sender': string;
4181
4260
  /**
4182
- * List of signable transfer details
4183
- * @type {Array<SignableTransferDetails>}
4184
- * @memberof GetSignableTransferRequest
4261
+ *
4262
+ * @type {SignableToken}
4263
+ * @memberof GetSignableTransferRequestV1
4185
4264
  */
4186
- 'signable_requests': Array<SignableTransferDetails>;
4265
+ 'token': SignableToken;
4187
4266
  }
4188
4267
 
4268
+ /**
4269
+ * Immutable X API
4270
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4271
+ *
4272
+ * The version of the OpenAPI document: 3.0
4273
+ * Contact: support@immutable.com
4274
+ *
4275
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4276
+ * https://openapi-generator.tech
4277
+ * Do not edit the class manually.
4278
+ */
4279
+
4280
+ /**
4281
+ * @type SignableTransferDetailsV2Token
4282
+ * Token to transfer
4283
+ * @export
4284
+ */
4285
+ declare type SignableTransferDetailsV2Token = SignableToken;
4286
+
4189
4287
  /**
4190
4288
  * Immutable X API
4191
4289
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4201,35 +4299,80 @@ interface GetSignableTransferRequest {
4201
4299
  /**
4202
4300
  *
4203
4301
  * @export
4204
- * @interface GetSignableTransferRequestV1
4302
+ * @interface SignableTransferDetailsV2
4205
4303
  */
4206
- interface GetSignableTransferRequestV1 {
4304
+ interface SignableTransferDetailsV2 {
4207
4305
  /**
4208
4306
  * Amount of the token to transfer
4209
4307
  * @type {string}
4210
- * @memberof GetSignableTransferRequestV1
4308
+ * @memberof SignableTransferDetailsV2
4211
4309
  */
4212
4310
  'amount': string;
4213
4311
  /**
4214
4312
  * Ethereum address of the receiving user
4215
4313
  * @type {string}
4216
- * @memberof GetSignableTransferRequestV1
4314
+ * @memberof SignableTransferDetailsV2
4217
4315
  */
4218
4316
  'receiver': string;
4317
+ /**
4318
+ *
4319
+ * @type {SignableTransferDetailsV2Token}
4320
+ * @memberof SignableTransferDetailsV2
4321
+ */
4322
+ 'token': SignableTransferDetailsV2Token;
4323
+ }
4324
+
4325
+ /**
4326
+ * Immutable X API
4327
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4328
+ *
4329
+ * The version of the OpenAPI document: 3.0
4330
+ * Contact: support@immutable.com
4331
+ *
4332
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4333
+ * https://openapi-generator.tech
4334
+ * Do not edit the class manually.
4335
+ */
4336
+
4337
+ /**
4338
+ *
4339
+ * @export
4340
+ * @interface GetSignableTransferRequestV2
4341
+ */
4342
+ interface GetSignableTransferRequestV2 {
4219
4343
  /**
4220
4344
  * Ethereum address of the transferring user
4221
4345
  * @type {string}
4222
- * @memberof GetSignableTransferRequestV1
4346
+ * @memberof GetSignableTransferRequestV2
4223
4347
  */
4224
- 'sender': string;
4348
+ 'sender_ether_key': string;
4225
4349
  /**
4226
- *
4227
- * @type {SignableToken}
4228
- * @memberof GetSignableTransferRequestV1
4350
+ * List of signable transfer details
4351
+ * @type {Array<SignableTransferDetailsV2>}
4352
+ * @memberof GetSignableTransferRequestV2
4229
4353
  */
4230
- 'token': SignableToken;
4354
+ 'signable_requests': Array<SignableTransferDetailsV2>;
4231
4355
  }
4232
4356
 
4357
+ /**
4358
+ * Immutable X API
4359
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4360
+ *
4361
+ * The version of the OpenAPI document: 3.0
4362
+ * Contact: support@immutable.com
4363
+ *
4364
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4365
+ * https://openapi-generator.tech
4366
+ * Do not edit the class manually.
4367
+ */
4368
+
4369
+ /**
4370
+ * @type SignableTransferResponseDetailsToken
4371
+ * Token in request to match in SDK implementation
4372
+ * @export
4373
+ */
4374
+ declare type SignableTransferResponseDetailsToken = SignableToken;
4375
+
4233
4376
  /**
4234
4377
  * Immutable X API
4235
4378
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4278,6 +4421,12 @@ interface SignableTransferResponseDetails {
4278
4421
  * @memberof SignableTransferResponseDetails
4279
4422
  */
4280
4423
  'payload_hash': string;
4424
+ /**
4425
+ * EIP-712 encoding of the StarkEx transfer request to be displayed to the user
4426
+ * @type {string}
4427
+ * @memberof SignableTransferResponseDetails
4428
+ */
4429
+ 'readable_transaction': string;
4281
4430
  /**
4282
4431
  * Receiver of the transfer
4283
4432
  * @type {string}
@@ -4298,48 +4447,16 @@ interface SignableTransferResponseDetails {
4298
4447
  'sender_vault_id': number;
4299
4448
  /**
4300
4449
  *
4301
- * @type {SignableToken}
4450
+ * @type {SignableTransferResponseDetailsToken}
4302
4451
  * @memberof SignableTransferResponseDetails
4303
4452
  */
4304
- 'token': SignableToken;
4305
- }
4306
-
4307
- /**
4308
- * Immutable X API
4309
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4310
- *
4311
- * The version of the OpenAPI document: 3.0
4312
- * Contact: support@immutable.com
4313
- *
4314
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4315
- * https://openapi-generator.tech
4316
- * Do not edit the class manually.
4317
- */
4318
-
4319
- /**
4320
- *
4321
- * @export
4322
- * @interface GetSignableTransferResponse
4323
- */
4324
- interface GetSignableTransferResponse {
4325
- /**
4326
- * Sender of the transfer
4327
- * @type {string}
4328
- * @memberof GetSignableTransferResponse
4329
- */
4330
- 'sender_stark_key': string;
4453
+ 'token': SignableTransferResponseDetailsToken;
4331
4454
  /**
4332
- * Message to sign with L1 wallet to confirm transfer request
4455
+ * IMX signed readable_transaction and payload_hash
4333
4456
  * @type {string}
4334
- * @memberof GetSignableTransferResponse
4335
- */
4336
- 'signable_message': string;
4337
- /**
4338
- * List of transfer responses without the sender stark key
4339
- * @type {Array<SignableTransferResponseDetails>}
4340
- * @memberof GetSignableTransferResponse
4457
+ * @memberof SignableTransferResponseDetails
4341
4458
  */
4342
- 'signable_responses': Array<SignableTransferResponseDetails>;
4459
+ 'verification_signature': string;
4343
4460
  }
4344
4461
 
4345
4462
  /**
@@ -4389,6 +4506,12 @@ interface GetSignableTransferResponseV1 {
4389
4506
  * @memberof GetSignableTransferResponseV1
4390
4507
  */
4391
4508
  'payload_hash': string;
4509
+ /**
4510
+ * EIP-712 encoding of the StarkEx transfer transaction to be displayed to the user
4511
+ * @type {string}
4512
+ * @memberof GetSignableTransferResponseV1
4513
+ */
4514
+ 'readable_transaction': string;
4392
4515
  /**
4393
4516
  * Receiver of the transfer
4394
4517
  * @type {string}
@@ -4419,8 +4542,71 @@ interface GetSignableTransferResponseV1 {
4419
4542
  * @memberof GetSignableTransferResponseV1
4420
4543
  */
4421
4544
  'signable_message': string;
4545
+ /**
4546
+ * IMX signed readable_transaction and payload_hash
4547
+ * @type {string}
4548
+ * @memberof GetSignableTransferResponseV1
4549
+ */
4550
+ 'verification_signature': string;
4551
+ }
4552
+
4553
+ /**
4554
+ * Immutable X API
4555
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4556
+ *
4557
+ * The version of the OpenAPI document: 3.0
4558
+ * Contact: support@immutable.com
4559
+ *
4560
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4561
+ * https://openapi-generator.tech
4562
+ * Do not edit the class manually.
4563
+ */
4564
+
4565
+ /**
4566
+ *
4567
+ * @export
4568
+ * @interface GetSignableTransferResponseV2
4569
+ */
4570
+ interface GetSignableTransferResponseV2 {
4571
+ /**
4572
+ * Sender of the transfer
4573
+ * @type {string}
4574
+ * @memberof GetSignableTransferResponseV2
4575
+ */
4576
+ 'sender_stark_key': string;
4577
+ /**
4578
+ * Message to sign with L1 wallet to confirm transfer request
4579
+ * @type {string}
4580
+ * @memberof GetSignableTransferResponseV2
4581
+ */
4582
+ 'signable_message': string;
4583
+ /**
4584
+ * List of transfer responses without the sender stark key
4585
+ * @type {Array<SignableTransferResponseDetails>}
4586
+ * @memberof GetSignableTransferResponseV2
4587
+ */
4588
+ 'signable_responses': Array<SignableTransferResponseDetails>;
4422
4589
  }
4423
4590
 
4591
+ /**
4592
+ * Immutable X API
4593
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4594
+ *
4595
+ * The version of the OpenAPI document: 3.0
4596
+ * Contact: support@immutable.com
4597
+ *
4598
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4599
+ * https://openapi-generator.tech
4600
+ * Do not edit the class manually.
4601
+ */
4602
+
4603
+ /**
4604
+ * @type GetSignableWithdrawalRequestToken
4605
+ * Token to withdraw
4606
+ * @export
4607
+ */
4608
+ declare type GetSignableWithdrawalRequestToken = SignableToken;
4609
+
4424
4610
  /**
4425
4611
  * Immutable X API
4426
4612
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4447,10 +4633,10 @@ interface GetSignableWithdrawalRequest {
4447
4633
  'amount': string;
4448
4634
  /**
4449
4635
  *
4450
- * @type {SignableToken}
4636
+ * @type {GetSignableWithdrawalRequestToken}
4451
4637
  * @memberof GetSignableWithdrawalRequest
4452
4638
  */
4453
- 'token': SignableToken;
4639
+ 'token': GetSignableWithdrawalRequestToken;
4454
4640
  /**
4455
4641
  * Ethereum address of the user who is making this withdrawal
4456
4642
  * @type {string}
@@ -4500,6 +4686,12 @@ interface GetSignableWithdrawalResponse {
4500
4686
  * @memberof GetSignableWithdrawalResponse
4501
4687
  */
4502
4688
  'payload_hash': string;
4689
+ /**
4690
+ * EIP-712 encoding of the StarkEx withdrawal request to be displayed to the user
4691
+ * @type {string}
4692
+ * @memberof GetSignableWithdrawalResponse
4693
+ */
4694
+ 'readable_transaction': string;
4503
4695
  /**
4504
4696
  * Message to sign with L1 wallet to verity withdrawal request
4505
4697
  * @type {string}
@@ -4518,6 +4710,12 @@ interface GetSignableWithdrawalResponse {
4518
4710
  * @memberof GetSignableWithdrawalResponse
4519
4711
  */
4520
4712
  'vault_id': number;
4713
+ /**
4714
+ * IMX signed readable_transaction and payload_hash
4715
+ * @type {string}
4716
+ * @memberof GetSignableWithdrawalResponse
4717
+ */
4718
+ 'verification_signature': string;
4521
4719
  }
4522
4720
 
4523
4721
  /**
@@ -4735,6 +4933,25 @@ interface ListDepositsResponse {
4735
4933
  'result': Array<Deposit>;
4736
4934
  }
4737
4935
 
4936
+ /**
4937
+ * Immutable X API
4938
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4939
+ *
4940
+ * The version of the OpenAPI document: 3.0
4941
+ * Contact: support@immutable.com
4942
+ *
4943
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4944
+ * https://openapi-generator.tech
4945
+ * Do not edit the class manually.
4946
+ */
4947
+
4948
+ /**
4949
+ * @type MintToken
4950
+ * Details of the asset which has been minted
4951
+ * @export
4952
+ */
4953
+ declare type MintToken = Token;
4954
+
4738
4955
  /**
4739
4956
  * Immutable X API
4740
4957
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4773,10 +4990,10 @@ interface Mint {
4773
4990
  'timestamp': string;
4774
4991
  /**
4775
4992
  *
4776
- * @type {Token}
4993
+ * @type {MintToken}
4777
4994
  * @memberof Mint
4778
4995
  */
4779
- 'token': Token;
4996
+ 'token': MintToken;
4780
4997
  /**
4781
4998
  * Sequential ID of transaction in Immutable X
4782
4999
  * @type {number}
@@ -4842,11 +5059,11 @@ interface ListMintsResponse {
4842
5059
  */
4843
5060
 
4844
5061
  /**
4845
- * @type OrderBuy
5062
+ * @type OrderV3Buy
4846
5063
  * Details of the asset being bought
4847
5064
  * @export
4848
5065
  */
4849
- declare type OrderBuy = Token;
5066
+ declare type OrderV3Buy = Token;
4850
5067
 
4851
5068
  /**
4852
5069
  * Immutable X API
@@ -4861,11 +5078,48 @@ declare type OrderBuy = Token;
4861
5078
  */
4862
5079
 
4863
5080
  /**
4864
- * @type OrderSell
4865
- * Details of the asset being sold
5081
+ *
4866
5082
  * @export
5083
+ * @interface OrdersMakerTakerFee
4867
5084
  */
4868
- declare type OrderSell = Token;
5085
+ interface OrdersMakerTakerFee {
5086
+ /**
5087
+ * Number of Decimals supported the fee token
5088
+ * @type {number}
5089
+ * @memberof OrdersMakerTakerFee
5090
+ */
5091
+ 'decimals'?: number;
5092
+ /**
5093
+ * Fees
5094
+ * @type {Array<OrderFeeInfo>}
5095
+ * @memberof OrdersMakerTakerFee
5096
+ */
5097
+ 'fees'?: Array<OrderFeeInfo>;
5098
+ /**
5099
+ * Quantity of this asset with the sum of all fees applied to the asset
5100
+ * @type {string}
5101
+ * @memberof OrdersMakerTakerFee
5102
+ */
5103
+ 'quantity_with_fees': string;
5104
+ /**
5105
+ * Symbol of the fee token
5106
+ * @type {string}
5107
+ * @memberof OrdersMakerTakerFee
5108
+ */
5109
+ 'symbol'?: string;
5110
+ /**
5111
+ * Address of the ERC20 contract for the fee token
5112
+ * @type {string}
5113
+ * @memberof OrdersMakerTakerFee
5114
+ */
5115
+ 'token_address'?: string;
5116
+ /**
5117
+ * Type of the fee token (ETH/ERC20)
5118
+ * @type {string}
5119
+ * @memberof OrdersMakerTakerFee
5120
+ */
5121
+ 'token_type'?: string;
5122
+ }
4869
5123
 
4870
5124
  /**
4871
5125
  * Immutable X API
@@ -4880,201 +5134,8 @@ declare type OrderSell = Token;
4880
5134
  */
4881
5135
 
4882
5136
  /**
4883
- *
4884
- * @export
4885
- * @interface Order
4886
- */
4887
- interface Order {
4888
- /**
4889
- * Amount of the asset already sold by this order
4890
- * @type {string}
4891
- * @memberof Order
4892
- */
4893
- 'amount_sold': string | null;
4894
- /**
4895
- *
4896
- * @type {OrderBuy}
4897
- * @memberof Order
4898
- */
4899
- 'buy': OrderBuy;
4900
- /**
4901
- * Expiration timestamp of this order
4902
- * @type {string}
4903
- * @memberof Order
4904
- */
4905
- 'expiration_timestamp': string | null;
4906
- /**
4907
- * Fee information for the order
4908
- * @type {Array<OrderFeeInfo>}
4909
- * @memberof Order
4910
- */
4911
- 'fees'?: Array<OrderFeeInfo>;
4912
- /**
4913
- * ID of the order
4914
- * @type {number}
4915
- * @memberof Order
4916
- */
4917
- 'order_id': number;
4918
- /**
4919
- *
4920
- * @type {OrderSell}
4921
- * @memberof Order
4922
- */
4923
- 'sell': OrderSell;
4924
- /**
4925
- * Status of the order
4926
- * @type {string}
4927
- * @memberof Order
4928
- */
4929
- 'status': string;
4930
- /**
4931
- * Timestamp this order was created
4932
- * @type {string}
4933
- * @memberof Order
4934
- */
4935
- 'timestamp': string | null;
4936
- /**
4937
- * Updated timestamp of this order
4938
- * @type {string}
4939
- * @memberof Order
4940
- */
4941
- 'updated_timestamp': string | null;
4942
- /**
4943
- * Ethereum address of the user who submitted the order
4944
- * @type {string}
4945
- * @memberof Order
4946
- */
4947
- 'user': string;
4948
- }
4949
-
4950
- /**
4951
- * Immutable X API
4952
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4953
- *
4954
- * The version of the OpenAPI document: 3.0
4955
- * Contact: support@immutable.com
4956
- *
4957
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4958
- * https://openapi-generator.tech
4959
- * Do not edit the class manually.
4960
- */
4961
-
4962
- /**
4963
- *
4964
- * @export
4965
- * @interface ListOrdersResponse
4966
- */
4967
- interface ListOrdersResponse {
4968
- /**
4969
- * Generated cursor returned by previous query
4970
- * @type {string}
4971
- * @memberof ListOrdersResponse
4972
- */
4973
- 'cursor': string;
4974
- /**
4975
- * Remaining results flag. 1: there are remaining results matching this query, 0: no remaining results
4976
- * @type {number}
4977
- * @memberof ListOrdersResponse
4978
- */
4979
- 'remaining': number;
4980
- /**
4981
- * Orders matching query parameters
4982
- * @type {Array<Order>}
4983
- * @memberof ListOrdersResponse
4984
- */
4985
- 'result': Array<Order>;
4986
- }
4987
-
4988
- /**
4989
- * Immutable X API
4990
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4991
- *
4992
- * The version of the OpenAPI document: 3.0
4993
- * Contact: support@immutable.com
4994
- *
4995
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4996
- * https://openapi-generator.tech
4997
- * Do not edit the class manually.
4998
- */
4999
-
5000
- /**
5001
- * @type OrderV3Buy
5002
- * Details of the asset being bought
5003
- * @export
5004
- */
5005
- declare type OrderV3Buy = Token;
5006
-
5007
- /**
5008
- * Immutable X API
5009
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5010
- *
5011
- * The version of the OpenAPI document: 3.0
5012
- * Contact: support@immutable.com
5013
- *
5014
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5015
- * https://openapi-generator.tech
5016
- * Do not edit the class manually.
5017
- */
5018
-
5019
- /**
5020
- *
5021
- * @export
5022
- * @interface OrdersMakerTakerFee
5023
- */
5024
- interface OrdersMakerTakerFee {
5025
- /**
5026
- * Number of Decimals supported the fee token
5027
- * @type {number}
5028
- * @memberof OrdersMakerTakerFee
5029
- */
5030
- 'decimals'?: number;
5031
- /**
5032
- * Fees
5033
- * @type {Array<OrderFeeInfo>}
5034
- * @memberof OrdersMakerTakerFee
5035
- */
5036
- 'fees'?: Array<OrderFeeInfo>;
5037
- /**
5038
- * Quantity of this asset with the sum of all fees applied to the asset
5039
- * @type {string}
5040
- * @memberof OrdersMakerTakerFee
5041
- */
5042
- 'quantity_with_fees': string;
5043
- /**
5044
- * Symbol of the fee token
5045
- * @type {string}
5046
- * @memberof OrdersMakerTakerFee
5047
- */
5048
- 'symbol'?: string;
5049
- /**
5050
- * Address of the ERC20 contract for the fee token
5051
- * @type {string}
5052
- * @memberof OrdersMakerTakerFee
5053
- */
5054
- 'token_address'?: string;
5055
- /**
5056
- * Type of the fee token (ETH/ERC20)
5057
- * @type {string}
5058
- * @memberof OrdersMakerTakerFee
5059
- */
5060
- 'token_type'?: string;
5061
- }
5062
-
5063
- /**
5064
- * Immutable X API
5065
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5066
- *
5067
- * The version of the OpenAPI document: 3.0
5068
- * Contact: support@immutable.com
5069
- *
5070
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5071
- * https://openapi-generator.tech
5072
- * Do not edit the class manually.
5073
- */
5074
-
5075
- /**
5076
- * @type OrderV3MakerFees
5077
- * MakerFees is the information about the fees that needs to be paid by the maker (liquidity)
5137
+ * @type OrderV3MakerFees
5138
+ * MakerFees is the information about the fees that needs to be paid by the maker (liquidity)
5078
5139
  * @export
5079
5140
  */
5080
5141
  declare type OrderV3MakerFees = OrdersMakerTakerFee;
@@ -5301,7 +5362,7 @@ interface TokenDetails {
5301
5362
  */
5302
5363
  'symbol': string;
5303
5364
  /**
5304
- * Address of the ERC721 contract
5365
+ * Address of the ERC20 contract
5305
5366
  * @type {string}
5306
5367
  * @memberof TokenDetails
5307
5368
  */
@@ -5515,6 +5576,25 @@ interface ListTradesResponse {
5515
5576
  'result': Array<Trade>;
5516
5577
  }
5517
5578
 
5579
+ /**
5580
+ * Immutable X API
5581
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5582
+ *
5583
+ * The version of the OpenAPI document: 3.0
5584
+ * Contact: support@immutable.com
5585
+ *
5586
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5587
+ * https://openapi-generator.tech
5588
+ * Do not edit the class manually.
5589
+ */
5590
+
5591
+ /**
5592
+ * @type TransferToken
5593
+ * Token transferred by the user
5594
+ * @export
5595
+ */
5596
+ declare type TransferToken = Token;
5597
+
5518
5598
  /**
5519
5599
  * Immutable X API
5520
5600
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -5553,10 +5633,10 @@ interface Transfer {
5553
5633
  'timestamp': string | null;
5554
5634
  /**
5555
5635
  *
5556
- * @type {Token}
5636
+ * @type {TransferToken}
5557
5637
  * @memberof Transfer
5558
5638
  */
5559
- 'token': Token;
5639
+ 'token': TransferToken;
5560
5640
  /**
5561
5641
  * Sequential transaction ID
5562
5642
  * @type {number}
@@ -5609,6 +5689,25 @@ interface ListTransfersResponse {
5609
5689
  'result': Array<Transfer>;
5610
5690
  }
5611
5691
 
5692
+ /**
5693
+ * Immutable X API
5694
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5695
+ *
5696
+ * The version of the OpenAPI document: 3.0
5697
+ * Contact: support@immutable.com
5698
+ *
5699
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5700
+ * https://openapi-generator.tech
5701
+ * Do not edit the class manually.
5702
+ */
5703
+
5704
+ /**
5705
+ * @type WithdrawalToken
5706
+ * Details of the asset this user is withdrawing
5707
+ * @export
5708
+ */
5709
+ declare type WithdrawalToken = Token;
5710
+
5612
5711
  /**
5613
5712
  * Immutable X API
5614
5713
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -5653,10 +5752,10 @@ interface Withdrawal {
5653
5752
  'timestamp': string;
5654
5753
  /**
5655
5754
  *
5656
- * @type {Token}
5755
+ * @type {WithdrawalToken}
5657
5756
  * @memberof Withdrawal
5658
5757
  */
5659
- 'token': Token;
5758
+ 'token': WithdrawalToken;
5660
5759
  /**
5661
5760
  * Sequential ID of this transaction
5662
5761
  * @type {number}
@@ -6365,6 +6464,43 @@ interface NftprimarytransactionListTransactionsResponse {
6365
6464
  'result'?: Array<NftprimarytransactionTransactionData>;
6366
6465
  }
6367
6466
 
6467
+ /**
6468
+ * Immutable X API
6469
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6470
+ *
6471
+ * The version of the OpenAPI document: 3.0
6472
+ * Contact: support@immutable.com
6473
+ *
6474
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6475
+ * https://openapi-generator.tech
6476
+ * Do not edit the class manually.
6477
+ */
6478
+ /**
6479
+ *
6480
+ * @export
6481
+ * @interface RegisterPassportUserResult
6482
+ */
6483
+ interface RegisterPassportUserResult {
6484
+ /**
6485
+ * The ether key of the user
6486
+ * @type {string}
6487
+ * @memberof RegisterPassportUserResult
6488
+ */
6489
+ 'ether_key'?: string;
6490
+ /**
6491
+ * The stark key of the user
6492
+ * @type {string}
6493
+ * @memberof RegisterPassportUserResult
6494
+ */
6495
+ 'stark_key'?: string;
6496
+ /**
6497
+ * The admin key of the user
6498
+ * @type {string}
6499
+ * @memberof RegisterPassportUserResult
6500
+ */
6501
+ 'user_admin_key'?: string;
6502
+ }
6503
+
6368
6504
  /**
6369
6505
  * Immutable X API
6370
6506
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -8101,423 +8237,130 @@ declare class NftCheckoutPrimaryApi extends BaseAPI {
8101
8237
  */
8102
8238
  registerNftPrimarySalesContract(requestParameters: NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ContractCreateResponse, any>>;
8103
8239
  }
8104
- /**
8105
- * Request parameters for cancelOrder operation in OrdersApi.
8106
- * @export
8107
- * @interface OrdersApiCancelOrderRequest
8108
- */
8109
- interface OrdersApiCancelOrderRequest {
8110
- /**
8111
- * Order ID to cancel
8112
- * @type {string}
8113
- * @memberof OrdersApiCancelOrder
8114
- */
8115
- readonly id: string;
8116
- /**
8117
- * cancel an order
8118
- * @type {CancelOrderRequest}
8119
- * @memberof OrdersApiCancelOrder
8120
- */
8121
- readonly cancelOrderRequest: CancelOrderRequest;
8122
- /**
8123
- * eth address
8124
- * @type {string}
8125
- * @memberof OrdersApiCancelOrder
8126
- */
8127
- readonly xImxEthAddress?: string;
8128
- /**
8129
- * eth signature
8130
- * @type {string}
8131
- * @memberof OrdersApiCancelOrder
8132
- */
8133
- readonly xImxEthSignature?: string;
8134
- /**
8135
- * Authorization header
8136
- * @type {string}
8137
- * @memberof OrdersApiCancelOrder
8138
- */
8139
- readonly authorization?: string;
8140
- }
8141
8240
  /**
8142
8241
  * Request parameters for cancelOrderV3 operation in OrdersApi.
8143
8242
  * @export
8144
8243
  * @interface OrdersApiCancelOrderV3Request
8145
- */
8146
- interface OrdersApiCancelOrderV3Request {
8147
- /**
8148
- * Order ID to cancel
8149
- * @type {string}
8150
- * @memberof OrdersApiCancelOrderV3
8151
- */
8152
- readonly id: string;
8153
- /**
8154
- * cancel an order
8155
- * @type {CancelOrderRequest}
8156
- * @memberof OrdersApiCancelOrderV3
8157
- */
8158
- readonly cancelOrderRequest: CancelOrderRequest;
8159
- /**
8160
- * eth address
8161
- * @type {string}
8162
- * @memberof OrdersApiCancelOrderV3
8163
- */
8164
- readonly xImxEthAddress?: string;
8165
- /**
8166
- * eth signature
8167
- * @type {string}
8168
- * @memberof OrdersApiCancelOrderV3
8169
- */
8170
- readonly xImxEthSignature?: string;
8171
- /**
8172
- * Authorization header
8173
- * @type {string}
8174
- * @memberof OrdersApiCancelOrderV3
8175
- */
8176
- readonly authorization?: string;
8177
- }
8178
- /**
8179
- * Request parameters for createOrder operation in OrdersApi.
8180
- * @export
8181
- * @interface OrdersApiCreateOrderRequest
8182
- */
8183
- interface OrdersApiCreateOrderRequest {
8184
- /**
8185
- * create an order
8186
- * @type {CreateOrderRequest}
8187
- * @memberof OrdersApiCreateOrder
8188
- */
8189
- readonly createOrderRequest: CreateOrderRequest;
8190
- /**
8191
- * eth address
8192
- * @type {string}
8193
- * @memberof OrdersApiCreateOrder
8194
- */
8195
- readonly xImxEthAddress?: string;
8196
- /**
8197
- * eth signature
8198
- * @type {string}
8199
- * @memberof OrdersApiCreateOrder
8200
- */
8201
- readonly xImxEthSignature?: string;
8202
- /**
8203
- * Authorization header
8204
- * @type {string}
8205
- * @memberof OrdersApiCreateOrder
8206
- */
8207
- readonly authorization?: string;
8208
- }
8209
- /**
8210
- * Request parameters for createOrderV3 operation in OrdersApi.
8211
- * @export
8212
- * @interface OrdersApiCreateOrderV3Request
8213
- */
8214
- interface OrdersApiCreateOrderV3Request {
8215
- /**
8216
- * create an order
8217
- * @type {CreateOrderRequestV3}
8218
- * @memberof OrdersApiCreateOrderV3
8219
- */
8220
- readonly createOrderRequest: CreateOrderRequestV3;
8221
- /**
8222
- * eth address
8223
- * @type {string}
8224
- * @memberof OrdersApiCreateOrderV3
8225
- */
8226
- readonly xImxEthAddress?: string;
8227
- /**
8228
- * eth signature
8229
- * @type {string}
8230
- * @memberof OrdersApiCreateOrderV3
8231
- */
8232
- readonly xImxEthSignature?: string;
8233
- /**
8234
- * Authorization header
8235
- * @type {string}
8236
- * @memberof OrdersApiCreateOrderV3
8237
- */
8238
- readonly authorization?: string;
8239
- }
8240
- /**
8241
- * Request parameters for getOrder operation in OrdersApi.
8242
- * @export
8243
- * @interface OrdersApiGetOrderRequest
8244
- */
8245
- interface OrdersApiGetOrderRequest {
8246
- /**
8247
- * Order ID
8248
- * @type {string}
8249
- * @memberof OrdersApiGetOrder
8250
- */
8251
- readonly id: string;
8252
- /**
8253
- * Set flag to true to include fee body for the order
8254
- * @type {boolean}
8255
- * @memberof OrdersApiGetOrder
8256
- */
8257
- readonly includeFees?: boolean;
8258
- /**
8259
- * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
8260
- * @type {string}
8261
- * @memberof OrdersApiGetOrder
8262
- */
8263
- readonly auxiliaryFeePercentages?: string;
8264
- /**
8265
- * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
8266
- * @type {string}
8267
- * @memberof OrdersApiGetOrder
8268
- */
8269
- readonly auxiliaryFeeRecipients?: string;
8270
- }
8271
- /**
8272
- * Request parameters for getOrderV3 operation in OrdersApi.
8273
- * @export
8274
- * @interface OrdersApiGetOrderV3Request
8275
- */
8276
- interface OrdersApiGetOrderV3Request {
8277
- /**
8278
- * Order ID
8279
- * @type {string}
8280
- * @memberof OrdersApiGetOrderV3
8281
- */
8282
- readonly id: string;
8283
- /**
8284
- * Set flag to true to include fee body for the order
8285
- * @type {boolean}
8286
- * @memberof OrdersApiGetOrderV3
8287
- */
8288
- readonly includeFees?: boolean;
8289
- /**
8290
- * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
8291
- * @type {string}
8292
- * @memberof OrdersApiGetOrderV3
8293
- */
8294
- readonly auxiliaryFeePercentages?: string;
8295
- /**
8296
- * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
8297
- * @type {string}
8298
- * @memberof OrdersApiGetOrderV3
8299
- */
8300
- readonly auxiliaryFeeRecipients?: string;
8301
- }
8302
- /**
8303
- * Request parameters for getSignableCancelOrder operation in OrdersApi.
8304
- * @export
8305
- * @interface OrdersApiGetSignableCancelOrderRequest
8306
- */
8307
- interface OrdersApiGetSignableCancelOrderRequest {
8308
- /**
8309
- * get a signable cancel order
8310
- * @type {GetSignableCancelOrderRequest}
8311
- * @memberof OrdersApiGetSignableCancelOrder
8312
- */
8313
- readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
8314
- }
8315
- /**
8316
- * Request parameters for getSignableCancelOrderV3 operation in OrdersApi.
8317
- * @export
8318
- * @interface OrdersApiGetSignableCancelOrderV3Request
8319
- */
8320
- interface OrdersApiGetSignableCancelOrderV3Request {
8321
- /**
8322
- * get a signable cancel order
8323
- * @type {GetSignableCancelOrderRequest}
8324
- * @memberof OrdersApiGetSignableCancelOrderV3
8325
- */
8326
- readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
8327
- }
8328
- /**
8329
- * Request parameters for getSignableOrder operation in OrdersApi.
8330
- * @export
8331
- * @interface OrdersApiGetSignableOrderRequest
8332
- */
8333
- interface OrdersApiGetSignableOrderRequest {
8334
- /**
8335
- * get a signable order v3
8336
- * @type {GetSignableOrderRequestV3}
8337
- * @memberof OrdersApiGetSignableOrder
8338
- */
8339
- readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
8340
- }
8341
- /**
8342
- * Request parameters for listOrders operation in OrdersApi.
8343
- * @export
8344
- * @interface OrdersApiListOrdersRequest
8345
- */
8346
- interface OrdersApiListOrdersRequest {
8347
- /**
8348
- * Page size of the result
8349
- * @type {number}
8350
- * @memberof OrdersApiListOrders
8351
- */
8352
- readonly pageSize?: number;
8353
- /**
8354
- * Cursor
8355
- * @type {string}
8356
- * @memberof OrdersApiListOrders
8357
- */
8358
- readonly cursor?: string;
8359
- /**
8360
- * Property to sort by
8361
- * @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
8362
- * @memberof OrdersApiListOrders
8363
- */
8364
- readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
8365
- /**
8366
- * Direction to sort (asc/desc)
8367
- * @type {string}
8368
- * @memberof OrdersApiListOrders
8369
- */
8370
- readonly direction?: string;
8371
- /**
8372
- * Ethereum address of the user who submitted this order
8373
- * @type {string}
8374
- * @memberof OrdersApiListOrders
8375
- */
8376
- readonly user?: string;
8377
- /**
8378
- * Status of this order
8379
- * @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
8380
- * @memberof OrdersApiListOrders
8381
- */
8382
- readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
8383
- /**
8384
- * 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;
8385
- * @type {string}
8386
- * @memberof OrdersApiListOrders
8387
- */
8388
- readonly minTimestamp?: string;
8389
- /**
8390
- * 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;
8391
- * @type {string}
8392
- * @memberof OrdersApiListOrders
8393
- */
8394
- readonly maxTimestamp?: string;
8395
- /**
8396
- * 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;
8397
- * @type {string}
8398
- * @memberof OrdersApiListOrders
8399
- */
8400
- readonly updatedMinTimestamp?: string;
8401
- /**
8402
- * 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;
8403
- * @type {string}
8404
- * @memberof OrdersApiListOrders
8405
- */
8406
- readonly updatedMaxTimestamp?: string;
8407
- /**
8408
- * Token type of the asset this order buys
8409
- * @type {string}
8410
- * @memberof OrdersApiListOrders
8411
- */
8412
- readonly buyTokenType?: string;
8413
- /**
8414
- * ERC721 Token ID of the asset this order buys
8415
- * @type {string}
8416
- * @memberof OrdersApiListOrders
8417
- */
8418
- readonly buyTokenId?: string;
8419
- /**
8420
- * Internal IMX ID of the asset this order buys
8421
- * @type {string}
8422
- * @memberof OrdersApiListOrders
8423
- */
8424
- readonly buyAssetId?: string;
8425
- /**
8426
- * Token address of the asset this order buys
8427
- * @type {string}
8428
- * @memberof OrdersApiListOrders
8429
- */
8430
- readonly buyTokenAddress?: string;
8431
- /**
8432
- * Token name of the asset this order buys
8433
- * @type {string}
8434
- * @memberof OrdersApiListOrders
8435
- */
8436
- readonly buyTokenName?: string;
8244
+ */
8245
+ interface OrdersApiCancelOrderV3Request {
8437
8246
  /**
8438
- * Min quantity for the asset this order buys
8247
+ * Order ID to cancel
8439
8248
  * @type {string}
8440
- * @memberof OrdersApiListOrders
8249
+ * @memberof OrdersApiCancelOrderV3
8441
8250
  */
8442
- readonly buyMinQuantity?: string;
8251
+ readonly id: string;
8443
8252
  /**
8444
- * Max quantity for the asset this order buys
8445
- * @type {string}
8446
- * @memberof OrdersApiListOrders
8253
+ * cancel an order
8254
+ * @type {CancelOrderRequest}
8255
+ * @memberof OrdersApiCancelOrderV3
8447
8256
  */
8448
- readonly buyMaxQuantity?: string;
8257
+ readonly cancelOrderRequest: CancelOrderRequest;
8449
8258
  /**
8450
- * JSON-encoded metadata filters for the asset this order buys
8259
+ * eth address
8451
8260
  * @type {string}
8452
- * @memberof OrdersApiListOrders
8261
+ * @memberof OrdersApiCancelOrderV3
8453
8262
  */
8454
- readonly buyMetadata?: string;
8263
+ readonly xImxEthAddress?: string;
8455
8264
  /**
8456
- * Token type of the asset this order sells
8265
+ * eth signature
8457
8266
  * @type {string}
8458
- * @memberof OrdersApiListOrders
8267
+ * @memberof OrdersApiCancelOrderV3
8459
8268
  */
8460
- readonly sellTokenType?: string;
8269
+ readonly xImxEthSignature?: string;
8461
8270
  /**
8462
- * ERC721 Token ID of the asset this order sells
8271
+ * Authorization header
8463
8272
  * @type {string}
8464
- * @memberof OrdersApiListOrders
8273
+ * @memberof OrdersApiCancelOrderV3
8465
8274
  */
8466
- readonly sellTokenId?: string;
8275
+ readonly authorization?: string;
8276
+ }
8277
+ /**
8278
+ * Request parameters for createOrderV3 operation in OrdersApi.
8279
+ * @export
8280
+ * @interface OrdersApiCreateOrderV3Request
8281
+ */
8282
+ interface OrdersApiCreateOrderV3Request {
8467
8283
  /**
8468
- * Internal IMX ID of the asset this order sells
8469
- * @type {string}
8470
- * @memberof OrdersApiListOrders
8284
+ * create an order
8285
+ * @type {CreateOrderRequestV3}
8286
+ * @memberof OrdersApiCreateOrderV3
8471
8287
  */
8472
- readonly sellAssetId?: string;
8288
+ readonly createOrderRequest: CreateOrderRequestV3;
8473
8289
  /**
8474
- * Token address of the asset this order sells
8290
+ * eth address
8475
8291
  * @type {string}
8476
- * @memberof OrdersApiListOrders
8292
+ * @memberof OrdersApiCreateOrderV3
8477
8293
  */
8478
- readonly sellTokenAddress?: string;
8294
+ readonly xImxEthAddress?: string;
8479
8295
  /**
8480
- * Token name of the asset this order sells
8296
+ * eth signature
8481
8297
  * @type {string}
8482
- * @memberof OrdersApiListOrders
8298
+ * @memberof OrdersApiCreateOrderV3
8483
8299
  */
8484
- readonly sellTokenName?: string;
8300
+ readonly xImxEthSignature?: string;
8485
8301
  /**
8486
- * Min quantity for the asset this order sells
8302
+ * Authorization header
8487
8303
  * @type {string}
8488
- * @memberof OrdersApiListOrders
8304
+ * @memberof OrdersApiCreateOrderV3
8489
8305
  */
8490
- readonly sellMinQuantity?: string;
8306
+ readonly authorization?: string;
8307
+ }
8308
+ /**
8309
+ * Request parameters for getOrderV3 operation in OrdersApi.
8310
+ * @export
8311
+ * @interface OrdersApiGetOrderV3Request
8312
+ */
8313
+ interface OrdersApiGetOrderV3Request {
8491
8314
  /**
8492
- * Max quantity for the asset this order sells
8315
+ * Order ID
8493
8316
  * @type {string}
8494
- * @memberof OrdersApiListOrders
8317
+ * @memberof OrdersApiGetOrderV3
8495
8318
  */
8496
- readonly sellMaxQuantity?: string;
8319
+ readonly id: string;
8497
8320
  /**
8498
- * JSON-encoded metadata filters for the asset this order sells
8499
- * @type {string}
8500
- * @memberof OrdersApiListOrders
8321
+ * Set flag to true to include fee body for the order
8322
+ * @type {boolean}
8323
+ * @memberof OrdersApiGetOrderV3
8501
8324
  */
8502
- readonly sellMetadata?: string;
8325
+ readonly includeFees?: boolean;
8503
8326
  /**
8504
8327
  * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
8505
8328
  * @type {string}
8506
- * @memberof OrdersApiListOrders
8329
+ * @memberof OrdersApiGetOrderV3
8507
8330
  */
8508
8331
  readonly auxiliaryFeePercentages?: string;
8509
8332
  /**
8510
8333
  * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
8511
8334
  * @type {string}
8512
- * @memberof OrdersApiListOrders
8335
+ * @memberof OrdersApiGetOrderV3
8513
8336
  */
8514
8337
  readonly auxiliaryFeeRecipients?: string;
8338
+ }
8339
+ /**
8340
+ * Request parameters for getSignableCancelOrderV3 operation in OrdersApi.
8341
+ * @export
8342
+ * @interface OrdersApiGetSignableCancelOrderV3Request
8343
+ */
8344
+ interface OrdersApiGetSignableCancelOrderV3Request {
8515
8345
  /**
8516
- * Set flag to true to include fee object for orders
8517
- * @type {boolean}
8518
- * @memberof OrdersApiListOrders
8346
+ * get a signable cancel order
8347
+ * @type {GetSignableCancelOrderRequest}
8348
+ * @memberof OrdersApiGetSignableCancelOrderV3
8519
8349
  */
8520
- readonly includeFees?: boolean;
8350
+ readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
8351
+ }
8352
+ /**
8353
+ * Request parameters for getSignableOrder operation in OrdersApi.
8354
+ * @export
8355
+ * @interface OrdersApiGetSignableOrderRequest
8356
+ */
8357
+ interface OrdersApiGetSignableOrderRequest {
8358
+ /**
8359
+ * get a signable order v3
8360
+ * @type {GetSignableOrderRequestV3}
8361
+ * @memberof OrdersApiGetSignableOrder
8362
+ */
8363
+ readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
8521
8364
  }
8522
8365
  /**
8523
8366
  * Request parameters for listOrdersV3 operation in OrdersApi.
@@ -8707,16 +8550,6 @@ interface OrdersApiListOrdersV3Request {
8707
8550
  * @extends {BaseAPI}
8708
8551
  */
8709
8552
  declare class OrdersApi extends BaseAPI {
8710
- /**
8711
- * 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
8712
- * @summary Cancel an order
8713
- * @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
8714
- * @param {*} [options] Override http request option.
8715
- * @deprecated
8716
- * @throws {RequiredError}
8717
- * @memberof OrdersApi
8718
- */
8719
- cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
8720
8553
  /**
8721
8554
  * Cancel an order (V3)
8722
8555
  * @summary Cancel an order (V3)
@@ -8727,17 +8560,7 @@ declare class OrdersApi extends BaseAPI {
8727
8560
  */
8728
8561
  cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
8729
8562
  /**
8730
- * 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
8731
- * @summary Create an order
8732
- * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
8733
- * @param {*} [options] Override http request option.
8734
- * @deprecated
8735
- * @throws {RequiredError}
8736
- * @memberof OrdersApi
8737
- */
8738
- createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
8739
- /**
8740
- * Create an order using the v3 orderbook. Currently only buy NFT orders are supported.
8563
+ * Create an order using the v3 orderbook.
8741
8564
  * @summary Create an order (V3)
8742
8565
  * @param {OrdersApiCreateOrderV3Request} requestParameters Request parameters.
8743
8566
  * @param {*} [options] Override http request option.
@@ -8745,16 +8568,6 @@ declare class OrdersApi extends BaseAPI {
8745
8568
  * @memberof OrdersApi
8746
8569
  */
8747
8570
  createOrderV3(requestParameters: OrdersApiCreateOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
8748
- /**
8749
- * 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
8750
- * @summary Get an order
8751
- * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
8752
- * @param {*} [options] Override http request option.
8753
- * @deprecated
8754
- * @throws {RequiredError}
8755
- * @memberof OrdersApi
8756
- */
8757
- getOrder(requestParameters: OrdersApiGetOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Order, any>>;
8758
8571
  /**
8759
8572
  * Get an order (V3)
8760
8573
  * @summary Get an order (V3)
@@ -8764,16 +8577,6 @@ declare class OrdersApi extends BaseAPI {
8764
8577
  * @memberof OrdersApi
8765
8578
  */
8766
8579
  getOrderV3(requestParameters: OrdersApiGetOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<OrderV3, any>>;
8767
- /**
8768
- * 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
8769
- * @summary Sign cancel order message
8770
- * @param {OrdersApiGetSignableCancelOrderRequest} requestParameters Request parameters.
8771
- * @param {*} [options] Override http request option.
8772
- * @deprecated
8773
- * @throws {RequiredError}
8774
- * @memberof OrdersApi
8775
- */
8776
- getSignableCancelOrder(requestParameters: OrdersApiGetSignableCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
8777
8580
  /**
8778
8581
  * Generate a signable cancel order message (V3)
8779
8582
  * @summary Generate a signable cancel order message (V3)
@@ -8792,16 +8595,6 @@ declare class OrdersApi extends BaseAPI {
8792
8595
  * @memberof OrdersApi
8793
8596
  */
8794
8597
  getSignableOrder(requestParameters: OrdersApiGetSignableOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableOrderResponse, any>>;
8795
- /**
8796
- * 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
8797
- * @summary Get a list of orders.
8798
- * @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
8799
- * @param {*} [options] Override http request option.
8800
- * @deprecated
8801
- * @throws {RequiredError}
8802
- * @memberof OrdersApi
8803
- */
8804
- listOrders(requestParameters?: OrdersApiListOrdersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponse, any>>;
8805
8598
  /**
8806
8599
  * Get a list of orders (V3)
8807
8600
  * @summary Get a list of orders (V3)
@@ -8905,6 +8698,31 @@ interface ProjectsApiGetProjectsRequest {
8905
8698
  */
8906
8699
  readonly direction?: string;
8907
8700
  }
8701
+ /**
8702
+ * Request parameters for getSdkVersion operation in ProjectsApi.
8703
+ * @export
8704
+ * @interface ProjectsApiGetSdkVersionRequest
8705
+ */
8706
+ interface ProjectsApiGetSdkVersionRequest {
8707
+ /**
8708
+ * Runtime Details
8709
+ * @type {string}
8710
+ * @memberof ProjectsApiGetSdkVersion
8711
+ */
8712
+ readonly details: string;
8713
+ /**
8714
+ * SDK Version
8715
+ * @type {string}
8716
+ * @memberof ProjectsApiGetSdkVersion
8717
+ */
8718
+ readonly version?: string;
8719
+ /**
8720
+ * Runtime ID
8721
+ * @type {string}
8722
+ * @memberof ProjectsApiGetSdkVersion
8723
+ */
8724
+ readonly id?: string;
8725
+ }
8908
8726
  /**
8909
8727
  * ProjectsApi - object-oriented interface
8910
8728
  * @export
@@ -8917,6 +8735,7 @@ declare class ProjectsApi extends BaseAPI {
8917
8735
  * @summary Create a project
8918
8736
  * @param {ProjectsApiCreateProjectRequest} requestParameters Request parameters.
8919
8737
  * @param {*} [options] Override http request option.
8738
+ * @deprecated
8920
8739
  * @throws {RequiredError}
8921
8740
  * @memberof ProjectsApi
8922
8741
  */
@@ -8939,6 +8758,15 @@ declare class ProjectsApi extends BaseAPI {
8939
8758
  * @memberof ProjectsApi
8940
8759
  */
8941
8760
  getProjects(requestParameters: ProjectsApiGetProjectsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetProjectsResponse, any>>;
8761
+ /**
8762
+ * Checks the SDK Version of caller against the current SDK Version and returns a message.
8763
+ * @summary Checks the SDK Version of caller against the current SDK Version
8764
+ * @param {ProjectsApiGetSdkVersionRequest} requestParameters Request parameters.
8765
+ * @param {*} [options] Override http request option.
8766
+ * @throws {RequiredError}
8767
+ * @memberof ProjectsApi
8768
+ */
8769
+ getSdkVersion(requestParameters: ProjectsApiGetSdkVersionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ApiSDKVersionCheckResponse, any>>;
8942
8770
  }
8943
8771
  /**
8944
8772
  * Request parameters for getToken operation in TokensApi.
@@ -9022,37 +8850,6 @@ declare class TokensApi extends BaseAPI {
9022
8850
  */
9023
8851
  listTokens(requestParameters?: TokensApiListTokensRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTokensResponse, any>>;
9024
8852
  }
9025
- /**
9026
- * Request parameters for createTrade operation in TradesApi.
9027
- * @export
9028
- * @interface TradesApiCreateTradeRequest
9029
- */
9030
- interface TradesApiCreateTradeRequest {
9031
- /**
9032
- * create a trade
9033
- * @type {CreateTradeRequestV1}
9034
- * @memberof TradesApiCreateTrade
9035
- */
9036
- readonly createTradeRequest: CreateTradeRequestV1;
9037
- /**
9038
- * eth address
9039
- * @type {string}
9040
- * @memberof TradesApiCreateTrade
9041
- */
9042
- readonly xImxEthAddress?: string;
9043
- /**
9044
- * eth signature
9045
- * @type {string}
9046
- * @memberof TradesApiCreateTrade
9047
- */
9048
- readonly xImxEthSignature?: string;
9049
- /**
9050
- * Authorization header
9051
- * @type {string}
9052
- * @memberof TradesApiCreateTrade
9053
- */
9054
- readonly authorization?: string;
9055
- }
9056
8853
  /**
9057
8854
  * Request parameters for createTradeV3 operation in TradesApi.
9058
8855
  * @export
@@ -9098,91 +8895,18 @@ interface TradesApiGetSignableTradeRequest {
9098
8895
  readonly getSignableTradeRequest: GetSignableTradeRequest;
9099
8896
  }
9100
8897
  /**
9101
- * Request parameters for getTrade operation in TradesApi.
8898
+ * Request parameters for getTradeV3 operation in TradesApi.
9102
8899
  * @export
9103
- * @interface TradesApiGetTradeRequest
8900
+ * @interface TradesApiGetTradeV3Request
9104
8901
  */
9105
- interface TradesApiGetTradeRequest {
8902
+ interface TradesApiGetTradeV3Request {
9106
8903
  /**
9107
8904
  * Trade ID
9108
8905
  * @type {string}
9109
- * @memberof TradesApiGetTrade
8906
+ * @memberof TradesApiGetTradeV3
9110
8907
  */
9111
8908
  readonly id: string;
9112
8909
  }
9113
- /**
9114
- * Request parameters for listTrades operation in TradesApi.
9115
- * @export
9116
- * @interface TradesApiListTradesRequest
9117
- */
9118
- interface TradesApiListTradesRequest {
9119
- /**
9120
- * Party A\&#39;s (buy order) token type of currency used to buy
9121
- * @type {string}
9122
- * @memberof TradesApiListTrades
9123
- */
9124
- readonly partyATokenType?: string;
9125
- /**
9126
- * Party A\&#39;s (buy order) token address of currency used to buy
9127
- * @type {string}
9128
- * @memberof TradesApiListTrades
9129
- */
9130
- readonly partyATokenAddress?: string;
9131
- /**
9132
- * Party B\&#39;s (sell order) token type of NFT sold - always ERC721
9133
- * @type {string}
9134
- * @memberof TradesApiListTrades
9135
- */
9136
- readonly partyBTokenType?: string;
9137
- /**
9138
- * Party B\&#39;s (sell order) collection address of NFT sold
9139
- * @type {string}
9140
- * @memberof TradesApiListTrades
9141
- */
9142
- readonly partyBTokenAddress?: string;
9143
- /**
9144
- * Party B\&#39;s (sell order) token id of NFT sold
9145
- * @type {string}
9146
- * @memberof TradesApiListTrades
9147
- */
9148
- readonly partyBTokenId?: string;
9149
- /**
9150
- * Page size of the result
9151
- * @type {number}
9152
- * @memberof TradesApiListTrades
9153
- */
9154
- readonly pageSize?: number;
9155
- /**
9156
- * Cursor
9157
- * @type {string}
9158
- * @memberof TradesApiListTrades
9159
- */
9160
- readonly cursor?: string;
9161
- /**
9162
- * Property to sort by
9163
- * @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
9164
- * @memberof TradesApiListTrades
9165
- */
9166
- readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
9167
- /**
9168
- * Direction to sort (asc/desc)
9169
- * @type {string}
9170
- * @memberof TradesApiListTrades
9171
- */
9172
- readonly direction?: string;
9173
- /**
9174
- * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
9175
- * @type {string}
9176
- * @memberof TradesApiListTrades
9177
- */
9178
- readonly minTimestamp?: string;
9179
- /**
9180
- * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
9181
- * @type {string}
9182
- * @memberof TradesApiListTrades
9183
- */
9184
- readonly maxTimestamp?: string;
9185
- }
9186
8910
  /**
9187
8911
  * Request parameters for listTradesV3 operation in TradesApi.
9188
8912
  * @export
@@ -9244,13 +8968,13 @@ interface TradesApiListTradesV3Request {
9244
8968
  */
9245
8969
  readonly direction?: string;
9246
8970
  /**
9247
- * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
8971
+ * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-06-27T00:10:22Z\&#39;
9248
8972
  * @type {string}
9249
8973
  * @memberof TradesApiListTradesV3
9250
8974
  */
9251
8975
  readonly minTimestamp?: string;
9252
8976
  /**
9253
- * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
8977
+ * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-06-27T00:10:22Z\&#39;
9254
8978
  * @type {string}
9255
8979
  * @memberof TradesApiListTradesV3
9256
8980
  */
@@ -9264,17 +8988,7 @@ interface TradesApiListTradesV3Request {
9264
8988
  */
9265
8989
  declare class TradesApi extends BaseAPI {
9266
8990
  /**
9267
- * 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
9268
- * @summary Create a Trade between two parties
9269
- * @param {TradesApiCreateTradeRequest} requestParameters Request parameters.
9270
- * @param {*} [options] Override http request option.
9271
- * @deprecated
9272
- * @throws {RequiredError}
9273
- * @memberof TradesApi
9274
- */
9275
- createTrade(requestParameters: TradesApiCreateTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
9276
- /**
9277
- * Create a Trade. Currently only buy order is supported.
8991
+ * Create a Trade.
9278
8992
  * @summary Create a Trade (V3)
9279
8993
  * @param {TradesApiCreateTradeV3Request} requestParameters Request parameters.
9280
8994
  * @param {*} [options] Override http request option.
@@ -9294,22 +9008,12 @@ declare class TradesApi extends BaseAPI {
9294
9008
  /**
9295
9009
  * Get details of a trade with the given ID
9296
9010
  * @summary Get details of a trade with the given ID
9297
- * @param {TradesApiGetTradeRequest} requestParameters Request parameters.
9298
- * @param {*} [options] Override http request option.
9299
- * @throws {RequiredError}
9300
- * @memberof TradesApi
9301
- */
9302
- getTrade(requestParameters: TradesApiGetTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
9303
- /**
9304
- * 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
9305
- * @summary Get a list of trades
9306
- * @param {TradesApiListTradesRequest} requestParameters Request parameters.
9011
+ * @param {TradesApiGetTradeV3Request} requestParameters Request parameters.
9307
9012
  * @param {*} [options] Override http request option.
9308
- * @deprecated
9309
9013
  * @throws {RequiredError}
9310
9014
  * @memberof TradesApi
9311
9015
  */
9312
- listTrades(requestParameters?: TradesApiListTradesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTradesResponse, any>>;
9016
+ getTradeV3(requestParameters: TradesApiGetTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
9313
9017
  /**
9314
9018
  * Get a list of trades (V3)
9315
9019
  * @summary Get a list of trades (V3)
@@ -9390,10 +9094,10 @@ interface TransfersApiCreateTransferV1Request {
9390
9094
  interface TransfersApiGetSignableTransferRequest {
9391
9095
  /**
9392
9096
  * get details of signable transfer
9393
- * @type {GetSignableTransferRequest}
9097
+ * @type {GetSignableTransferRequestV2}
9394
9098
  * @memberof TransfersApiGetSignableTransfer
9395
9099
  */
9396
- readonly getSignableTransferRequestV2: GetSignableTransferRequest;
9100
+ readonly getSignableTransferRequestV2: GetSignableTransferRequestV2;
9397
9101
  }
9398
9102
  /**
9399
9103
  * Request parameters for getSignableTransferV1 operation in TransfersApi.
@@ -9403,10 +9107,10 @@ interface TransfersApiGetSignableTransferRequest {
9403
9107
  interface TransfersApiGetSignableTransferV1Request {
9404
9108
  /**
9405
9109
  * get details of signable transfer
9406
- * @type {GetSignableTransferRequestV1}
9110
+ * @type {GetSignableTransferRequest}
9407
9111
  * @memberof TransfersApiGetSignableTransferV1
9408
9112
  */
9409
- readonly getSignableTransferRequest: GetSignableTransferRequestV1;
9113
+ readonly getSignableTransferRequest: GetSignableTransferRequest;
9410
9114
  }
9411
9115
  /**
9412
9116
  * Request parameters for getTransfer operation in TransfersApi.
@@ -9441,10 +9145,10 @@ interface TransfersApiListTransfersRequest {
9441
9145
  readonly cursor?: string;
9442
9146
  /**
9443
9147
  * Property to sort by
9444
- * @type {'transaction_id' | 'updated_at' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key'}
9148
+ * @type {'transaction_id' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key'}
9445
9149
  * @memberof TransfersApiListTransfers
9446
9150
  */
9447
- readonly orderBy?: 'transaction_id' | 'updated_at' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key';
9151
+ readonly orderBy?: 'transaction_id' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key';
9448
9152
  /**
9449
9153
  * Direction to sort (asc/desc)
9450
9154
  * @type {string}
@@ -9545,7 +9249,7 @@ declare class TransfersApi extends BaseAPI {
9545
9249
  * @throws {RequiredError}
9546
9250
  * @memberof TransfersApi
9547
9251
  */
9548
- createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
9252
+ createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponseV2, any>>;
9549
9253
  /**
9550
9254
  * Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransferV1 to get request body params.
9551
9255
  * @summary Creates a transfer of tokens between two parties
@@ -9563,7 +9267,7 @@ declare class TransfersApi extends BaseAPI {
9563
9267
  * @throws {RequiredError}
9564
9268
  * @memberof TransfersApi
9565
9269
  */
9566
- getSignableTransfer(requestParameters: TransfersApiGetSignableTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTransferResponse, any>>;
9270
+ getSignableTransfer(requestParameters: TransfersApiGetSignableTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTransferResponseV2, any>>;
9567
9271
  /**
9568
9272
  * Gets details of a signable transfer
9569
9273
  * @summary Gets details of a signable transfer
@@ -9705,7 +9409,7 @@ declare class UsersApi extends BaseAPI {
9705
9409
  * @throws {RequiredError}
9706
9410
  * @memberof UsersApi
9707
9411
  */
9708
- registerPassportUser(requestParameters: UsersApiRegisterPassportUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<object, any>>;
9412
+ registerPassportUser(requestParameters: UsersApiRegisterPassportUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<RegisterPassportUserResult, any>>;
9709
9413
  /**
9710
9414
  * Registers a user
9711
9415
  * @summary Registers a user
@@ -9890,7 +9594,7 @@ interface WithdrawalsApiListWithdrawalsRequest {
9890
9594
  */
9891
9595
  declare class WithdrawalsApi extends BaseAPI {
9892
9596
  /**
9893
- * Creates a withdrawal.
9597
+ * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
9894
9598
  * @summary Creates a withdrawal of a token
9895
9599
  * @param {WithdrawalsApiCreateWithdrawalRequest} requestParameters Request parameters.
9896
9600
  * @param {*} [options] Override http request option.
@@ -10106,10 +9810,14 @@ declare enum Environment {
10106
9810
  }
10107
9811
  declare class ImmutableConfiguration {
10108
9812
  readonly environment: Environment;
9813
+ readonly rateLimitingKey?: string;
10109
9814
  readonly apiKey?: string;
9815
+ readonly clientAppId?: string;
10110
9816
  constructor(options: {
10111
9817
  environment: Environment;
9818
+ rateLimitingKey?: string;
10112
9819
  apiKey?: string;
9820
+ clientAppId?: string;
10113
9821
  });
10114
9822
  }
10115
9823
  interface ModuleConfiguration<T> {
@@ -10360,28 +10068,28 @@ declare class ImmutableXClient {
10360
10068
  * @returns a promise that resolves with the requested Order
10361
10069
  * @throws {@link index.IMXError}
10362
10070
  */
10363
- getOrder(request: OrdersApiGetOrderRequest): Promise<OrderV3>;
10071
+ getOrder(request: OrdersApiGetOrderV3Request): Promise<OrderV3>;
10364
10072
  /**
10365
10073
  * Get a list of Orders
10366
10074
  * @param request - optional object containing the parameters to be provided in the API request
10367
10075
  * @returns a promise that resolves with the requested list of Orders
10368
10076
  * @throws {@link index.IMXError}
10369
10077
  */
10370
- listOrders(request?: OrdersApiListOrdersRequest): Promise<ListOrdersResponseV3>;
10078
+ listOrders(request?: OrdersApiListOrdersV3Request): Promise<ListOrdersResponseV3>;
10371
10079
  /**
10372
10080
  * Get details of a Trade with the given ID
10373
10081
  * @param request - the request object containing the parameters to be provided in the API request
10374
10082
  * @returns a promise that resolves with the requested Trade
10375
10083
  * @throws {@link index.IMXError}
10376
10084
  */
10377
- getTrade(request: TradesApiGetTradeRequest): Promise<Trade>;
10085
+ getTrade(request: TradesApiGetTradeV3Request): Promise<Trade>;
10378
10086
  /**
10379
10087
  * Get a list of Trades
10380
10088
  * @param request - optional object containing the parameters to be provided in the API request
10381
10089
  * @returns a promise that resolves with the requested list of Trades
10382
10090
  * @throws {@link index.IMXError}
10383
10091
  */
10384
- listTrades(request?: TradesApiListTradesRequest): Promise<ListTradesResponse>;
10092
+ listTrades(request?: TradesApiListTradesV3Request): Promise<ListTradesResponse>;
10385
10093
  /**
10386
10094
  * Get details of a Token
10387
10095
  * @param request - the request object containing the parameters to be provided in the API request
@@ -10608,9 +10316,12 @@ declare class Passport {
10608
10316
  private readonly passportImxProviderFactory;
10609
10317
  private readonly passportEventEmitter;
10610
10318
  constructor(passportModuleConfiguration: PassportModuleConfiguration);
10319
+ /**
10320
+ * @deprecated The method `login` with an argument of `{ useCachedSession: true }` should be used in conjunction with
10321
+ * `connectImx` instead.
10322
+ */
10611
10323
  connectImxSilent(): Promise<IMXProvider | null>;
10612
10324
  connectImx(): Promise<IMXProvider>;
10613
- loginWithDeviceFlow(): Promise<DeviceConnectResponse>;
10614
10325
  connectImxDeviceFlow(deviceCode: string, interval: number, timeoutMs?: number): Promise<IMXProvider | null>;
10615
10326
  getPKCEAuthorizationUrl(): string;
10616
10327
  connectImxPKCEFlow(authorizationCode: string, state: string): Promise<IMXProvider | null>;
@@ -10620,6 +10331,18 @@ declare class Passport {
10620
10331
  checkStoredDeviceFlowCredentials(): DeviceTokenResponse | null;
10621
10332
  connectImxWithCredentials(tokenResponse: DeviceTokenResponse): Promise<IMXProvider | null>;
10622
10333
  connectEvm(): Provider;
10334
+ /**
10335
+ *
10336
+ * Initiates the authorisation flow.
10337
+ *
10338
+ * @param options.useCachedSession = false - If true, and no active session exists, then the user will not be
10339
+ * prompted to log in and the Promise will resolve with a null value.
10340
+ * @returns {Promise<UserProfile | null>} the user profile if the user is logged in, otherwise null
10341
+ */
10342
+ login(options?: {
10343
+ useCachedSession: boolean;
10344
+ }): Promise<UserProfile | null>;
10345
+ loginWithDeviceFlow(): Promise<DeviceConnectResponse>;
10623
10346
  loginCallback(): Promise<void>;
10624
10347
  logout(): Promise<void>;
10625
10348
  /**