@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.
- package/dist/blockchain_data.d.ts +4 -0
- package/dist/blockchain_data.js +1 -1
- package/dist/browser/checkout.js +2 -0
- package/dist/checkout_sdk.d.ts +7430 -8261
- package/dist/checkout_sdk.js +2725 -2994
- package/dist/checkout_widgets.d.ts +25583 -0
- package/dist/checkout_widgets.js +449 -0
- package/dist/config.d.ts +4 -0
- package/dist/config.js +22 -1
- package/dist/immutablex_client.d.ts +811 -1128
- package/dist/immutablex_client.js +5 -4
- package/dist/index.browser.js +51 -42
- package/dist/index.browser.js.map +1 -1
- package/dist/index.cjs +3320 -3082
- package/dist/index.d.ts +16311 -2137
- package/dist/index.js +3321 -3084
- package/dist/orderbook.d.ts +113 -65
- package/dist/orderbook.js +101 -20
- package/dist/passport.d.ts +859 -1136
- package/dist/passport.js +96 -48
- package/dist/provider.d.ts +4 -0
- package/dist/provider.js +3 -0
- package/package.json +7 -18
- package/dist/browser/checkout/sdk.js +0 -35
- package/dist/browser/checkout/widgets.js +0 -890
|
@@ -778,6 +778,25 @@ interface CollectionDetails {
|
|
|
778
778
|
'name': string;
|
|
779
779
|
}
|
|
780
780
|
|
|
781
|
+
/**
|
|
782
|
+
* Immutable X API
|
|
783
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
784
|
+
*
|
|
785
|
+
* The version of the OpenAPI document: 3.0
|
|
786
|
+
* Contact: support@immutable.com
|
|
787
|
+
*
|
|
788
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
789
|
+
* https://openapi-generator.tech
|
|
790
|
+
* Do not edit the class manually.
|
|
791
|
+
*/
|
|
792
|
+
|
|
793
|
+
/**
|
|
794
|
+
* @type AssetPropertiesCollection
|
|
795
|
+
* Details of this asset\'s collection
|
|
796
|
+
* @export
|
|
797
|
+
*/
|
|
798
|
+
declare type AssetPropertiesCollection = CollectionDetails;
|
|
799
|
+
|
|
781
800
|
/**
|
|
782
801
|
* Immutable X API
|
|
783
802
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -798,10 +817,10 @@ interface CollectionDetails {
|
|
|
798
817
|
interface AssetProperties {
|
|
799
818
|
/**
|
|
800
819
|
*
|
|
801
|
-
* @type {
|
|
820
|
+
* @type {AssetPropertiesCollection}
|
|
802
821
|
* @memberof AssetProperties
|
|
803
822
|
*/
|
|
804
|
-
'collection'?:
|
|
823
|
+
'collection'?: AssetPropertiesCollection;
|
|
805
824
|
/**
|
|
806
825
|
* Image URL of this asset
|
|
807
826
|
* @type {string}
|
|
@@ -985,6 +1004,25 @@ interface FeeData {
|
|
|
985
1004
|
'decimals'?: number;
|
|
986
1005
|
}
|
|
987
1006
|
|
|
1007
|
+
/**
|
|
1008
|
+
* Immutable X API
|
|
1009
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1010
|
+
*
|
|
1011
|
+
* The version of the OpenAPI document: 3.0
|
|
1012
|
+
* Contact: support@immutable.com
|
|
1013
|
+
*
|
|
1014
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1015
|
+
* https://openapi-generator.tech
|
|
1016
|
+
* Do not edit the class manually.
|
|
1017
|
+
*/
|
|
1018
|
+
|
|
1019
|
+
/**
|
|
1020
|
+
* @type FeeTokenData
|
|
1021
|
+
* Fee token data details
|
|
1022
|
+
* @export
|
|
1023
|
+
*/
|
|
1024
|
+
declare type FeeTokenData = FeeData;
|
|
1025
|
+
|
|
988
1026
|
/**
|
|
989
1027
|
* Immutable X API
|
|
990
1028
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -1005,10 +1043,10 @@ interface FeeData {
|
|
|
1005
1043
|
interface FeeToken {
|
|
1006
1044
|
/**
|
|
1007
1045
|
*
|
|
1008
|
-
* @type {
|
|
1046
|
+
* @type {FeeTokenData}
|
|
1009
1047
|
* @memberof FeeToken
|
|
1010
1048
|
*/
|
|
1011
|
-
'data'?:
|
|
1049
|
+
'data'?: FeeTokenData;
|
|
1012
1050
|
/**
|
|
1013
1051
|
* Fee token type. One of ETH/ERC20
|
|
1014
1052
|
* @type {string}
|
|
@@ -1142,29 +1180,48 @@ interface ApiRegisterPassportUserRequest {
|
|
|
1142
1180
|
/**
|
|
1143
1181
|
*
|
|
1144
1182
|
* @export
|
|
1145
|
-
* @interface
|
|
1183
|
+
* @interface ApiSDKVersionCheckResponse
|
|
1146
1184
|
*/
|
|
1147
|
-
interface
|
|
1185
|
+
interface ApiSDKVersionCheckResponse {
|
|
1148
1186
|
/**
|
|
1149
|
-
*
|
|
1187
|
+
*
|
|
1150
1188
|
* @type {string}
|
|
1151
|
-
* @memberof
|
|
1189
|
+
* @memberof ApiSDKVersionCheckResponse
|
|
1152
1190
|
*/
|
|
1153
|
-
'
|
|
1191
|
+
'message'?: string;
|
|
1154
1192
|
/**
|
|
1155
|
-
*
|
|
1156
|
-
* @type {
|
|
1157
|
-
* @memberof
|
|
1193
|
+
*
|
|
1194
|
+
* @type {boolean}
|
|
1195
|
+
* @memberof ApiSDKVersionCheckResponse
|
|
1158
1196
|
*/
|
|
1159
|
-
'
|
|
1197
|
+
'ok'?: boolean;
|
|
1160
1198
|
/**
|
|
1161
|
-
*
|
|
1199
|
+
*
|
|
1162
1200
|
* @type {string}
|
|
1163
|
-
* @memberof
|
|
1201
|
+
* @memberof ApiSDKVersionCheckResponse
|
|
1164
1202
|
*/
|
|
1165
|
-
'
|
|
1203
|
+
'runtimeId'?: string;
|
|
1166
1204
|
}
|
|
1167
1205
|
|
|
1206
|
+
/**
|
|
1207
|
+
* Immutable X API
|
|
1208
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1209
|
+
*
|
|
1210
|
+
* The version of the OpenAPI document: 3.0
|
|
1211
|
+
* Contact: support@immutable.com
|
|
1212
|
+
*
|
|
1213
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1214
|
+
* https://openapi-generator.tech
|
|
1215
|
+
* Do not edit the class manually.
|
|
1216
|
+
*/
|
|
1217
|
+
|
|
1218
|
+
/**
|
|
1219
|
+
* @type AssetCollection
|
|
1220
|
+
* Information about the collection to which this asset belongs
|
|
1221
|
+
* @export
|
|
1222
|
+
*/
|
|
1223
|
+
declare type AssetCollection = CollectionDetails;
|
|
1224
|
+
|
|
1168
1225
|
/**
|
|
1169
1226
|
* Immutable X API
|
|
1170
1227
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -1196,6 +1253,62 @@ interface OrderDetails {
|
|
|
1196
1253
|
'sell_orders'?: Array<object>;
|
|
1197
1254
|
}
|
|
1198
1255
|
|
|
1256
|
+
/**
|
|
1257
|
+
* Immutable X API
|
|
1258
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1259
|
+
*
|
|
1260
|
+
* The version of the OpenAPI document: 3.0
|
|
1261
|
+
* Contact: support@immutable.com
|
|
1262
|
+
*
|
|
1263
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1264
|
+
* https://openapi-generator.tech
|
|
1265
|
+
* Do not edit the class manually.
|
|
1266
|
+
*/
|
|
1267
|
+
|
|
1268
|
+
/**
|
|
1269
|
+
* @type AssetOrders
|
|
1270
|
+
* [DEPRECATED] Open orders for this asset will always return empty. Use GET /orders
|
|
1271
|
+
* @export
|
|
1272
|
+
*/
|
|
1273
|
+
declare type AssetOrders = OrderDetails;
|
|
1274
|
+
|
|
1275
|
+
/**
|
|
1276
|
+
* Immutable X API
|
|
1277
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1278
|
+
*
|
|
1279
|
+
* The version of the OpenAPI document: 3.0
|
|
1280
|
+
* Contact: support@immutable.com
|
|
1281
|
+
*
|
|
1282
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1283
|
+
* https://openapi-generator.tech
|
|
1284
|
+
* Do not edit the class manually.
|
|
1285
|
+
*/
|
|
1286
|
+
/**
|
|
1287
|
+
*
|
|
1288
|
+
* @export
|
|
1289
|
+
* @interface Fee
|
|
1290
|
+
*/
|
|
1291
|
+
interface Fee {
|
|
1292
|
+
/**
|
|
1293
|
+
* Wallet address
|
|
1294
|
+
* @type {string}
|
|
1295
|
+
* @memberof Fee
|
|
1296
|
+
*/
|
|
1297
|
+
'address': string;
|
|
1298
|
+
/**
|
|
1299
|
+
* The percentage of fee
|
|
1300
|
+
* @type {number}
|
|
1301
|
+
* @memberof Fee
|
|
1302
|
+
*/
|
|
1303
|
+
'percentage': number;
|
|
1304
|
+
/**
|
|
1305
|
+
* Type of fee. Examples: `royalty`, `maker`, `taker` or `protocol`
|
|
1306
|
+
* @type {string}
|
|
1307
|
+
* @memberof Fee
|
|
1308
|
+
*/
|
|
1309
|
+
'type': string;
|
|
1310
|
+
}
|
|
1311
|
+
|
|
1199
1312
|
/**
|
|
1200
1313
|
* Immutable X API
|
|
1201
1314
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -1216,10 +1329,10 @@ interface OrderDetails {
|
|
|
1216
1329
|
interface Asset {
|
|
1217
1330
|
/**
|
|
1218
1331
|
*
|
|
1219
|
-
* @type {
|
|
1332
|
+
* @type {AssetCollection}
|
|
1220
1333
|
* @memberof Asset
|
|
1221
1334
|
*/
|
|
1222
|
-
'collection':
|
|
1335
|
+
'collection': AssetCollection;
|
|
1223
1336
|
/**
|
|
1224
1337
|
* Timestamp of when the asset was created
|
|
1225
1338
|
* @type {string}
|
|
@@ -1264,10 +1377,10 @@ interface Asset {
|
|
|
1264
1377
|
'name': string | null;
|
|
1265
1378
|
/**
|
|
1266
1379
|
*
|
|
1267
|
-
* @type {
|
|
1380
|
+
* @type {AssetOrders}
|
|
1268
1381
|
* @memberof Asset
|
|
1269
1382
|
*/
|
|
1270
|
-
'orders'?:
|
|
1383
|
+
'orders'?: AssetOrders;
|
|
1271
1384
|
/**
|
|
1272
1385
|
* Status of this asset (where it is in the system)
|
|
1273
1386
|
* @type {string}
|
|
@@ -1306,6 +1419,44 @@ interface Asset {
|
|
|
1306
1419
|
'user': string;
|
|
1307
1420
|
}
|
|
1308
1421
|
|
|
1422
|
+
/**
|
|
1423
|
+
* Immutable X API
|
|
1424
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1425
|
+
*
|
|
1426
|
+
* The version of the OpenAPI document: 3.0
|
|
1427
|
+
* Contact: support@immutable.com
|
|
1428
|
+
*
|
|
1429
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1430
|
+
* https://openapi-generator.tech
|
|
1431
|
+
* Do not edit the class manually.
|
|
1432
|
+
*/
|
|
1433
|
+
|
|
1434
|
+
/**
|
|
1435
|
+
* @type AssetWithOrdersCollection
|
|
1436
|
+
* Information about the collection to which this asset belongs
|
|
1437
|
+
* @export
|
|
1438
|
+
*/
|
|
1439
|
+
declare type AssetWithOrdersCollection = CollectionDetails;
|
|
1440
|
+
|
|
1441
|
+
/**
|
|
1442
|
+
* Immutable X API
|
|
1443
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1444
|
+
*
|
|
1445
|
+
* The version of the OpenAPI document: 3.0
|
|
1446
|
+
* Contact: support@immutable.com
|
|
1447
|
+
*
|
|
1448
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1449
|
+
* https://openapi-generator.tech
|
|
1450
|
+
* Do not edit the class manually.
|
|
1451
|
+
*/
|
|
1452
|
+
|
|
1453
|
+
/**
|
|
1454
|
+
* @type AssetWithOrdersOrders
|
|
1455
|
+
* Open orders for this asset
|
|
1456
|
+
* @export
|
|
1457
|
+
*/
|
|
1458
|
+
declare type AssetWithOrdersOrders = OrderDetails;
|
|
1459
|
+
|
|
1309
1460
|
/**
|
|
1310
1461
|
* Immutable X API
|
|
1311
1462
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -1326,10 +1477,10 @@ interface Asset {
|
|
|
1326
1477
|
interface AssetWithOrders {
|
|
1327
1478
|
/**
|
|
1328
1479
|
*
|
|
1329
|
-
* @type {
|
|
1480
|
+
* @type {AssetWithOrdersCollection}
|
|
1330
1481
|
* @memberof AssetWithOrders
|
|
1331
1482
|
*/
|
|
1332
|
-
'collection':
|
|
1483
|
+
'collection': AssetWithOrdersCollection;
|
|
1333
1484
|
/**
|
|
1334
1485
|
* Timestamp of when the asset was created
|
|
1335
1486
|
* @type {string}
|
|
@@ -1374,10 +1525,10 @@ interface AssetWithOrders {
|
|
|
1374
1525
|
'name': string | null;
|
|
1375
1526
|
/**
|
|
1376
1527
|
*
|
|
1377
|
-
* @type {
|
|
1528
|
+
* @type {AssetWithOrdersOrders}
|
|
1378
1529
|
* @memberof AssetWithOrders
|
|
1379
1530
|
*/
|
|
1380
|
-
'orders'?:
|
|
1531
|
+
'orders'?: AssetWithOrdersOrders;
|
|
1381
1532
|
/**
|
|
1382
1533
|
* Status of this asset (where it is in the system)
|
|
1383
1534
|
* @type {string}
|
|
@@ -1637,6 +1788,25 @@ interface Range {
|
|
|
1637
1788
|
'min'?: number;
|
|
1638
1789
|
}
|
|
1639
1790
|
|
|
1791
|
+
/**
|
|
1792
|
+
* Immutable X API
|
|
1793
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1794
|
+
*
|
|
1795
|
+
* The version of the OpenAPI document: 3.0
|
|
1796
|
+
* Contact: support@immutable.com
|
|
1797
|
+
*
|
|
1798
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1799
|
+
* https://openapi-generator.tech
|
|
1800
|
+
* Do not edit the class manually.
|
|
1801
|
+
*/
|
|
1802
|
+
|
|
1803
|
+
/**
|
|
1804
|
+
* @type CollectionFilterRange
|
|
1805
|
+
* Range of values for this property
|
|
1806
|
+
* @export
|
|
1807
|
+
*/
|
|
1808
|
+
declare type CollectionFilterRange = Range;
|
|
1809
|
+
|
|
1640
1810
|
/**
|
|
1641
1811
|
* Immutable X API
|
|
1642
1812
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -1663,10 +1833,10 @@ interface CollectionFilter {
|
|
|
1663
1833
|
'key'?: string;
|
|
1664
1834
|
/**
|
|
1665
1835
|
*
|
|
1666
|
-
* @type {
|
|
1836
|
+
* @type {CollectionFilterRange}
|
|
1667
1837
|
* @memberof CollectionFilter
|
|
1668
1838
|
*/
|
|
1669
|
-
'range'?:
|
|
1839
|
+
'range'?: CollectionFilterRange;
|
|
1670
1840
|
/**
|
|
1671
1841
|
* Type of this filter
|
|
1672
1842
|
* @type {string}
|
|
@@ -1988,98 +2158,6 @@ interface FeeEntry {
|
|
|
1988
2158
|
'fee_percentage'?: number;
|
|
1989
2159
|
}
|
|
1990
2160
|
|
|
1991
|
-
/**
|
|
1992
|
-
* Immutable X API
|
|
1993
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1994
|
-
*
|
|
1995
|
-
* The version of the OpenAPI document: 3.0
|
|
1996
|
-
* Contact: support@immutable.com
|
|
1997
|
-
*
|
|
1998
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1999
|
-
* https://openapi-generator.tech
|
|
2000
|
-
* Do not edit the class manually.
|
|
2001
|
-
*/
|
|
2002
|
-
|
|
2003
|
-
/**
|
|
2004
|
-
*
|
|
2005
|
-
* @export
|
|
2006
|
-
* @interface CreateOrderRequest
|
|
2007
|
-
*/
|
|
2008
|
-
interface CreateOrderRequest {
|
|
2009
|
-
/**
|
|
2010
|
-
* Amount to buy
|
|
2011
|
-
* @type {string}
|
|
2012
|
-
* @memberof CreateOrderRequest
|
|
2013
|
-
*/
|
|
2014
|
-
'amount_buy': string;
|
|
2015
|
-
/**
|
|
2016
|
-
* Amount to sell
|
|
2017
|
-
* @type {string}
|
|
2018
|
-
* @memberof CreateOrderRequest
|
|
2019
|
-
*/
|
|
2020
|
-
'amount_sell': string;
|
|
2021
|
-
/**
|
|
2022
|
-
* ID of the asset to buy
|
|
2023
|
-
* @type {string}
|
|
2024
|
-
* @memberof CreateOrderRequest
|
|
2025
|
-
*/
|
|
2026
|
-
'asset_id_buy': string;
|
|
2027
|
-
/**
|
|
2028
|
-
* ID of the asset to sell
|
|
2029
|
-
* @type {string}
|
|
2030
|
-
* @memberof CreateOrderRequest
|
|
2031
|
-
*/
|
|
2032
|
-
'asset_id_sell': string;
|
|
2033
|
-
/**
|
|
2034
|
-
* Expiration timestamp for this order
|
|
2035
|
-
* @type {number}
|
|
2036
|
-
* @memberof CreateOrderRequest
|
|
2037
|
-
*/
|
|
2038
|
-
'expiration_timestamp': number;
|
|
2039
|
-
/**
|
|
2040
|
-
* Fee information
|
|
2041
|
-
* @type {Array<FeeEntry>}
|
|
2042
|
-
* @memberof CreateOrderRequest
|
|
2043
|
-
*/
|
|
2044
|
-
'fees'?: Array<FeeEntry>;
|
|
2045
|
-
/**
|
|
2046
|
-
* Whether to include fees in order
|
|
2047
|
-
* @type {boolean}
|
|
2048
|
-
* @memberof CreateOrderRequest
|
|
2049
|
-
*/
|
|
2050
|
-
'include_fees'?: boolean;
|
|
2051
|
-
/**
|
|
2052
|
-
* Nonce of the order
|
|
2053
|
-
* @type {number}
|
|
2054
|
-
* @memberof CreateOrderRequest
|
|
2055
|
-
*/
|
|
2056
|
-
'nonce': number;
|
|
2057
|
-
/**
|
|
2058
|
-
* Public stark key of the user creating order
|
|
2059
|
-
* @type {string}
|
|
2060
|
-
* @memberof CreateOrderRequest
|
|
2061
|
-
*/
|
|
2062
|
-
'stark_key': string;
|
|
2063
|
-
/**
|
|
2064
|
-
* Payload signature
|
|
2065
|
-
* @type {string}
|
|
2066
|
-
* @memberof CreateOrderRequest
|
|
2067
|
-
*/
|
|
2068
|
-
'stark_signature': string;
|
|
2069
|
-
/**
|
|
2070
|
-
* ID of the vault into which the bought asset will be placed
|
|
2071
|
-
* @type {number}
|
|
2072
|
-
* @memberof CreateOrderRequest
|
|
2073
|
-
*/
|
|
2074
|
-
'vault_id_buy': number;
|
|
2075
|
-
/**
|
|
2076
|
-
* ID of the vault to sell from
|
|
2077
|
-
* @type {number}
|
|
2078
|
-
* @memberof CreateOrderRequest
|
|
2079
|
-
*/
|
|
2080
|
-
'vault_id_sell': number;
|
|
2081
|
-
}
|
|
2082
|
-
|
|
2083
2161
|
/**
|
|
2084
2162
|
* Immutable X API
|
|
2085
2163
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -2270,11 +2348,11 @@ interface CreateProjectRequest {
|
|
|
2270
2348
|
*/
|
|
2271
2349
|
interface CreateProjectResponse {
|
|
2272
2350
|
/**
|
|
2273
|
-
* The project ID
|
|
2274
|
-
* @type {
|
|
2351
|
+
* The project group ID
|
|
2352
|
+
* @type {string}
|
|
2275
2353
|
* @memberof CreateProjectResponse
|
|
2276
2354
|
*/
|
|
2277
|
-
'id':
|
|
2355
|
+
'id': string;
|
|
2278
2356
|
}
|
|
2279
2357
|
|
|
2280
2358
|
/**
|
|
@@ -2325,133 +2403,10 @@ interface FeeInfo {
|
|
|
2325
2403
|
* https://openapi-generator.tech
|
|
2326
2404
|
* Do not edit the class manually.
|
|
2327
2405
|
*/
|
|
2328
|
-
|
|
2329
2406
|
/**
|
|
2330
|
-
*
|
|
2331
|
-
* Fee details
|
|
2407
|
+
*
|
|
2332
2408
|
* @export
|
|
2333
|
-
|
|
2334
|
-
declare type CreateTradeRequestV1FeeInfo = FeeInfo;
|
|
2335
|
-
|
|
2336
|
-
/**
|
|
2337
|
-
* Immutable X API
|
|
2338
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2339
|
-
*
|
|
2340
|
-
* The version of the OpenAPI document: 3.0
|
|
2341
|
-
* Contact: support@immutable.com
|
|
2342
|
-
*
|
|
2343
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2344
|
-
* https://openapi-generator.tech
|
|
2345
|
-
* Do not edit the class manually.
|
|
2346
|
-
*/
|
|
2347
|
-
|
|
2348
|
-
/**
|
|
2349
|
-
*
|
|
2350
|
-
* @export
|
|
2351
|
-
* @interface CreateTradeRequestV1
|
|
2352
|
-
*/
|
|
2353
|
-
interface CreateTradeRequestV1 {
|
|
2354
|
-
/**
|
|
2355
|
-
* Amount to buy
|
|
2356
|
-
* @type {string}
|
|
2357
|
-
* @memberof CreateTradeRequestV1
|
|
2358
|
-
*/
|
|
2359
|
-
'amount_buy': string;
|
|
2360
|
-
/**
|
|
2361
|
-
* Amount to sell
|
|
2362
|
-
* @type {string}
|
|
2363
|
-
* @memberof CreateTradeRequestV1
|
|
2364
|
-
*/
|
|
2365
|
-
'amount_sell': string;
|
|
2366
|
-
/**
|
|
2367
|
-
* ID of the asset to buy
|
|
2368
|
-
* @type {string}
|
|
2369
|
-
* @memberof CreateTradeRequestV1
|
|
2370
|
-
*/
|
|
2371
|
-
'asset_id_buy': string;
|
|
2372
|
-
/**
|
|
2373
|
-
* ID of the asset to sell
|
|
2374
|
-
* @type {string}
|
|
2375
|
-
* @memberof CreateTradeRequestV1
|
|
2376
|
-
*/
|
|
2377
|
-
'asset_id_sell': string;
|
|
2378
|
-
/**
|
|
2379
|
-
* Expiration timestamp for this trade
|
|
2380
|
-
* @type {number}
|
|
2381
|
-
* @memberof CreateTradeRequestV1
|
|
2382
|
-
*/
|
|
2383
|
-
'expiration_timestamp': number;
|
|
2384
|
-
/**
|
|
2385
|
-
*
|
|
2386
|
-
* @type {CreateTradeRequestV1FeeInfo}
|
|
2387
|
-
* @memberof CreateTradeRequestV1
|
|
2388
|
-
*/
|
|
2389
|
-
'fee_info'?: CreateTradeRequestV1FeeInfo;
|
|
2390
|
-
/**
|
|
2391
|
-
* Fee information
|
|
2392
|
-
* @type {Array<FeeEntry>}
|
|
2393
|
-
* @memberof CreateTradeRequestV1
|
|
2394
|
-
*/
|
|
2395
|
-
'fees'?: Array<FeeEntry>;
|
|
2396
|
-
/**
|
|
2397
|
-
* [deprecated] All orders include fees since the introduction of protocol fees
|
|
2398
|
-
* @type {boolean}
|
|
2399
|
-
* @memberof CreateTradeRequestV1
|
|
2400
|
-
*/
|
|
2401
|
-
'include_fees'?: boolean;
|
|
2402
|
-
/**
|
|
2403
|
-
* Nonce of the trade
|
|
2404
|
-
* @type {number}
|
|
2405
|
-
* @memberof CreateTradeRequestV1
|
|
2406
|
-
*/
|
|
2407
|
-
'nonce': number;
|
|
2408
|
-
/**
|
|
2409
|
-
* ID of the order
|
|
2410
|
-
* @type {number}
|
|
2411
|
-
* @memberof CreateTradeRequestV1
|
|
2412
|
-
*/
|
|
2413
|
-
'order_id': number;
|
|
2414
|
-
/**
|
|
2415
|
-
* Public stark key of the user creating trade
|
|
2416
|
-
* @type {string}
|
|
2417
|
-
* @memberof CreateTradeRequestV1
|
|
2418
|
-
*/
|
|
2419
|
-
'stark_key': string;
|
|
2420
|
-
/**
|
|
2421
|
-
* Payload signature
|
|
2422
|
-
* @type {string}
|
|
2423
|
-
* @memberof CreateTradeRequestV1
|
|
2424
|
-
*/
|
|
2425
|
-
'stark_signature': string;
|
|
2426
|
-
/**
|
|
2427
|
-
* ID of the vault into which the traded asset will be placed
|
|
2428
|
-
* @type {number}
|
|
2429
|
-
* @memberof CreateTradeRequestV1
|
|
2430
|
-
*/
|
|
2431
|
-
'vault_id_buy': number;
|
|
2432
|
-
/**
|
|
2433
|
-
* ID of the vault to sell from
|
|
2434
|
-
* @type {number}
|
|
2435
|
-
* @memberof CreateTradeRequestV1
|
|
2436
|
-
*/
|
|
2437
|
-
'vault_id_sell': number;
|
|
2438
|
-
}
|
|
2439
|
-
|
|
2440
|
-
/**
|
|
2441
|
-
* Immutable X API
|
|
2442
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2443
|
-
*
|
|
2444
|
-
* The version of the OpenAPI document: 3.0
|
|
2445
|
-
* Contact: support@immutable.com
|
|
2446
|
-
*
|
|
2447
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2448
|
-
* https://openapi-generator.tech
|
|
2449
|
-
* Do not edit the class manually.
|
|
2450
|
-
*/
|
|
2451
|
-
/**
|
|
2452
|
-
*
|
|
2453
|
-
* @export
|
|
2454
|
-
* @interface CreateTradeResponse
|
|
2409
|
+
* @interface CreateTradeResponse
|
|
2455
2410
|
*/
|
|
2456
2411
|
interface CreateTradeResponse {
|
|
2457
2412
|
/**
|
|
@@ -2646,31 +2601,6 @@ interface CreateTransferRequestV1 {
|
|
|
2646
2601
|
'stark_signature': string;
|
|
2647
2602
|
}
|
|
2648
2603
|
|
|
2649
|
-
/**
|
|
2650
|
-
* Immutable X API
|
|
2651
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2652
|
-
*
|
|
2653
|
-
* The version of the OpenAPI document: 3.0
|
|
2654
|
-
* Contact: support@immutable.com
|
|
2655
|
-
*
|
|
2656
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2657
|
-
* https://openapi-generator.tech
|
|
2658
|
-
* Do not edit the class manually.
|
|
2659
|
-
*/
|
|
2660
|
-
/**
|
|
2661
|
-
*
|
|
2662
|
-
* @export
|
|
2663
|
-
* @interface CreateTransferResponse
|
|
2664
|
-
*/
|
|
2665
|
-
interface CreateTransferResponse {
|
|
2666
|
-
/**
|
|
2667
|
-
* List of transfer IDs
|
|
2668
|
-
* @type {Array<number>}
|
|
2669
|
-
* @memberof CreateTransferResponse
|
|
2670
|
-
*/
|
|
2671
|
-
'transfer_ids': Array<number>;
|
|
2672
|
-
}
|
|
2673
|
-
|
|
2674
2604
|
/**
|
|
2675
2605
|
* Immutable X API
|
|
2676
2606
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -2714,6 +2644,31 @@ interface CreateTransferResponseV1 {
|
|
|
2714
2644
|
'transfer_id': number;
|
|
2715
2645
|
}
|
|
2716
2646
|
|
|
2647
|
+
/**
|
|
2648
|
+
* Immutable X API
|
|
2649
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2650
|
+
*
|
|
2651
|
+
* The version of the OpenAPI document: 3.0
|
|
2652
|
+
* Contact: support@immutable.com
|
|
2653
|
+
*
|
|
2654
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2655
|
+
* https://openapi-generator.tech
|
|
2656
|
+
* Do not edit the class manually.
|
|
2657
|
+
*/
|
|
2658
|
+
/**
|
|
2659
|
+
*
|
|
2660
|
+
* @export
|
|
2661
|
+
* @interface CreateTransferResponseV2
|
|
2662
|
+
*/
|
|
2663
|
+
interface CreateTransferResponseV2 {
|
|
2664
|
+
/**
|
|
2665
|
+
* List of transfer IDs
|
|
2666
|
+
* @type {Array<number>}
|
|
2667
|
+
* @memberof CreateTransferResponseV2
|
|
2668
|
+
*/
|
|
2669
|
+
'transfer_ids': Array<number>;
|
|
2670
|
+
}
|
|
2671
|
+
|
|
2717
2672
|
/**
|
|
2718
2673
|
* Immutable X API
|
|
2719
2674
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -2850,6 +2805,25 @@ interface CurrencyWithLimits {
|
|
|
2850
2805
|
'symbol'?: string;
|
|
2851
2806
|
}
|
|
2852
2807
|
|
|
2808
|
+
/**
|
|
2809
|
+
* Immutable X API
|
|
2810
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2811
|
+
*
|
|
2812
|
+
* The version of the OpenAPI document: 3.0
|
|
2813
|
+
* Contact: support@immutable.com
|
|
2814
|
+
*
|
|
2815
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2816
|
+
* https://openapi-generator.tech
|
|
2817
|
+
* Do not edit the class manually.
|
|
2818
|
+
*/
|
|
2819
|
+
|
|
2820
|
+
/**
|
|
2821
|
+
* @type DepositToken
|
|
2822
|
+
* Details of the asset being deposited
|
|
2823
|
+
* @export
|
|
2824
|
+
*/
|
|
2825
|
+
declare type DepositToken = Token;
|
|
2826
|
+
|
|
2853
2827
|
/**
|
|
2854
2828
|
* Immutable X API
|
|
2855
2829
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -2882,10 +2856,10 @@ interface Deposit {
|
|
|
2882
2856
|
'timestamp': string;
|
|
2883
2857
|
/**
|
|
2884
2858
|
*
|
|
2885
|
-
* @type {
|
|
2859
|
+
* @type {DepositToken}
|
|
2886
2860
|
* @memberof Deposit
|
|
2887
2861
|
*/
|
|
2888
|
-
'token':
|
|
2862
|
+
'token': DepositToken;
|
|
2889
2863
|
/**
|
|
2890
2864
|
* Sequential ID of this transaction within Immutable X
|
|
2891
2865
|
* @type {number}
|
|
@@ -3393,65 +3367,29 @@ interface GetMetadataRefreshes {
|
|
|
3393
3367
|
*/
|
|
3394
3368
|
interface Project {
|
|
3395
3369
|
/**
|
|
3396
|
-
* The
|
|
3397
|
-
* @type {string}
|
|
3398
|
-
* @memberof Project
|
|
3399
|
-
*/
|
|
3400
|
-
'collection_limit_expires_at': string;
|
|
3401
|
-
/**
|
|
3402
|
-
* The total monthly collection limit
|
|
3403
|
-
* @type {number}
|
|
3404
|
-
* @memberof Project
|
|
3405
|
-
*/
|
|
3406
|
-
'collection_monthly_limit': number;
|
|
3407
|
-
/**
|
|
3408
|
-
* The number of collection remaining in the current period
|
|
3409
|
-
* @type {number}
|
|
3410
|
-
* @memberof Project
|
|
3411
|
-
*/
|
|
3412
|
-
'collection_remaining': number;
|
|
3413
|
-
/**
|
|
3414
|
-
* The company name
|
|
3370
|
+
* The project ChainType
|
|
3415
3371
|
* @type {string}
|
|
3416
3372
|
* @memberof Project
|
|
3417
3373
|
*/
|
|
3418
|
-
'
|
|
3374
|
+
'chain_type'?: string;
|
|
3419
3375
|
/**
|
|
3420
|
-
* The project
|
|
3376
|
+
* The project group ID
|
|
3421
3377
|
* @type {string}
|
|
3422
3378
|
* @memberof Project
|
|
3423
3379
|
*/
|
|
3424
|
-
'
|
|
3425
|
-
/**
|
|
3426
|
-
* The project ID
|
|
3427
|
-
* @type {number}
|
|
3428
|
-
* @memberof Project
|
|
3429
|
-
*/
|
|
3430
|
-
'id': number;
|
|
3380
|
+
'id': string;
|
|
3431
3381
|
/**
|
|
3432
|
-
* The
|
|
3382
|
+
* The project group name
|
|
3433
3383
|
* @type {string}
|
|
3434
3384
|
* @memberof Project
|
|
3435
3385
|
*/
|
|
3436
|
-
'
|
|
3437
|
-
/**
|
|
3438
|
-
* The total monthly mint operation limit
|
|
3439
|
-
* @type {number}
|
|
3440
|
-
* @memberof Project
|
|
3441
|
-
*/
|
|
3442
|
-
'mint_monthly_limit': number;
|
|
3443
|
-
/**
|
|
3444
|
-
* The number of mint operation remaining in the current period
|
|
3445
|
-
* @type {number}
|
|
3446
|
-
* @memberof Project
|
|
3447
|
-
*/
|
|
3448
|
-
'mint_remaining': number;
|
|
3386
|
+
'name': string;
|
|
3449
3387
|
/**
|
|
3450
|
-
* The project
|
|
3388
|
+
* The organisation ID that the project belongs to
|
|
3451
3389
|
* @type {string}
|
|
3452
3390
|
* @memberof Project
|
|
3453
3391
|
*/
|
|
3454
|
-
'
|
|
3392
|
+
'org_id'?: string;
|
|
3455
3393
|
}
|
|
3456
3394
|
|
|
3457
3395
|
/**
|
|
@@ -3546,12 +3484,24 @@ interface GetSignableCancelOrderResponse {
|
|
|
3546
3484
|
* @memberof GetSignableCancelOrderResponse
|
|
3547
3485
|
*/
|
|
3548
3486
|
'payload_hash': string;
|
|
3487
|
+
/**
|
|
3488
|
+
* EIP-712 encoding of the StarkEx cancel order request to be displayed to the user
|
|
3489
|
+
* @type {string}
|
|
3490
|
+
* @memberof GetSignableCancelOrderResponse
|
|
3491
|
+
*/
|
|
3492
|
+
'readable_transaction': string;
|
|
3549
3493
|
/**
|
|
3550
3494
|
* Message to sign from wallet to confirm cancel order
|
|
3551
3495
|
* @type {string}
|
|
3552
3496
|
* @memberof GetSignableCancelOrderResponse
|
|
3553
3497
|
*/
|
|
3554
3498
|
'signable_message': string;
|
|
3499
|
+
/**
|
|
3500
|
+
* IMX signed readable_transaction and payload_hash
|
|
3501
|
+
* @type {string}
|
|
3502
|
+
* @memberof GetSignableCancelOrderResponse
|
|
3503
|
+
*/
|
|
3504
|
+
'verification_signature': string;
|
|
3555
3505
|
}
|
|
3556
3506
|
|
|
3557
3507
|
/**
|
|
@@ -3585,6 +3535,25 @@ interface SignableToken {
|
|
|
3585
3535
|
'type'?: string;
|
|
3586
3536
|
}
|
|
3587
3537
|
|
|
3538
|
+
/**
|
|
3539
|
+
* Immutable X API
|
|
3540
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3541
|
+
*
|
|
3542
|
+
* The version of the OpenAPI document: 3.0
|
|
3543
|
+
* Contact: support@immutable.com
|
|
3544
|
+
*
|
|
3545
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3546
|
+
* https://openapi-generator.tech
|
|
3547
|
+
* Do not edit the class manually.
|
|
3548
|
+
*/
|
|
3549
|
+
|
|
3550
|
+
/**
|
|
3551
|
+
* @type GetSignableDepositRequestToken
|
|
3552
|
+
* Details of the token the user is depositing
|
|
3553
|
+
* @export
|
|
3554
|
+
*/
|
|
3555
|
+
declare type GetSignableDepositRequestToken = SignableToken;
|
|
3556
|
+
|
|
3588
3557
|
/**
|
|
3589
3558
|
* Immutable X API
|
|
3590
3559
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -3611,10 +3580,10 @@ interface GetSignableDepositRequest {
|
|
|
3611
3580
|
'amount': string;
|
|
3612
3581
|
/**
|
|
3613
3582
|
*
|
|
3614
|
-
* @type {
|
|
3583
|
+
* @type {GetSignableDepositRequestToken}
|
|
3615
3584
|
* @memberof GetSignableDepositRequest
|
|
3616
3585
|
*/
|
|
3617
|
-
'token':
|
|
3586
|
+
'token': GetSignableDepositRequestToken;
|
|
3618
3587
|
/**
|
|
3619
3588
|
* User who is depositing
|
|
3620
3589
|
* @type {string}
|
|
@@ -3753,7 +3722,7 @@ interface GetSignableOrderRequestV3 {
|
|
|
3753
3722
|
*/
|
|
3754
3723
|
'fees'?: Array<FeeEntry>;
|
|
3755
3724
|
/**
|
|
3756
|
-
* SplitFees
|
|
3725
|
+
* SplitFees is a deprecated field. It\'s value is ignored.
|
|
3757
3726
|
* @type {boolean}
|
|
3758
3727
|
* @memberof GetSignableOrderRequestV3
|
|
3759
3728
|
*/
|
|
@@ -3863,6 +3832,12 @@ interface GetSignableOrderResponse {
|
|
|
3863
3832
|
* @memberof GetSignableOrderResponse
|
|
3864
3833
|
*/
|
|
3865
3834
|
'payload_hash': string;
|
|
3835
|
+
/**
|
|
3836
|
+
* EIP-712 encoding of the StarkEx order transaction to be displayed to the user
|
|
3837
|
+
* @type {string}
|
|
3838
|
+
* @memberof GetSignableOrderResponse
|
|
3839
|
+
*/
|
|
3840
|
+
'readable_transaction': string;
|
|
3866
3841
|
/**
|
|
3867
3842
|
* Message to sign with L1 wallet to confirm order request
|
|
3868
3843
|
* @type {string}
|
|
@@ -3887,6 +3862,12 @@ interface GetSignableOrderResponse {
|
|
|
3887
3862
|
* @memberof GetSignableOrderResponse
|
|
3888
3863
|
*/
|
|
3889
3864
|
'vault_id_sell': number;
|
|
3865
|
+
/**
|
|
3866
|
+
* IMX signed readable_transaction and payload_hash
|
|
3867
|
+
* @type {string}
|
|
3868
|
+
* @memberof GetSignableOrderResponse
|
|
3869
|
+
*/
|
|
3870
|
+
'verification_signature': string;
|
|
3890
3871
|
}
|
|
3891
3872
|
|
|
3892
3873
|
/**
|
|
@@ -3912,12 +3893,24 @@ interface GetSignableRegistrationOffchainResponse {
|
|
|
3912
3893
|
* @memberof GetSignableRegistrationOffchainResponse
|
|
3913
3894
|
*/
|
|
3914
3895
|
'payload_hash': string;
|
|
3896
|
+
/**
|
|
3897
|
+
* EIP-712 encoding of the StarkEx Register User Offchain request to be displayed to the user
|
|
3898
|
+
* @type {string}
|
|
3899
|
+
* @memberof GetSignableRegistrationOffchainResponse
|
|
3900
|
+
*/
|
|
3901
|
+
'readable_transaction': string;
|
|
3915
3902
|
/**
|
|
3916
3903
|
* Message to sign with L1 wallet to register user offchain
|
|
3917
3904
|
* @type {string}
|
|
3918
3905
|
* @memberof GetSignableRegistrationOffchainResponse
|
|
3919
3906
|
*/
|
|
3920
3907
|
'signable_message': string;
|
|
3908
|
+
/**
|
|
3909
|
+
* IMX signed readable_transaction and payload_hash
|
|
3910
|
+
* @type {string}
|
|
3911
|
+
* @memberof GetSignableRegistrationOffchainResponse
|
|
3912
|
+
*/
|
|
3913
|
+
'verification_signature': string;
|
|
3921
3914
|
}
|
|
3922
3915
|
|
|
3923
3916
|
/**
|
|
@@ -3980,6 +3973,18 @@ interface GetSignableRegistrationResponse {
|
|
|
3980
3973
|
* @memberof GetSignableRegistrationResponse
|
|
3981
3974
|
*/
|
|
3982
3975
|
'payload_hash': string;
|
|
3976
|
+
/**
|
|
3977
|
+
* EIP-712 encoding of the StarkEx Register User request to be displayed to the user
|
|
3978
|
+
* @type {string}
|
|
3979
|
+
* @memberof GetSignableRegistrationResponse
|
|
3980
|
+
*/
|
|
3981
|
+
'readable_transaction': string;
|
|
3982
|
+
/**
|
|
3983
|
+
* IMX signed readable_transaction and payload_hash
|
|
3984
|
+
* @type {string}
|
|
3985
|
+
* @memberof GetSignableRegistrationResponse
|
|
3986
|
+
*/
|
|
3987
|
+
'verification_signature': string;
|
|
3983
3988
|
}
|
|
3984
3989
|
|
|
3985
3990
|
/**
|
|
@@ -4111,6 +4116,12 @@ interface GetSignableTradeResponse {
|
|
|
4111
4116
|
* @memberof GetSignableTradeResponse
|
|
4112
4117
|
*/
|
|
4113
4118
|
'payload_hash': string;
|
|
4119
|
+
/**
|
|
4120
|
+
* EIP-712 encoding of the StarkEx trade transaction to be displayed to the user
|
|
4121
|
+
* @type {string}
|
|
4122
|
+
* @memberof GetSignableTradeResponse
|
|
4123
|
+
*/
|
|
4124
|
+
'readable_transaction': string;
|
|
4114
4125
|
/**
|
|
4115
4126
|
* Message to sign with L1 wallet to confirm trade request
|
|
4116
4127
|
* @type {string}
|
|
@@ -4135,6 +4146,12 @@ interface GetSignableTradeResponse {
|
|
|
4135
4146
|
* @memberof GetSignableTradeResponse
|
|
4136
4147
|
*/
|
|
4137
4148
|
'vault_id_sell': number;
|
|
4149
|
+
/**
|
|
4150
|
+
* IMX signed readable_transaction and payload_hash
|
|
4151
|
+
* @type {string}
|
|
4152
|
+
* @memberof GetSignableTradeResponse
|
|
4153
|
+
*/
|
|
4154
|
+
'verification_signature': string;
|
|
4138
4155
|
}
|
|
4139
4156
|
|
|
4140
4157
|
/**
|
|
@@ -4150,30 +4167,11 @@ interface GetSignableTradeResponse {
|
|
|
4150
4167
|
*/
|
|
4151
4168
|
|
|
4152
4169
|
/**
|
|
4153
|
-
*
|
|
4170
|
+
* @type GetSignableTransferRequestToken
|
|
4171
|
+
* Token to transfer
|
|
4154
4172
|
* @export
|
|
4155
|
-
* @interface SignableTransferDetails
|
|
4156
4173
|
*/
|
|
4157
|
-
|
|
4158
|
-
/**
|
|
4159
|
-
* Amount of the token to transfer
|
|
4160
|
-
* @type {string}
|
|
4161
|
-
* @memberof SignableTransferDetails
|
|
4162
|
-
*/
|
|
4163
|
-
'amount': string;
|
|
4164
|
-
/**
|
|
4165
|
-
* Ethereum address of the receiving user
|
|
4166
|
-
* @type {string}
|
|
4167
|
-
* @memberof SignableTransferDetails
|
|
4168
|
-
*/
|
|
4169
|
-
'receiver': string;
|
|
4170
|
-
/**
|
|
4171
|
-
*
|
|
4172
|
-
* @type {SignableToken}
|
|
4173
|
-
* @memberof SignableTransferDetails
|
|
4174
|
-
*/
|
|
4175
|
-
'token': SignableToken;
|
|
4176
|
-
}
|
|
4174
|
+
declare type GetSignableTransferRequestToken = SignableToken;
|
|
4177
4175
|
|
|
4178
4176
|
/**
|
|
4179
4177
|
* Immutable X API
|
|
@@ -4193,18 +4191,30 @@ interface SignableTransferDetails {
|
|
|
4193
4191
|
* @interface GetSignableTransferRequest
|
|
4194
4192
|
*/
|
|
4195
4193
|
interface GetSignableTransferRequest {
|
|
4194
|
+
/**
|
|
4195
|
+
* Amount of the token to transfer
|
|
4196
|
+
* @type {string}
|
|
4197
|
+
* @memberof GetSignableTransferRequest
|
|
4198
|
+
*/
|
|
4199
|
+
'amount': string;
|
|
4200
|
+
/**
|
|
4201
|
+
* Ethereum address of the receiving user
|
|
4202
|
+
* @type {string}
|
|
4203
|
+
* @memberof GetSignableTransferRequest
|
|
4204
|
+
*/
|
|
4205
|
+
'receiver': string;
|
|
4196
4206
|
/**
|
|
4197
4207
|
* Ethereum address of the transferring user
|
|
4198
4208
|
* @type {string}
|
|
4199
4209
|
* @memberof GetSignableTransferRequest
|
|
4200
4210
|
*/
|
|
4201
|
-
'
|
|
4211
|
+
'sender': string;
|
|
4202
4212
|
/**
|
|
4203
|
-
*
|
|
4204
|
-
* @type {
|
|
4213
|
+
*
|
|
4214
|
+
* @type {GetSignableTransferRequestToken}
|
|
4205
4215
|
* @memberof GetSignableTransferRequest
|
|
4206
4216
|
*/
|
|
4207
|
-
'
|
|
4217
|
+
'token': GetSignableTransferRequestToken;
|
|
4208
4218
|
}
|
|
4209
4219
|
|
|
4210
4220
|
/**
|
|
@@ -4251,6 +4261,114 @@ interface GetSignableTransferRequestV1 {
|
|
|
4251
4261
|
'token': SignableToken;
|
|
4252
4262
|
}
|
|
4253
4263
|
|
|
4264
|
+
/**
|
|
4265
|
+
* Immutable X API
|
|
4266
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4267
|
+
*
|
|
4268
|
+
* The version of the OpenAPI document: 3.0
|
|
4269
|
+
* Contact: support@immutable.com
|
|
4270
|
+
*
|
|
4271
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4272
|
+
* https://openapi-generator.tech
|
|
4273
|
+
* Do not edit the class manually.
|
|
4274
|
+
*/
|
|
4275
|
+
|
|
4276
|
+
/**
|
|
4277
|
+
* @type SignableTransferDetailsV2Token
|
|
4278
|
+
* Token to transfer
|
|
4279
|
+
* @export
|
|
4280
|
+
*/
|
|
4281
|
+
declare type SignableTransferDetailsV2Token = SignableToken;
|
|
4282
|
+
|
|
4283
|
+
/**
|
|
4284
|
+
* Immutable X API
|
|
4285
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4286
|
+
*
|
|
4287
|
+
* The version of the OpenAPI document: 3.0
|
|
4288
|
+
* Contact: support@immutable.com
|
|
4289
|
+
*
|
|
4290
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4291
|
+
* https://openapi-generator.tech
|
|
4292
|
+
* Do not edit the class manually.
|
|
4293
|
+
*/
|
|
4294
|
+
|
|
4295
|
+
/**
|
|
4296
|
+
*
|
|
4297
|
+
* @export
|
|
4298
|
+
* @interface SignableTransferDetailsV2
|
|
4299
|
+
*/
|
|
4300
|
+
interface SignableTransferDetailsV2 {
|
|
4301
|
+
/**
|
|
4302
|
+
* Amount of the token to transfer
|
|
4303
|
+
* @type {string}
|
|
4304
|
+
* @memberof SignableTransferDetailsV2
|
|
4305
|
+
*/
|
|
4306
|
+
'amount': string;
|
|
4307
|
+
/**
|
|
4308
|
+
* Ethereum address of the receiving user
|
|
4309
|
+
* @type {string}
|
|
4310
|
+
* @memberof SignableTransferDetailsV2
|
|
4311
|
+
*/
|
|
4312
|
+
'receiver': string;
|
|
4313
|
+
/**
|
|
4314
|
+
*
|
|
4315
|
+
* @type {SignableTransferDetailsV2Token}
|
|
4316
|
+
* @memberof SignableTransferDetailsV2
|
|
4317
|
+
*/
|
|
4318
|
+
'token': SignableTransferDetailsV2Token;
|
|
4319
|
+
}
|
|
4320
|
+
|
|
4321
|
+
/**
|
|
4322
|
+
* Immutable X API
|
|
4323
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4324
|
+
*
|
|
4325
|
+
* The version of the OpenAPI document: 3.0
|
|
4326
|
+
* Contact: support@immutable.com
|
|
4327
|
+
*
|
|
4328
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4329
|
+
* https://openapi-generator.tech
|
|
4330
|
+
* Do not edit the class manually.
|
|
4331
|
+
*/
|
|
4332
|
+
|
|
4333
|
+
/**
|
|
4334
|
+
*
|
|
4335
|
+
* @export
|
|
4336
|
+
* @interface GetSignableTransferRequestV2
|
|
4337
|
+
*/
|
|
4338
|
+
interface GetSignableTransferRequestV2 {
|
|
4339
|
+
/**
|
|
4340
|
+
* Ethereum address of the transferring user
|
|
4341
|
+
* @type {string}
|
|
4342
|
+
* @memberof GetSignableTransferRequestV2
|
|
4343
|
+
*/
|
|
4344
|
+
'sender_ether_key': string;
|
|
4345
|
+
/**
|
|
4346
|
+
* List of signable transfer details
|
|
4347
|
+
* @type {Array<SignableTransferDetailsV2>}
|
|
4348
|
+
* @memberof GetSignableTransferRequestV2
|
|
4349
|
+
*/
|
|
4350
|
+
'signable_requests': Array<SignableTransferDetailsV2>;
|
|
4351
|
+
}
|
|
4352
|
+
|
|
4353
|
+
/**
|
|
4354
|
+
* Immutable X API
|
|
4355
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4356
|
+
*
|
|
4357
|
+
* The version of the OpenAPI document: 3.0
|
|
4358
|
+
* Contact: support@immutable.com
|
|
4359
|
+
*
|
|
4360
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4361
|
+
* https://openapi-generator.tech
|
|
4362
|
+
* Do not edit the class manually.
|
|
4363
|
+
*/
|
|
4364
|
+
|
|
4365
|
+
/**
|
|
4366
|
+
* @type SignableTransferResponseDetailsToken
|
|
4367
|
+
* Token in request to match in SDK implementation
|
|
4368
|
+
* @export
|
|
4369
|
+
*/
|
|
4370
|
+
declare type SignableTransferResponseDetailsToken = SignableToken;
|
|
4371
|
+
|
|
4254
4372
|
/**
|
|
4255
4373
|
* Immutable X API
|
|
4256
4374
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -4299,6 +4417,12 @@ interface SignableTransferResponseDetails {
|
|
|
4299
4417
|
* @memberof SignableTransferResponseDetails
|
|
4300
4418
|
*/
|
|
4301
4419
|
'payload_hash': string;
|
|
4420
|
+
/**
|
|
4421
|
+
* EIP-712 encoding of the StarkEx transfer request to be displayed to the user
|
|
4422
|
+
* @type {string}
|
|
4423
|
+
* @memberof SignableTransferResponseDetails
|
|
4424
|
+
*/
|
|
4425
|
+
'readable_transaction': string;
|
|
4302
4426
|
/**
|
|
4303
4427
|
* Receiver of the transfer
|
|
4304
4428
|
* @type {string}
|
|
@@ -4319,48 +4443,16 @@ interface SignableTransferResponseDetails {
|
|
|
4319
4443
|
'sender_vault_id': number;
|
|
4320
4444
|
/**
|
|
4321
4445
|
*
|
|
4322
|
-
* @type {
|
|
4446
|
+
* @type {SignableTransferResponseDetailsToken}
|
|
4323
4447
|
* @memberof SignableTransferResponseDetails
|
|
4324
4448
|
*/
|
|
4325
|
-
'token':
|
|
4326
|
-
}
|
|
4327
|
-
|
|
4328
|
-
/**
|
|
4329
|
-
* Immutable X API
|
|
4330
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4331
|
-
*
|
|
4332
|
-
* The version of the OpenAPI document: 3.0
|
|
4333
|
-
* Contact: support@immutable.com
|
|
4334
|
-
*
|
|
4335
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4336
|
-
* https://openapi-generator.tech
|
|
4337
|
-
* Do not edit the class manually.
|
|
4338
|
-
*/
|
|
4339
|
-
|
|
4340
|
-
/**
|
|
4341
|
-
*
|
|
4342
|
-
* @export
|
|
4343
|
-
* @interface GetSignableTransferResponse
|
|
4344
|
-
*/
|
|
4345
|
-
interface GetSignableTransferResponse {
|
|
4346
|
-
/**
|
|
4347
|
-
* Sender of the transfer
|
|
4348
|
-
* @type {string}
|
|
4349
|
-
* @memberof GetSignableTransferResponse
|
|
4350
|
-
*/
|
|
4351
|
-
'sender_stark_key': string;
|
|
4449
|
+
'token': SignableTransferResponseDetailsToken;
|
|
4352
4450
|
/**
|
|
4353
|
-
*
|
|
4451
|
+
* IMX signed readable_transaction and payload_hash
|
|
4354
4452
|
* @type {string}
|
|
4355
|
-
* @memberof
|
|
4356
|
-
*/
|
|
4357
|
-
'signable_message': string;
|
|
4358
|
-
/**
|
|
4359
|
-
* List of transfer responses without the sender stark key
|
|
4360
|
-
* @type {Array<SignableTransferResponseDetails>}
|
|
4361
|
-
* @memberof GetSignableTransferResponse
|
|
4453
|
+
* @memberof SignableTransferResponseDetails
|
|
4362
4454
|
*/
|
|
4363
|
-
'
|
|
4455
|
+
'verification_signature': string;
|
|
4364
4456
|
}
|
|
4365
4457
|
|
|
4366
4458
|
/**
|
|
@@ -4410,6 +4502,12 @@ interface GetSignableTransferResponseV1 {
|
|
|
4410
4502
|
* @memberof GetSignableTransferResponseV1
|
|
4411
4503
|
*/
|
|
4412
4504
|
'payload_hash': string;
|
|
4505
|
+
/**
|
|
4506
|
+
* EIP-712 encoding of the StarkEx transfer transaction to be displayed to the user
|
|
4507
|
+
* @type {string}
|
|
4508
|
+
* @memberof GetSignableTransferResponseV1
|
|
4509
|
+
*/
|
|
4510
|
+
'readable_transaction': string;
|
|
4413
4511
|
/**
|
|
4414
4512
|
* Receiver of the transfer
|
|
4415
4513
|
* @type {string}
|
|
@@ -4440,8 +4538,71 @@ interface GetSignableTransferResponseV1 {
|
|
|
4440
4538
|
* @memberof GetSignableTransferResponseV1
|
|
4441
4539
|
*/
|
|
4442
4540
|
'signable_message': string;
|
|
4541
|
+
/**
|
|
4542
|
+
* IMX signed readable_transaction and payload_hash
|
|
4543
|
+
* @type {string}
|
|
4544
|
+
* @memberof GetSignableTransferResponseV1
|
|
4545
|
+
*/
|
|
4546
|
+
'verification_signature': string;
|
|
4547
|
+
}
|
|
4548
|
+
|
|
4549
|
+
/**
|
|
4550
|
+
* Immutable X API
|
|
4551
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4552
|
+
*
|
|
4553
|
+
* The version of the OpenAPI document: 3.0
|
|
4554
|
+
* Contact: support@immutable.com
|
|
4555
|
+
*
|
|
4556
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4557
|
+
* https://openapi-generator.tech
|
|
4558
|
+
* Do not edit the class manually.
|
|
4559
|
+
*/
|
|
4560
|
+
|
|
4561
|
+
/**
|
|
4562
|
+
*
|
|
4563
|
+
* @export
|
|
4564
|
+
* @interface GetSignableTransferResponseV2
|
|
4565
|
+
*/
|
|
4566
|
+
interface GetSignableTransferResponseV2 {
|
|
4567
|
+
/**
|
|
4568
|
+
* Sender of the transfer
|
|
4569
|
+
* @type {string}
|
|
4570
|
+
* @memberof GetSignableTransferResponseV2
|
|
4571
|
+
*/
|
|
4572
|
+
'sender_stark_key': string;
|
|
4573
|
+
/**
|
|
4574
|
+
* Message to sign with L1 wallet to confirm transfer request
|
|
4575
|
+
* @type {string}
|
|
4576
|
+
* @memberof GetSignableTransferResponseV2
|
|
4577
|
+
*/
|
|
4578
|
+
'signable_message': string;
|
|
4579
|
+
/**
|
|
4580
|
+
* List of transfer responses without the sender stark key
|
|
4581
|
+
* @type {Array<SignableTransferResponseDetails>}
|
|
4582
|
+
* @memberof GetSignableTransferResponseV2
|
|
4583
|
+
*/
|
|
4584
|
+
'signable_responses': Array<SignableTransferResponseDetails>;
|
|
4443
4585
|
}
|
|
4444
4586
|
|
|
4587
|
+
/**
|
|
4588
|
+
* Immutable X API
|
|
4589
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4590
|
+
*
|
|
4591
|
+
* The version of the OpenAPI document: 3.0
|
|
4592
|
+
* Contact: support@immutable.com
|
|
4593
|
+
*
|
|
4594
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4595
|
+
* https://openapi-generator.tech
|
|
4596
|
+
* Do not edit the class manually.
|
|
4597
|
+
*/
|
|
4598
|
+
|
|
4599
|
+
/**
|
|
4600
|
+
* @type GetSignableWithdrawalRequestToken
|
|
4601
|
+
* Token to withdraw
|
|
4602
|
+
* @export
|
|
4603
|
+
*/
|
|
4604
|
+
declare type GetSignableWithdrawalRequestToken = SignableToken;
|
|
4605
|
+
|
|
4445
4606
|
/**
|
|
4446
4607
|
* Immutable X API
|
|
4447
4608
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -4468,10 +4629,10 @@ interface GetSignableWithdrawalRequest {
|
|
|
4468
4629
|
'amount': string;
|
|
4469
4630
|
/**
|
|
4470
4631
|
*
|
|
4471
|
-
* @type {
|
|
4632
|
+
* @type {GetSignableWithdrawalRequestToken}
|
|
4472
4633
|
* @memberof GetSignableWithdrawalRequest
|
|
4473
4634
|
*/
|
|
4474
|
-
'token':
|
|
4635
|
+
'token': GetSignableWithdrawalRequestToken;
|
|
4475
4636
|
/**
|
|
4476
4637
|
* Ethereum address of the user who is making this withdrawal
|
|
4477
4638
|
* @type {string}
|
|
@@ -4521,6 +4682,12 @@ interface GetSignableWithdrawalResponse {
|
|
|
4521
4682
|
* @memberof GetSignableWithdrawalResponse
|
|
4522
4683
|
*/
|
|
4523
4684
|
'payload_hash': string;
|
|
4685
|
+
/**
|
|
4686
|
+
* EIP-712 encoding of the StarkEx withdrawal request to be displayed to the user
|
|
4687
|
+
* @type {string}
|
|
4688
|
+
* @memberof GetSignableWithdrawalResponse
|
|
4689
|
+
*/
|
|
4690
|
+
'readable_transaction': string;
|
|
4524
4691
|
/**
|
|
4525
4692
|
* Message to sign with L1 wallet to verity withdrawal request
|
|
4526
4693
|
* @type {string}
|
|
@@ -4539,6 +4706,12 @@ interface GetSignableWithdrawalResponse {
|
|
|
4539
4706
|
* @memberof GetSignableWithdrawalResponse
|
|
4540
4707
|
*/
|
|
4541
4708
|
'vault_id': number;
|
|
4709
|
+
/**
|
|
4710
|
+
* IMX signed readable_transaction and payload_hash
|
|
4711
|
+
* @type {string}
|
|
4712
|
+
* @memberof GetSignableWithdrawalResponse
|
|
4713
|
+
*/
|
|
4714
|
+
'verification_signature': string;
|
|
4542
4715
|
}
|
|
4543
4716
|
|
|
4544
4717
|
/**
|
|
@@ -4756,6 +4929,25 @@ interface ListDepositsResponse {
|
|
|
4756
4929
|
'result': Array<Deposit>;
|
|
4757
4930
|
}
|
|
4758
4931
|
|
|
4932
|
+
/**
|
|
4933
|
+
* Immutable X API
|
|
4934
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4935
|
+
*
|
|
4936
|
+
* The version of the OpenAPI document: 3.0
|
|
4937
|
+
* Contact: support@immutable.com
|
|
4938
|
+
*
|
|
4939
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4940
|
+
* https://openapi-generator.tech
|
|
4941
|
+
* Do not edit the class manually.
|
|
4942
|
+
*/
|
|
4943
|
+
|
|
4944
|
+
/**
|
|
4945
|
+
* @type MintToken
|
|
4946
|
+
* Details of the asset which has been minted
|
|
4947
|
+
* @export
|
|
4948
|
+
*/
|
|
4949
|
+
declare type MintToken = Token;
|
|
4950
|
+
|
|
4759
4951
|
/**
|
|
4760
4952
|
* Immutable X API
|
|
4761
4953
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -4794,10 +4986,10 @@ interface Mint {
|
|
|
4794
4986
|
'timestamp': string;
|
|
4795
4987
|
/**
|
|
4796
4988
|
*
|
|
4797
|
-
* @type {
|
|
4989
|
+
* @type {MintToken}
|
|
4798
4990
|
* @memberof Mint
|
|
4799
4991
|
*/
|
|
4800
|
-
'token':
|
|
4992
|
+
'token': MintToken;
|
|
4801
4993
|
/**
|
|
4802
4994
|
* Sequential ID of transaction in Immutable X
|
|
4803
4995
|
* @type {number}
|
|
@@ -4863,30 +5055,11 @@ interface ListMintsResponse {
|
|
|
4863
5055
|
*/
|
|
4864
5056
|
|
|
4865
5057
|
/**
|
|
4866
|
-
* @type
|
|
5058
|
+
* @type OrderV3Buy
|
|
4867
5059
|
* Details of the asset being bought
|
|
4868
5060
|
* @export
|
|
4869
5061
|
*/
|
|
4870
|
-
declare type
|
|
4871
|
-
|
|
4872
|
-
/**
|
|
4873
|
-
* Immutable X API
|
|
4874
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4875
|
-
*
|
|
4876
|
-
* The version of the OpenAPI document: 3.0
|
|
4877
|
-
* Contact: support@immutable.com
|
|
4878
|
-
*
|
|
4879
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4880
|
-
* https://openapi-generator.tech
|
|
4881
|
-
* Do not edit the class manually.
|
|
4882
|
-
*/
|
|
4883
|
-
|
|
4884
|
-
/**
|
|
4885
|
-
* @type OrderSell
|
|
4886
|
-
* Details of the asset being sold
|
|
4887
|
-
* @export
|
|
4888
|
-
*/
|
|
4889
|
-
declare type OrderSell = Token;
|
|
5062
|
+
declare type OrderV3Buy = Token;
|
|
4890
5063
|
|
|
4891
5064
|
/**
|
|
4892
5065
|
* Immutable X API
|
|
@@ -4903,146 +5076,9 @@ declare type OrderSell = Token;
|
|
|
4903
5076
|
/**
|
|
4904
5077
|
*
|
|
4905
5078
|
* @export
|
|
4906
|
-
* @interface
|
|
5079
|
+
* @interface OrdersMakerTakerFee
|
|
4907
5080
|
*/
|
|
4908
|
-
interface
|
|
4909
|
-
/**
|
|
4910
|
-
* Amount of the asset already sold by this order
|
|
4911
|
-
* @type {string}
|
|
4912
|
-
* @memberof Order
|
|
4913
|
-
*/
|
|
4914
|
-
'amount_sold': string | null;
|
|
4915
|
-
/**
|
|
4916
|
-
*
|
|
4917
|
-
* @type {OrderBuy}
|
|
4918
|
-
* @memberof Order
|
|
4919
|
-
*/
|
|
4920
|
-
'buy': OrderBuy;
|
|
4921
|
-
/**
|
|
4922
|
-
* Expiration timestamp of this order
|
|
4923
|
-
* @type {string}
|
|
4924
|
-
* @memberof Order
|
|
4925
|
-
*/
|
|
4926
|
-
'expiration_timestamp': string | null;
|
|
4927
|
-
/**
|
|
4928
|
-
* Fee information for the order
|
|
4929
|
-
* @type {Array<OrderFeeInfo>}
|
|
4930
|
-
* @memberof Order
|
|
4931
|
-
*/
|
|
4932
|
-
'fees'?: Array<OrderFeeInfo>;
|
|
4933
|
-
/**
|
|
4934
|
-
* ID of the order
|
|
4935
|
-
* @type {number}
|
|
4936
|
-
* @memberof Order
|
|
4937
|
-
*/
|
|
4938
|
-
'order_id': number;
|
|
4939
|
-
/**
|
|
4940
|
-
*
|
|
4941
|
-
* @type {OrderSell}
|
|
4942
|
-
* @memberof Order
|
|
4943
|
-
*/
|
|
4944
|
-
'sell': OrderSell;
|
|
4945
|
-
/**
|
|
4946
|
-
* Status of the order
|
|
4947
|
-
* @type {string}
|
|
4948
|
-
* @memberof Order
|
|
4949
|
-
*/
|
|
4950
|
-
'status': string;
|
|
4951
|
-
/**
|
|
4952
|
-
* Timestamp this order was created
|
|
4953
|
-
* @type {string}
|
|
4954
|
-
* @memberof Order
|
|
4955
|
-
*/
|
|
4956
|
-
'timestamp': string | null;
|
|
4957
|
-
/**
|
|
4958
|
-
* Updated timestamp of this order
|
|
4959
|
-
* @type {string}
|
|
4960
|
-
* @memberof Order
|
|
4961
|
-
*/
|
|
4962
|
-
'updated_timestamp': string | null;
|
|
4963
|
-
/**
|
|
4964
|
-
* Ethereum address of the user who submitted the order
|
|
4965
|
-
* @type {string}
|
|
4966
|
-
* @memberof Order
|
|
4967
|
-
*/
|
|
4968
|
-
'user': string;
|
|
4969
|
-
}
|
|
4970
|
-
|
|
4971
|
-
/**
|
|
4972
|
-
* Immutable X API
|
|
4973
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4974
|
-
*
|
|
4975
|
-
* The version of the OpenAPI document: 3.0
|
|
4976
|
-
* Contact: support@immutable.com
|
|
4977
|
-
*
|
|
4978
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4979
|
-
* https://openapi-generator.tech
|
|
4980
|
-
* Do not edit the class manually.
|
|
4981
|
-
*/
|
|
4982
|
-
|
|
4983
|
-
/**
|
|
4984
|
-
*
|
|
4985
|
-
* @export
|
|
4986
|
-
* @interface ListOrdersResponse
|
|
4987
|
-
*/
|
|
4988
|
-
interface ListOrdersResponse {
|
|
4989
|
-
/**
|
|
4990
|
-
* Generated cursor returned by previous query
|
|
4991
|
-
* @type {string}
|
|
4992
|
-
* @memberof ListOrdersResponse
|
|
4993
|
-
*/
|
|
4994
|
-
'cursor': string;
|
|
4995
|
-
/**
|
|
4996
|
-
* Remaining results flag. 1: there are remaining results matching this query, 0: no remaining results
|
|
4997
|
-
* @type {number}
|
|
4998
|
-
* @memberof ListOrdersResponse
|
|
4999
|
-
*/
|
|
5000
|
-
'remaining': number;
|
|
5001
|
-
/**
|
|
5002
|
-
* Orders matching query parameters
|
|
5003
|
-
* @type {Array<Order>}
|
|
5004
|
-
* @memberof ListOrdersResponse
|
|
5005
|
-
*/
|
|
5006
|
-
'result': Array<Order>;
|
|
5007
|
-
}
|
|
5008
|
-
|
|
5009
|
-
/**
|
|
5010
|
-
* Immutable X API
|
|
5011
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
5012
|
-
*
|
|
5013
|
-
* The version of the OpenAPI document: 3.0
|
|
5014
|
-
* Contact: support@immutable.com
|
|
5015
|
-
*
|
|
5016
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
5017
|
-
* https://openapi-generator.tech
|
|
5018
|
-
* Do not edit the class manually.
|
|
5019
|
-
*/
|
|
5020
|
-
|
|
5021
|
-
/**
|
|
5022
|
-
* @type OrderV3Buy
|
|
5023
|
-
* Details of the asset being bought
|
|
5024
|
-
* @export
|
|
5025
|
-
*/
|
|
5026
|
-
declare type OrderV3Buy = Token;
|
|
5027
|
-
|
|
5028
|
-
/**
|
|
5029
|
-
* Immutable X API
|
|
5030
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
5031
|
-
*
|
|
5032
|
-
* The version of the OpenAPI document: 3.0
|
|
5033
|
-
* Contact: support@immutable.com
|
|
5034
|
-
*
|
|
5035
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
5036
|
-
* https://openapi-generator.tech
|
|
5037
|
-
* Do not edit the class manually.
|
|
5038
|
-
*/
|
|
5039
|
-
|
|
5040
|
-
/**
|
|
5041
|
-
*
|
|
5042
|
-
* @export
|
|
5043
|
-
* @interface OrdersMakerTakerFee
|
|
5044
|
-
*/
|
|
5045
|
-
interface OrdersMakerTakerFee {
|
|
5081
|
+
interface OrdersMakerTakerFee {
|
|
5046
5082
|
/**
|
|
5047
5083
|
* Number of Decimals supported the fee token
|
|
5048
5084
|
* @type {number}
|
|
@@ -5322,7 +5358,7 @@ interface TokenDetails {
|
|
|
5322
5358
|
*/
|
|
5323
5359
|
'symbol': string;
|
|
5324
5360
|
/**
|
|
5325
|
-
* Address of the
|
|
5361
|
+
* Address of the ERC20 contract
|
|
5326
5362
|
* @type {string}
|
|
5327
5363
|
* @memberof TokenDetails
|
|
5328
5364
|
*/
|
|
@@ -5536,6 +5572,25 @@ interface ListTradesResponse {
|
|
|
5536
5572
|
'result': Array<Trade>;
|
|
5537
5573
|
}
|
|
5538
5574
|
|
|
5575
|
+
/**
|
|
5576
|
+
* Immutable X API
|
|
5577
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
5578
|
+
*
|
|
5579
|
+
* The version of the OpenAPI document: 3.0
|
|
5580
|
+
* Contact: support@immutable.com
|
|
5581
|
+
*
|
|
5582
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
5583
|
+
* https://openapi-generator.tech
|
|
5584
|
+
* Do not edit the class manually.
|
|
5585
|
+
*/
|
|
5586
|
+
|
|
5587
|
+
/**
|
|
5588
|
+
* @type TransferToken
|
|
5589
|
+
* Token transferred by the user
|
|
5590
|
+
* @export
|
|
5591
|
+
*/
|
|
5592
|
+
declare type TransferToken = Token;
|
|
5593
|
+
|
|
5539
5594
|
/**
|
|
5540
5595
|
* Immutable X API
|
|
5541
5596
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -5574,10 +5629,10 @@ interface Transfer {
|
|
|
5574
5629
|
'timestamp': string | null;
|
|
5575
5630
|
/**
|
|
5576
5631
|
*
|
|
5577
|
-
* @type {
|
|
5632
|
+
* @type {TransferToken}
|
|
5578
5633
|
* @memberof Transfer
|
|
5579
5634
|
*/
|
|
5580
|
-
'token':
|
|
5635
|
+
'token': TransferToken;
|
|
5581
5636
|
/**
|
|
5582
5637
|
* Sequential transaction ID
|
|
5583
5638
|
* @type {number}
|
|
@@ -5630,6 +5685,25 @@ interface ListTransfersResponse {
|
|
|
5630
5685
|
'result': Array<Transfer>;
|
|
5631
5686
|
}
|
|
5632
5687
|
|
|
5688
|
+
/**
|
|
5689
|
+
* Immutable X API
|
|
5690
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
5691
|
+
*
|
|
5692
|
+
* The version of the OpenAPI document: 3.0
|
|
5693
|
+
* Contact: support@immutable.com
|
|
5694
|
+
*
|
|
5695
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
5696
|
+
* https://openapi-generator.tech
|
|
5697
|
+
* Do not edit the class manually.
|
|
5698
|
+
*/
|
|
5699
|
+
|
|
5700
|
+
/**
|
|
5701
|
+
* @type WithdrawalToken
|
|
5702
|
+
* Details of the asset this user is withdrawing
|
|
5703
|
+
* @export
|
|
5704
|
+
*/
|
|
5705
|
+
declare type WithdrawalToken = Token;
|
|
5706
|
+
|
|
5633
5707
|
/**
|
|
5634
5708
|
* Immutable X API
|
|
5635
5709
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -5674,10 +5748,10 @@ interface Withdrawal {
|
|
|
5674
5748
|
'timestamp': string;
|
|
5675
5749
|
/**
|
|
5676
5750
|
*
|
|
5677
|
-
* @type {
|
|
5751
|
+
* @type {WithdrawalToken}
|
|
5678
5752
|
* @memberof Withdrawal
|
|
5679
5753
|
*/
|
|
5680
|
-
'token':
|
|
5754
|
+
'token': WithdrawalToken;
|
|
5681
5755
|
/**
|
|
5682
5756
|
* Sequential ID of this transaction
|
|
5683
5757
|
* @type {number}
|
|
@@ -6386,6 +6460,43 @@ interface NftprimarytransactionListTransactionsResponse {
|
|
|
6386
6460
|
'result'?: Array<NftprimarytransactionTransactionData>;
|
|
6387
6461
|
}
|
|
6388
6462
|
|
|
6463
|
+
/**
|
|
6464
|
+
* Immutable X API
|
|
6465
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6466
|
+
*
|
|
6467
|
+
* The version of the OpenAPI document: 3.0
|
|
6468
|
+
* Contact: support@immutable.com
|
|
6469
|
+
*
|
|
6470
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
6471
|
+
* https://openapi-generator.tech
|
|
6472
|
+
* Do not edit the class manually.
|
|
6473
|
+
*/
|
|
6474
|
+
/**
|
|
6475
|
+
*
|
|
6476
|
+
* @export
|
|
6477
|
+
* @interface RegisterPassportUserResult
|
|
6478
|
+
*/
|
|
6479
|
+
interface RegisterPassportUserResult {
|
|
6480
|
+
/**
|
|
6481
|
+
* The ether key of the user
|
|
6482
|
+
* @type {string}
|
|
6483
|
+
* @memberof RegisterPassportUserResult
|
|
6484
|
+
*/
|
|
6485
|
+
'ether_key'?: string;
|
|
6486
|
+
/**
|
|
6487
|
+
* The stark key of the user
|
|
6488
|
+
* @type {string}
|
|
6489
|
+
* @memberof RegisterPassportUserResult
|
|
6490
|
+
*/
|
|
6491
|
+
'stark_key'?: string;
|
|
6492
|
+
/**
|
|
6493
|
+
* The admin key of the user
|
|
6494
|
+
* @type {string}
|
|
6495
|
+
* @memberof RegisterPassportUserResult
|
|
6496
|
+
*/
|
|
6497
|
+
'user_admin_key'?: string;
|
|
6498
|
+
}
|
|
6499
|
+
|
|
6389
6500
|
/**
|
|
6390
6501
|
* Immutable X API
|
|
6391
6502
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -8118,427 +8229,134 @@ declare class NftCheckoutPrimaryApi extends BaseAPI {
|
|
|
8118
8229
|
* @param {NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest} requestParameters Request parameters.
|
|
8119
8230
|
* @param {*} [options] Override http request option.
|
|
8120
8231
|
* @throws {RequiredError}
|
|
8121
|
-
* @memberof NftCheckoutPrimaryApi
|
|
8122
|
-
*/
|
|
8123
|
-
registerNftPrimarySalesContract(requestParameters: NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ContractCreateResponse, any>>;
|
|
8124
|
-
}
|
|
8125
|
-
/**
|
|
8126
|
-
* Request parameters for cancelOrder operation in OrdersApi.
|
|
8127
|
-
* @export
|
|
8128
|
-
* @interface OrdersApiCancelOrderRequest
|
|
8129
|
-
*/
|
|
8130
|
-
interface OrdersApiCancelOrderRequest {
|
|
8131
|
-
/**
|
|
8132
|
-
* Order ID to cancel
|
|
8133
|
-
* @type {string}
|
|
8134
|
-
* @memberof OrdersApiCancelOrder
|
|
8135
|
-
*/
|
|
8136
|
-
readonly id: string;
|
|
8137
|
-
/**
|
|
8138
|
-
* cancel an order
|
|
8139
|
-
* @type {CancelOrderRequest}
|
|
8140
|
-
* @memberof OrdersApiCancelOrder
|
|
8141
|
-
*/
|
|
8142
|
-
readonly cancelOrderRequest: CancelOrderRequest;
|
|
8143
|
-
/**
|
|
8144
|
-
* eth address
|
|
8145
|
-
* @type {string}
|
|
8146
|
-
* @memberof OrdersApiCancelOrder
|
|
8147
|
-
*/
|
|
8148
|
-
readonly xImxEthAddress?: string;
|
|
8149
|
-
/**
|
|
8150
|
-
* eth signature
|
|
8151
|
-
* @type {string}
|
|
8152
|
-
* @memberof OrdersApiCancelOrder
|
|
8153
|
-
*/
|
|
8154
|
-
readonly xImxEthSignature?: string;
|
|
8155
|
-
/**
|
|
8156
|
-
* Authorization header
|
|
8157
|
-
* @type {string}
|
|
8158
|
-
* @memberof OrdersApiCancelOrder
|
|
8159
|
-
*/
|
|
8160
|
-
readonly authorization?: string;
|
|
8161
|
-
}
|
|
8162
|
-
/**
|
|
8163
|
-
* Request parameters for cancelOrderV3 operation in OrdersApi.
|
|
8164
|
-
* @export
|
|
8165
|
-
* @interface OrdersApiCancelOrderV3Request
|
|
8166
|
-
*/
|
|
8167
|
-
interface OrdersApiCancelOrderV3Request {
|
|
8168
|
-
/**
|
|
8169
|
-
* Order ID to cancel
|
|
8170
|
-
* @type {string}
|
|
8171
|
-
* @memberof OrdersApiCancelOrderV3
|
|
8172
|
-
*/
|
|
8173
|
-
readonly id: string;
|
|
8174
|
-
/**
|
|
8175
|
-
* cancel an order
|
|
8176
|
-
* @type {CancelOrderRequest}
|
|
8177
|
-
* @memberof OrdersApiCancelOrderV3
|
|
8178
|
-
*/
|
|
8179
|
-
readonly cancelOrderRequest: CancelOrderRequest;
|
|
8180
|
-
/**
|
|
8181
|
-
* eth address
|
|
8182
|
-
* @type {string}
|
|
8183
|
-
* @memberof OrdersApiCancelOrderV3
|
|
8184
|
-
*/
|
|
8185
|
-
readonly xImxEthAddress?: string;
|
|
8186
|
-
/**
|
|
8187
|
-
* eth signature
|
|
8188
|
-
* @type {string}
|
|
8189
|
-
* @memberof OrdersApiCancelOrderV3
|
|
8190
|
-
*/
|
|
8191
|
-
readonly xImxEthSignature?: string;
|
|
8192
|
-
/**
|
|
8193
|
-
* Authorization header
|
|
8194
|
-
* @type {string}
|
|
8195
|
-
* @memberof OrdersApiCancelOrderV3
|
|
8196
|
-
*/
|
|
8197
|
-
readonly authorization?: string;
|
|
8198
|
-
}
|
|
8199
|
-
/**
|
|
8200
|
-
* Request parameters for createOrder operation in OrdersApi.
|
|
8201
|
-
* @export
|
|
8202
|
-
* @interface OrdersApiCreateOrderRequest
|
|
8203
|
-
*/
|
|
8204
|
-
interface OrdersApiCreateOrderRequest {
|
|
8205
|
-
/**
|
|
8206
|
-
* create an order
|
|
8207
|
-
* @type {CreateOrderRequest}
|
|
8208
|
-
* @memberof OrdersApiCreateOrder
|
|
8209
|
-
*/
|
|
8210
|
-
readonly createOrderRequest: CreateOrderRequest;
|
|
8211
|
-
/**
|
|
8212
|
-
* eth address
|
|
8213
|
-
* @type {string}
|
|
8214
|
-
* @memberof OrdersApiCreateOrder
|
|
8215
|
-
*/
|
|
8216
|
-
readonly xImxEthAddress?: string;
|
|
8217
|
-
/**
|
|
8218
|
-
* eth signature
|
|
8219
|
-
* @type {string}
|
|
8220
|
-
* @memberof OrdersApiCreateOrder
|
|
8221
|
-
*/
|
|
8222
|
-
readonly xImxEthSignature?: string;
|
|
8223
|
-
/**
|
|
8224
|
-
* Authorization header
|
|
8225
|
-
* @type {string}
|
|
8226
|
-
* @memberof OrdersApiCreateOrder
|
|
8227
|
-
*/
|
|
8228
|
-
readonly authorization?: string;
|
|
8229
|
-
}
|
|
8230
|
-
/**
|
|
8231
|
-
* Request parameters for createOrderV3 operation in OrdersApi.
|
|
8232
|
-
* @export
|
|
8233
|
-
* @interface OrdersApiCreateOrderV3Request
|
|
8234
|
-
*/
|
|
8235
|
-
interface OrdersApiCreateOrderV3Request {
|
|
8236
|
-
/**
|
|
8237
|
-
* create an order
|
|
8238
|
-
* @type {CreateOrderRequestV3}
|
|
8239
|
-
* @memberof OrdersApiCreateOrderV3
|
|
8240
|
-
*/
|
|
8241
|
-
readonly createOrderRequest: CreateOrderRequestV3;
|
|
8242
|
-
/**
|
|
8243
|
-
* eth address
|
|
8244
|
-
* @type {string}
|
|
8245
|
-
* @memberof OrdersApiCreateOrderV3
|
|
8246
|
-
*/
|
|
8247
|
-
readonly xImxEthAddress?: string;
|
|
8248
|
-
/**
|
|
8249
|
-
* eth signature
|
|
8250
|
-
* @type {string}
|
|
8251
|
-
* @memberof OrdersApiCreateOrderV3
|
|
8252
|
-
*/
|
|
8253
|
-
readonly xImxEthSignature?: string;
|
|
8254
|
-
/**
|
|
8255
|
-
* Authorization header
|
|
8256
|
-
* @type {string}
|
|
8257
|
-
* @memberof OrdersApiCreateOrderV3
|
|
8258
|
-
*/
|
|
8259
|
-
readonly authorization?: string;
|
|
8260
|
-
}
|
|
8261
|
-
/**
|
|
8262
|
-
* Request parameters for getOrder operation in OrdersApi.
|
|
8263
|
-
* @export
|
|
8264
|
-
* @interface OrdersApiGetOrderRequest
|
|
8265
|
-
*/
|
|
8266
|
-
interface OrdersApiGetOrderRequest {
|
|
8267
|
-
/**
|
|
8268
|
-
* Order ID
|
|
8269
|
-
* @type {string}
|
|
8270
|
-
* @memberof OrdersApiGetOrder
|
|
8271
|
-
*/
|
|
8272
|
-
readonly id: string;
|
|
8273
|
-
/**
|
|
8274
|
-
* Set flag to true to include fee body for the order
|
|
8275
|
-
* @type {boolean}
|
|
8276
|
-
* @memberof OrdersApiGetOrder
|
|
8277
|
-
*/
|
|
8278
|
-
readonly includeFees?: boolean;
|
|
8279
|
-
/**
|
|
8280
|
-
* Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
|
|
8281
|
-
* @type {string}
|
|
8282
|
-
* @memberof OrdersApiGetOrder
|
|
8283
|
-
*/
|
|
8284
|
-
readonly auxiliaryFeePercentages?: string;
|
|
8285
|
-
/**
|
|
8286
|
-
* Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
|
|
8287
|
-
* @type {string}
|
|
8288
|
-
* @memberof OrdersApiGetOrder
|
|
8289
|
-
*/
|
|
8290
|
-
readonly auxiliaryFeeRecipients?: string;
|
|
8291
|
-
}
|
|
8292
|
-
/**
|
|
8293
|
-
* Request parameters for getOrderV3 operation in OrdersApi.
|
|
8294
|
-
* @export
|
|
8295
|
-
* @interface OrdersApiGetOrderV3Request
|
|
8296
|
-
*/
|
|
8297
|
-
interface OrdersApiGetOrderV3Request {
|
|
8298
|
-
/**
|
|
8299
|
-
* Order ID
|
|
8300
|
-
* @type {string}
|
|
8301
|
-
* @memberof OrdersApiGetOrderV3
|
|
8302
|
-
*/
|
|
8303
|
-
readonly id: string;
|
|
8304
|
-
/**
|
|
8305
|
-
* Set flag to true to include fee body for the order
|
|
8306
|
-
* @type {boolean}
|
|
8307
|
-
* @memberof OrdersApiGetOrderV3
|
|
8308
|
-
*/
|
|
8309
|
-
readonly includeFees?: boolean;
|
|
8310
|
-
/**
|
|
8311
|
-
* Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
|
|
8312
|
-
* @type {string}
|
|
8313
|
-
* @memberof OrdersApiGetOrderV3
|
|
8314
|
-
*/
|
|
8315
|
-
readonly auxiliaryFeePercentages?: string;
|
|
8316
|
-
/**
|
|
8317
|
-
* Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
|
|
8318
|
-
* @type {string}
|
|
8319
|
-
* @memberof OrdersApiGetOrderV3
|
|
8320
|
-
*/
|
|
8321
|
-
readonly auxiliaryFeeRecipients?: string;
|
|
8322
|
-
}
|
|
8323
|
-
/**
|
|
8324
|
-
* Request parameters for getSignableCancelOrder operation in OrdersApi.
|
|
8325
|
-
* @export
|
|
8326
|
-
* @interface OrdersApiGetSignableCancelOrderRequest
|
|
8327
|
-
*/
|
|
8328
|
-
interface OrdersApiGetSignableCancelOrderRequest {
|
|
8329
|
-
/**
|
|
8330
|
-
* get a signable cancel order
|
|
8331
|
-
* @type {GetSignableCancelOrderRequest}
|
|
8332
|
-
* @memberof OrdersApiGetSignableCancelOrder
|
|
8333
|
-
*/
|
|
8334
|
-
readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
|
|
8335
|
-
}
|
|
8336
|
-
/**
|
|
8337
|
-
* Request parameters for getSignableCancelOrderV3 operation in OrdersApi.
|
|
8338
|
-
* @export
|
|
8339
|
-
* @interface OrdersApiGetSignableCancelOrderV3Request
|
|
8340
|
-
*/
|
|
8341
|
-
interface OrdersApiGetSignableCancelOrderV3Request {
|
|
8342
|
-
/**
|
|
8343
|
-
* get a signable cancel order
|
|
8344
|
-
* @type {GetSignableCancelOrderRequest}
|
|
8345
|
-
* @memberof OrdersApiGetSignableCancelOrderV3
|
|
8346
|
-
*/
|
|
8347
|
-
readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
|
|
8348
|
-
}
|
|
8349
|
-
/**
|
|
8350
|
-
* Request parameters for getSignableOrder operation in OrdersApi.
|
|
8351
|
-
* @export
|
|
8352
|
-
* @interface OrdersApiGetSignableOrderRequest
|
|
8353
|
-
*/
|
|
8354
|
-
interface OrdersApiGetSignableOrderRequest {
|
|
8355
|
-
/**
|
|
8356
|
-
* get a signable order v3
|
|
8357
|
-
* @type {GetSignableOrderRequestV3}
|
|
8358
|
-
* @memberof OrdersApiGetSignableOrder
|
|
8359
|
-
*/
|
|
8360
|
-
readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
|
|
8361
|
-
}
|
|
8362
|
-
/**
|
|
8363
|
-
* Request parameters for listOrders operation in OrdersApi.
|
|
8364
|
-
* @export
|
|
8365
|
-
* @interface OrdersApiListOrdersRequest
|
|
8366
|
-
*/
|
|
8367
|
-
interface OrdersApiListOrdersRequest {
|
|
8368
|
-
/**
|
|
8369
|
-
* Page size of the result
|
|
8370
|
-
* @type {number}
|
|
8371
|
-
* @memberof OrdersApiListOrders
|
|
8372
|
-
*/
|
|
8373
|
-
readonly pageSize?: number;
|
|
8374
|
-
/**
|
|
8375
|
-
* Cursor
|
|
8376
|
-
* @type {string}
|
|
8377
|
-
* @memberof OrdersApiListOrders
|
|
8378
|
-
*/
|
|
8379
|
-
readonly cursor?: string;
|
|
8380
|
-
/**
|
|
8381
|
-
* Property to sort by
|
|
8382
|
-
* @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
|
|
8383
|
-
* @memberof OrdersApiListOrders
|
|
8384
|
-
*/
|
|
8385
|
-
readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
|
|
8386
|
-
/**
|
|
8387
|
-
* Direction to sort (asc/desc)
|
|
8388
|
-
* @type {string}
|
|
8389
|
-
* @memberof OrdersApiListOrders
|
|
8390
|
-
*/
|
|
8391
|
-
readonly direction?: string;
|
|
8392
|
-
/**
|
|
8393
|
-
* Ethereum address of the user who submitted this order
|
|
8394
|
-
* @type {string}
|
|
8395
|
-
* @memberof OrdersApiListOrders
|
|
8396
|
-
*/
|
|
8397
|
-
readonly user?: string;
|
|
8398
|
-
/**
|
|
8399
|
-
* Status of this order
|
|
8400
|
-
* @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
|
|
8401
|
-
* @memberof OrdersApiListOrders
|
|
8402
|
-
*/
|
|
8403
|
-
readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
|
|
8404
|
-
/**
|
|
8405
|
-
* Filter orders to include those with created_at timestamps after this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
8406
|
-
* @type {string}
|
|
8407
|
-
* @memberof OrdersApiListOrders
|
|
8408
|
-
*/
|
|
8409
|
-
readonly minTimestamp?: string;
|
|
8410
|
-
/**
|
|
8411
|
-
* Filter orders to include those with created_at timestamps before this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
8412
|
-
* @type {string}
|
|
8413
|
-
* @memberof OrdersApiListOrders
|
|
8414
|
-
*/
|
|
8415
|
-
readonly maxTimestamp?: string;
|
|
8416
|
-
/**
|
|
8417
|
-
* Filter orders to include those with updated_at timestamps after this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
8418
|
-
* @type {string}
|
|
8419
|
-
* @memberof OrdersApiListOrders
|
|
8420
|
-
*/
|
|
8421
|
-
readonly updatedMinTimestamp?: string;
|
|
8422
|
-
/**
|
|
8423
|
-
* Filter orders to include those with updated_at timestamps before this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
8424
|
-
* @type {string}
|
|
8425
|
-
* @memberof OrdersApiListOrders
|
|
8426
|
-
*/
|
|
8427
|
-
readonly updatedMaxTimestamp?: string;
|
|
8428
|
-
/**
|
|
8429
|
-
* Token type of the asset this order buys
|
|
8430
|
-
* @type {string}
|
|
8431
|
-
* @memberof OrdersApiListOrders
|
|
8432
|
-
*/
|
|
8433
|
-
readonly buyTokenType?: string;
|
|
8434
|
-
/**
|
|
8435
|
-
* ERC721 Token ID of the asset this order buys
|
|
8436
|
-
* @type {string}
|
|
8437
|
-
* @memberof OrdersApiListOrders
|
|
8438
|
-
*/
|
|
8439
|
-
readonly buyTokenId?: string;
|
|
8440
|
-
/**
|
|
8441
|
-
* Internal IMX ID of the asset this order buys
|
|
8442
|
-
* @type {string}
|
|
8443
|
-
* @memberof OrdersApiListOrders
|
|
8444
|
-
*/
|
|
8445
|
-
readonly buyAssetId?: string;
|
|
8446
|
-
/**
|
|
8447
|
-
* Token address of the asset this order buys
|
|
8448
|
-
* @type {string}
|
|
8449
|
-
* @memberof OrdersApiListOrders
|
|
8450
|
-
*/
|
|
8451
|
-
readonly buyTokenAddress?: string;
|
|
8452
|
-
/**
|
|
8453
|
-
* Token name of the asset this order buys
|
|
8454
|
-
* @type {string}
|
|
8455
|
-
* @memberof OrdersApiListOrders
|
|
8232
|
+
* @memberof NftCheckoutPrimaryApi
|
|
8456
8233
|
*/
|
|
8457
|
-
|
|
8234
|
+
registerNftPrimarySalesContract(requestParameters: NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ContractCreateResponse, any>>;
|
|
8235
|
+
}
|
|
8236
|
+
/**
|
|
8237
|
+
* Request parameters for cancelOrderV3 operation in OrdersApi.
|
|
8238
|
+
* @export
|
|
8239
|
+
* @interface OrdersApiCancelOrderV3Request
|
|
8240
|
+
*/
|
|
8241
|
+
interface OrdersApiCancelOrderV3Request {
|
|
8458
8242
|
/**
|
|
8459
|
-
*
|
|
8243
|
+
* Order ID to cancel
|
|
8460
8244
|
* @type {string}
|
|
8461
|
-
* @memberof
|
|
8245
|
+
* @memberof OrdersApiCancelOrderV3
|
|
8462
8246
|
*/
|
|
8463
|
-
readonly
|
|
8247
|
+
readonly id: string;
|
|
8464
8248
|
/**
|
|
8465
|
-
*
|
|
8466
|
-
* @type {
|
|
8467
|
-
* @memberof
|
|
8249
|
+
* cancel an order
|
|
8250
|
+
* @type {CancelOrderRequest}
|
|
8251
|
+
* @memberof OrdersApiCancelOrderV3
|
|
8468
8252
|
*/
|
|
8469
|
-
readonly
|
|
8253
|
+
readonly cancelOrderRequest: CancelOrderRequest;
|
|
8470
8254
|
/**
|
|
8471
|
-
*
|
|
8255
|
+
* eth address
|
|
8472
8256
|
* @type {string}
|
|
8473
|
-
* @memberof
|
|
8257
|
+
* @memberof OrdersApiCancelOrderV3
|
|
8474
8258
|
*/
|
|
8475
|
-
readonly
|
|
8259
|
+
readonly xImxEthAddress?: string;
|
|
8476
8260
|
/**
|
|
8477
|
-
*
|
|
8261
|
+
* eth signature
|
|
8478
8262
|
* @type {string}
|
|
8479
|
-
* @memberof
|
|
8263
|
+
* @memberof OrdersApiCancelOrderV3
|
|
8480
8264
|
*/
|
|
8481
|
-
readonly
|
|
8265
|
+
readonly xImxEthSignature?: string;
|
|
8482
8266
|
/**
|
|
8483
|
-
*
|
|
8267
|
+
* Authorization header
|
|
8484
8268
|
* @type {string}
|
|
8485
|
-
* @memberof
|
|
8269
|
+
* @memberof OrdersApiCancelOrderV3
|
|
8486
8270
|
*/
|
|
8487
|
-
readonly
|
|
8271
|
+
readonly authorization?: string;
|
|
8272
|
+
}
|
|
8273
|
+
/**
|
|
8274
|
+
* Request parameters for createOrderV3 operation in OrdersApi.
|
|
8275
|
+
* @export
|
|
8276
|
+
* @interface OrdersApiCreateOrderV3Request
|
|
8277
|
+
*/
|
|
8278
|
+
interface OrdersApiCreateOrderV3Request {
|
|
8488
8279
|
/**
|
|
8489
|
-
*
|
|
8490
|
-
* @type {
|
|
8491
|
-
* @memberof
|
|
8280
|
+
* create an order
|
|
8281
|
+
* @type {CreateOrderRequestV3}
|
|
8282
|
+
* @memberof OrdersApiCreateOrderV3
|
|
8492
8283
|
*/
|
|
8493
|
-
readonly
|
|
8284
|
+
readonly createOrderRequest: CreateOrderRequestV3;
|
|
8494
8285
|
/**
|
|
8495
|
-
*
|
|
8286
|
+
* eth address
|
|
8496
8287
|
* @type {string}
|
|
8497
|
-
* @memberof
|
|
8288
|
+
* @memberof OrdersApiCreateOrderV3
|
|
8498
8289
|
*/
|
|
8499
|
-
readonly
|
|
8290
|
+
readonly xImxEthAddress?: string;
|
|
8500
8291
|
/**
|
|
8501
|
-
*
|
|
8292
|
+
* eth signature
|
|
8502
8293
|
* @type {string}
|
|
8503
|
-
* @memberof
|
|
8294
|
+
* @memberof OrdersApiCreateOrderV3
|
|
8504
8295
|
*/
|
|
8505
|
-
readonly
|
|
8296
|
+
readonly xImxEthSignature?: string;
|
|
8506
8297
|
/**
|
|
8507
|
-
*
|
|
8298
|
+
* Authorization header
|
|
8508
8299
|
* @type {string}
|
|
8509
|
-
* @memberof
|
|
8300
|
+
* @memberof OrdersApiCreateOrderV3
|
|
8510
8301
|
*/
|
|
8511
|
-
readonly
|
|
8302
|
+
readonly authorization?: string;
|
|
8303
|
+
}
|
|
8304
|
+
/**
|
|
8305
|
+
* Request parameters for getOrderV3 operation in OrdersApi.
|
|
8306
|
+
* @export
|
|
8307
|
+
* @interface OrdersApiGetOrderV3Request
|
|
8308
|
+
*/
|
|
8309
|
+
interface OrdersApiGetOrderV3Request {
|
|
8512
8310
|
/**
|
|
8513
|
-
*
|
|
8311
|
+
* Order ID
|
|
8514
8312
|
* @type {string}
|
|
8515
|
-
* @memberof
|
|
8313
|
+
* @memberof OrdersApiGetOrderV3
|
|
8516
8314
|
*/
|
|
8517
|
-
readonly
|
|
8315
|
+
readonly id: string;
|
|
8518
8316
|
/**
|
|
8519
|
-
*
|
|
8520
|
-
* @type {
|
|
8521
|
-
* @memberof
|
|
8317
|
+
* Set flag to true to include fee body for the order
|
|
8318
|
+
* @type {boolean}
|
|
8319
|
+
* @memberof OrdersApiGetOrderV3
|
|
8522
8320
|
*/
|
|
8523
|
-
readonly
|
|
8321
|
+
readonly includeFees?: boolean;
|
|
8524
8322
|
/**
|
|
8525
8323
|
* Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
|
|
8526
8324
|
* @type {string}
|
|
8527
|
-
* @memberof
|
|
8325
|
+
* @memberof OrdersApiGetOrderV3
|
|
8528
8326
|
*/
|
|
8529
8327
|
readonly auxiliaryFeePercentages?: string;
|
|
8530
8328
|
/**
|
|
8531
8329
|
* Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
|
|
8532
8330
|
* @type {string}
|
|
8533
|
-
* @memberof
|
|
8331
|
+
* @memberof OrdersApiGetOrderV3
|
|
8534
8332
|
*/
|
|
8535
8333
|
readonly auxiliaryFeeRecipients?: string;
|
|
8334
|
+
}
|
|
8335
|
+
/**
|
|
8336
|
+
* Request parameters for getSignableCancelOrderV3 operation in OrdersApi.
|
|
8337
|
+
* @export
|
|
8338
|
+
* @interface OrdersApiGetSignableCancelOrderV3Request
|
|
8339
|
+
*/
|
|
8340
|
+
interface OrdersApiGetSignableCancelOrderV3Request {
|
|
8536
8341
|
/**
|
|
8537
|
-
*
|
|
8538
|
-
* @type {
|
|
8539
|
-
* @memberof
|
|
8342
|
+
* get a signable cancel order
|
|
8343
|
+
* @type {GetSignableCancelOrderRequest}
|
|
8344
|
+
* @memberof OrdersApiGetSignableCancelOrderV3
|
|
8540
8345
|
*/
|
|
8541
|
-
readonly
|
|
8346
|
+
readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
|
|
8347
|
+
}
|
|
8348
|
+
/**
|
|
8349
|
+
* Request parameters for getSignableOrder operation in OrdersApi.
|
|
8350
|
+
* @export
|
|
8351
|
+
* @interface OrdersApiGetSignableOrderRequest
|
|
8352
|
+
*/
|
|
8353
|
+
interface OrdersApiGetSignableOrderRequest {
|
|
8354
|
+
/**
|
|
8355
|
+
* get a signable order v3
|
|
8356
|
+
* @type {GetSignableOrderRequestV3}
|
|
8357
|
+
* @memberof OrdersApiGetSignableOrder
|
|
8358
|
+
*/
|
|
8359
|
+
readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
|
|
8542
8360
|
}
|
|
8543
8361
|
/**
|
|
8544
8362
|
* Request parameters for listOrdersV3 operation in OrdersApi.
|
|
@@ -8728,16 +8546,6 @@ interface OrdersApiListOrdersV3Request {
|
|
|
8728
8546
|
* @extends {BaseAPI}
|
|
8729
8547
|
*/
|
|
8730
8548
|
declare class OrdersApi extends BaseAPI {
|
|
8731
|
-
/**
|
|
8732
|
-
* 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
|
|
8733
|
-
* @summary Cancel an order
|
|
8734
|
-
* @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
|
|
8735
|
-
* @param {*} [options] Override http request option.
|
|
8736
|
-
* @deprecated
|
|
8737
|
-
* @throws {RequiredError}
|
|
8738
|
-
* @memberof OrdersApi
|
|
8739
|
-
*/
|
|
8740
|
-
cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
|
|
8741
8549
|
/**
|
|
8742
8550
|
* Cancel an order (V3)
|
|
8743
8551
|
* @summary Cancel an order (V3)
|
|
@@ -8748,17 +8556,7 @@ declare class OrdersApi extends BaseAPI {
|
|
|
8748
8556
|
*/
|
|
8749
8557
|
cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
|
|
8750
8558
|
/**
|
|
8751
|
-
* Create an order
|
|
8752
|
-
* @summary Create an order
|
|
8753
|
-
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
8754
|
-
* @param {*} [options] Override http request option.
|
|
8755
|
-
* @deprecated
|
|
8756
|
-
* @throws {RequiredError}
|
|
8757
|
-
* @memberof OrdersApi
|
|
8758
|
-
*/
|
|
8759
|
-
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
|
|
8760
|
-
/**
|
|
8761
|
-
* Create an order using the v3 orderbook. Currently only buy NFT orders are supported.
|
|
8559
|
+
* Create an order using the v3 orderbook.
|
|
8762
8560
|
* @summary Create an order (V3)
|
|
8763
8561
|
* @param {OrdersApiCreateOrderV3Request} requestParameters Request parameters.
|
|
8764
8562
|
* @param {*} [options] Override http request option.
|
|
@@ -8766,16 +8564,6 @@ declare class OrdersApi extends BaseAPI {
|
|
|
8766
8564
|
* @memberof OrdersApi
|
|
8767
8565
|
*/
|
|
8768
8566
|
createOrderV3(requestParameters: OrdersApiCreateOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
|
|
8769
|
-
/**
|
|
8770
|
-
* 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
|
|
8771
|
-
* @summary Get an order
|
|
8772
|
-
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
8773
|
-
* @param {*} [options] Override http request option.
|
|
8774
|
-
* @deprecated
|
|
8775
|
-
* @throws {RequiredError}
|
|
8776
|
-
* @memberof OrdersApi
|
|
8777
|
-
*/
|
|
8778
|
-
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Order, any>>;
|
|
8779
8567
|
/**
|
|
8780
8568
|
* Get an order (V3)
|
|
8781
8569
|
* @summary Get an order (V3)
|
|
@@ -8785,16 +8573,6 @@ declare class OrdersApi extends BaseAPI {
|
|
|
8785
8573
|
* @memberof OrdersApi
|
|
8786
8574
|
*/
|
|
8787
8575
|
getOrderV3(requestParameters: OrdersApiGetOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<OrderV3, any>>;
|
|
8788
|
-
/**
|
|
8789
|
-
* 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
|
|
8790
|
-
* @summary Sign cancel order message
|
|
8791
|
-
* @param {OrdersApiGetSignableCancelOrderRequest} requestParameters Request parameters.
|
|
8792
|
-
* @param {*} [options] Override http request option.
|
|
8793
|
-
* @deprecated
|
|
8794
|
-
* @throws {RequiredError}
|
|
8795
|
-
* @memberof OrdersApi
|
|
8796
|
-
*/
|
|
8797
|
-
getSignableCancelOrder(requestParameters: OrdersApiGetSignableCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
|
|
8798
8576
|
/**
|
|
8799
8577
|
* Generate a signable cancel order message (V3)
|
|
8800
8578
|
* @summary Generate a signable cancel order message (V3)
|
|
@@ -8813,16 +8591,6 @@ declare class OrdersApi extends BaseAPI {
|
|
|
8813
8591
|
* @memberof OrdersApi
|
|
8814
8592
|
*/
|
|
8815
8593
|
getSignableOrder(requestParameters: OrdersApiGetSignableOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableOrderResponse, any>>;
|
|
8816
|
-
/**
|
|
8817
|
-
* 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
|
|
8818
|
-
* @summary Get a list of orders.
|
|
8819
|
-
* @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
|
|
8820
|
-
* @param {*} [options] Override http request option.
|
|
8821
|
-
* @deprecated
|
|
8822
|
-
* @throws {RequiredError}
|
|
8823
|
-
* @memberof OrdersApi
|
|
8824
|
-
*/
|
|
8825
|
-
listOrders(requestParameters?: OrdersApiListOrdersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponse, any>>;
|
|
8826
8594
|
/**
|
|
8827
8595
|
* Get a list of orders (V3)
|
|
8828
8596
|
* @summary Get a list of orders (V3)
|
|
@@ -8926,6 +8694,31 @@ interface ProjectsApiGetProjectsRequest {
|
|
|
8926
8694
|
*/
|
|
8927
8695
|
readonly direction?: string;
|
|
8928
8696
|
}
|
|
8697
|
+
/**
|
|
8698
|
+
* Request parameters for getSdkVersion operation in ProjectsApi.
|
|
8699
|
+
* @export
|
|
8700
|
+
* @interface ProjectsApiGetSdkVersionRequest
|
|
8701
|
+
*/
|
|
8702
|
+
interface ProjectsApiGetSdkVersionRequest {
|
|
8703
|
+
/**
|
|
8704
|
+
* Runtime Details
|
|
8705
|
+
* @type {string}
|
|
8706
|
+
* @memberof ProjectsApiGetSdkVersion
|
|
8707
|
+
*/
|
|
8708
|
+
readonly details: string;
|
|
8709
|
+
/**
|
|
8710
|
+
* SDK Version
|
|
8711
|
+
* @type {string}
|
|
8712
|
+
* @memberof ProjectsApiGetSdkVersion
|
|
8713
|
+
*/
|
|
8714
|
+
readonly version?: string;
|
|
8715
|
+
/**
|
|
8716
|
+
* Runtime ID
|
|
8717
|
+
* @type {string}
|
|
8718
|
+
* @memberof ProjectsApiGetSdkVersion
|
|
8719
|
+
*/
|
|
8720
|
+
readonly id?: string;
|
|
8721
|
+
}
|
|
8929
8722
|
/**
|
|
8930
8723
|
* ProjectsApi - object-oriented interface
|
|
8931
8724
|
* @export
|
|
@@ -8938,6 +8731,7 @@ declare class ProjectsApi extends BaseAPI {
|
|
|
8938
8731
|
* @summary Create a project
|
|
8939
8732
|
* @param {ProjectsApiCreateProjectRequest} requestParameters Request parameters.
|
|
8940
8733
|
* @param {*} [options] Override http request option.
|
|
8734
|
+
* @deprecated
|
|
8941
8735
|
* @throws {RequiredError}
|
|
8942
8736
|
* @memberof ProjectsApi
|
|
8943
8737
|
*/
|
|
@@ -8960,6 +8754,15 @@ declare class ProjectsApi extends BaseAPI {
|
|
|
8960
8754
|
* @memberof ProjectsApi
|
|
8961
8755
|
*/
|
|
8962
8756
|
getProjects(requestParameters: ProjectsApiGetProjectsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetProjectsResponse, any>>;
|
|
8757
|
+
/**
|
|
8758
|
+
* Checks the SDK Version of caller against the current SDK Version and returns a message.
|
|
8759
|
+
* @summary Checks the SDK Version of caller against the current SDK Version
|
|
8760
|
+
* @param {ProjectsApiGetSdkVersionRequest} requestParameters Request parameters.
|
|
8761
|
+
* @param {*} [options] Override http request option.
|
|
8762
|
+
* @throws {RequiredError}
|
|
8763
|
+
* @memberof ProjectsApi
|
|
8764
|
+
*/
|
|
8765
|
+
getSdkVersion(requestParameters: ProjectsApiGetSdkVersionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ApiSDKVersionCheckResponse, any>>;
|
|
8963
8766
|
}
|
|
8964
8767
|
/**
|
|
8965
8768
|
* Request parameters for getToken operation in TokensApi.
|
|
@@ -9043,37 +8846,6 @@ declare class TokensApi extends BaseAPI {
|
|
|
9043
8846
|
*/
|
|
9044
8847
|
listTokens(requestParameters?: TokensApiListTokensRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTokensResponse, any>>;
|
|
9045
8848
|
}
|
|
9046
|
-
/**
|
|
9047
|
-
* Request parameters for createTrade operation in TradesApi.
|
|
9048
|
-
* @export
|
|
9049
|
-
* @interface TradesApiCreateTradeRequest
|
|
9050
|
-
*/
|
|
9051
|
-
interface TradesApiCreateTradeRequest {
|
|
9052
|
-
/**
|
|
9053
|
-
* create a trade
|
|
9054
|
-
* @type {CreateTradeRequestV1}
|
|
9055
|
-
* @memberof TradesApiCreateTrade
|
|
9056
|
-
*/
|
|
9057
|
-
readonly createTradeRequest: CreateTradeRequestV1;
|
|
9058
|
-
/**
|
|
9059
|
-
* eth address
|
|
9060
|
-
* @type {string}
|
|
9061
|
-
* @memberof TradesApiCreateTrade
|
|
9062
|
-
*/
|
|
9063
|
-
readonly xImxEthAddress?: string;
|
|
9064
|
-
/**
|
|
9065
|
-
* eth signature
|
|
9066
|
-
* @type {string}
|
|
9067
|
-
* @memberof TradesApiCreateTrade
|
|
9068
|
-
*/
|
|
9069
|
-
readonly xImxEthSignature?: string;
|
|
9070
|
-
/**
|
|
9071
|
-
* Authorization header
|
|
9072
|
-
* @type {string}
|
|
9073
|
-
* @memberof TradesApiCreateTrade
|
|
9074
|
-
*/
|
|
9075
|
-
readonly authorization?: string;
|
|
9076
|
-
}
|
|
9077
8849
|
/**
|
|
9078
8850
|
* Request parameters for createTradeV3 operation in TradesApi.
|
|
9079
8851
|
* @export
|
|
@@ -9119,91 +8891,18 @@ interface TradesApiGetSignableTradeRequest {
|
|
|
9119
8891
|
readonly getSignableTradeRequest: GetSignableTradeRequest;
|
|
9120
8892
|
}
|
|
9121
8893
|
/**
|
|
9122
|
-
* Request parameters for
|
|
8894
|
+
* Request parameters for getTradeV3 operation in TradesApi.
|
|
9123
8895
|
* @export
|
|
9124
|
-
* @interface
|
|
8896
|
+
* @interface TradesApiGetTradeV3Request
|
|
9125
8897
|
*/
|
|
9126
|
-
interface
|
|
8898
|
+
interface TradesApiGetTradeV3Request {
|
|
9127
8899
|
/**
|
|
9128
8900
|
* Trade ID
|
|
9129
8901
|
* @type {string}
|
|
9130
|
-
* @memberof
|
|
8902
|
+
* @memberof TradesApiGetTradeV3
|
|
9131
8903
|
*/
|
|
9132
8904
|
readonly id: string;
|
|
9133
8905
|
}
|
|
9134
|
-
/**
|
|
9135
|
-
* Request parameters for listTrades operation in TradesApi.
|
|
9136
|
-
* @export
|
|
9137
|
-
* @interface TradesApiListTradesRequest
|
|
9138
|
-
*/
|
|
9139
|
-
interface TradesApiListTradesRequest {
|
|
9140
|
-
/**
|
|
9141
|
-
* Party A\'s (buy order) token type of currency used to buy
|
|
9142
|
-
* @type {string}
|
|
9143
|
-
* @memberof TradesApiListTrades
|
|
9144
|
-
*/
|
|
9145
|
-
readonly partyATokenType?: string;
|
|
9146
|
-
/**
|
|
9147
|
-
* Party A\'s (buy order) token address of currency used to buy
|
|
9148
|
-
* @type {string}
|
|
9149
|
-
* @memberof TradesApiListTrades
|
|
9150
|
-
*/
|
|
9151
|
-
readonly partyATokenAddress?: string;
|
|
9152
|
-
/**
|
|
9153
|
-
* Party B\'s (sell order) token type of NFT sold - always ERC721
|
|
9154
|
-
* @type {string}
|
|
9155
|
-
* @memberof TradesApiListTrades
|
|
9156
|
-
*/
|
|
9157
|
-
readonly partyBTokenType?: string;
|
|
9158
|
-
/**
|
|
9159
|
-
* Party B\'s (sell order) collection address of NFT sold
|
|
9160
|
-
* @type {string}
|
|
9161
|
-
* @memberof TradesApiListTrades
|
|
9162
|
-
*/
|
|
9163
|
-
readonly partyBTokenAddress?: string;
|
|
9164
|
-
/**
|
|
9165
|
-
* Party B\'s (sell order) token id of NFT sold
|
|
9166
|
-
* @type {string}
|
|
9167
|
-
* @memberof TradesApiListTrades
|
|
9168
|
-
*/
|
|
9169
|
-
readonly partyBTokenId?: string;
|
|
9170
|
-
/**
|
|
9171
|
-
* Page size of the result
|
|
9172
|
-
* @type {number}
|
|
9173
|
-
* @memberof TradesApiListTrades
|
|
9174
|
-
*/
|
|
9175
|
-
readonly pageSize?: number;
|
|
9176
|
-
/**
|
|
9177
|
-
* Cursor
|
|
9178
|
-
* @type {string}
|
|
9179
|
-
* @memberof TradesApiListTrades
|
|
9180
|
-
*/
|
|
9181
|
-
readonly cursor?: string;
|
|
9182
|
-
/**
|
|
9183
|
-
* Property to sort by
|
|
9184
|
-
* @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
|
|
9185
|
-
* @memberof TradesApiListTrades
|
|
9186
|
-
*/
|
|
9187
|
-
readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
|
|
9188
|
-
/**
|
|
9189
|
-
* Direction to sort (asc/desc)
|
|
9190
|
-
* @type {string}
|
|
9191
|
-
* @memberof TradesApiListTrades
|
|
9192
|
-
*/
|
|
9193
|
-
readonly direction?: string;
|
|
9194
|
-
/**
|
|
9195
|
-
* Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
9196
|
-
* @type {string}
|
|
9197
|
-
* @memberof TradesApiListTrades
|
|
9198
|
-
*/
|
|
9199
|
-
readonly minTimestamp?: string;
|
|
9200
|
-
/**
|
|
9201
|
-
* Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
9202
|
-
* @type {string}
|
|
9203
|
-
* @memberof TradesApiListTrades
|
|
9204
|
-
*/
|
|
9205
|
-
readonly maxTimestamp?: string;
|
|
9206
|
-
}
|
|
9207
8906
|
/**
|
|
9208
8907
|
* Request parameters for listTradesV3 operation in TradesApi.
|
|
9209
8908
|
* @export
|
|
@@ -9265,13 +8964,13 @@ interface TradesApiListTradesV3Request {
|
|
|
9265
8964
|
*/
|
|
9266
8965
|
readonly direction?: string;
|
|
9267
8966
|
/**
|
|
9268
|
-
* Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-
|
|
8967
|
+
* Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-06-27T00:10:22Z\'
|
|
9269
8968
|
* @type {string}
|
|
9270
8969
|
* @memberof TradesApiListTradesV3
|
|
9271
8970
|
*/
|
|
9272
8971
|
readonly minTimestamp?: string;
|
|
9273
8972
|
/**
|
|
9274
|
-
* Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-
|
|
8973
|
+
* Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-06-27T00:10:22Z\'
|
|
9275
8974
|
* @type {string}
|
|
9276
8975
|
* @memberof TradesApiListTradesV3
|
|
9277
8976
|
*/
|
|
@@ -9285,17 +8984,7 @@ interface TradesApiListTradesV3Request {
|
|
|
9285
8984
|
*/
|
|
9286
8985
|
declare class TradesApi extends BaseAPI {
|
|
9287
8986
|
/**
|
|
9288
|
-
* Create a
|
|
9289
|
-
* @summary Create a Trade between two parties
|
|
9290
|
-
* @param {TradesApiCreateTradeRequest} requestParameters Request parameters.
|
|
9291
|
-
* @param {*} [options] Override http request option.
|
|
9292
|
-
* @deprecated
|
|
9293
|
-
* @throws {RequiredError}
|
|
9294
|
-
* @memberof TradesApi
|
|
9295
|
-
*/
|
|
9296
|
-
createTrade(requestParameters: TradesApiCreateTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
|
|
9297
|
-
/**
|
|
9298
|
-
* Create a Trade. Currently only buy order is supported.
|
|
8987
|
+
* Create a Trade.
|
|
9299
8988
|
* @summary Create a Trade (V3)
|
|
9300
8989
|
* @param {TradesApiCreateTradeV3Request} requestParameters Request parameters.
|
|
9301
8990
|
* @param {*} [options] Override http request option.
|
|
@@ -9315,22 +9004,12 @@ declare class TradesApi extends BaseAPI {
|
|
|
9315
9004
|
/**
|
|
9316
9005
|
* Get details of a trade with the given ID
|
|
9317
9006
|
* @summary Get details of a trade with the given ID
|
|
9318
|
-
* @param {
|
|
9319
|
-
* @param {*} [options] Override http request option.
|
|
9320
|
-
* @throws {RequiredError}
|
|
9321
|
-
* @memberof TradesApi
|
|
9322
|
-
*/
|
|
9323
|
-
getTrade(requestParameters: TradesApiGetTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
|
|
9324
|
-
/**
|
|
9325
|
-
* 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
|
|
9326
|
-
* @summary Get a list of trades
|
|
9327
|
-
* @param {TradesApiListTradesRequest} requestParameters Request parameters.
|
|
9007
|
+
* @param {TradesApiGetTradeV3Request} requestParameters Request parameters.
|
|
9328
9008
|
* @param {*} [options] Override http request option.
|
|
9329
|
-
* @deprecated
|
|
9330
9009
|
* @throws {RequiredError}
|
|
9331
9010
|
* @memberof TradesApi
|
|
9332
9011
|
*/
|
|
9333
|
-
|
|
9012
|
+
getTradeV3(requestParameters: TradesApiGetTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
|
|
9334
9013
|
/**
|
|
9335
9014
|
* Get a list of trades (V3)
|
|
9336
9015
|
* @summary Get a list of trades (V3)
|
|
@@ -9411,10 +9090,10 @@ interface TransfersApiCreateTransferV1Request {
|
|
|
9411
9090
|
interface TransfersApiGetSignableTransferRequest {
|
|
9412
9091
|
/**
|
|
9413
9092
|
* get details of signable transfer
|
|
9414
|
-
* @type {
|
|
9093
|
+
* @type {GetSignableTransferRequestV2}
|
|
9415
9094
|
* @memberof TransfersApiGetSignableTransfer
|
|
9416
9095
|
*/
|
|
9417
|
-
readonly getSignableTransferRequestV2:
|
|
9096
|
+
readonly getSignableTransferRequestV2: GetSignableTransferRequestV2;
|
|
9418
9097
|
}
|
|
9419
9098
|
/**
|
|
9420
9099
|
* Request parameters for getSignableTransferV1 operation in TransfersApi.
|
|
@@ -9424,10 +9103,10 @@ interface TransfersApiGetSignableTransferRequest {
|
|
|
9424
9103
|
interface TransfersApiGetSignableTransferV1Request {
|
|
9425
9104
|
/**
|
|
9426
9105
|
* get details of signable transfer
|
|
9427
|
-
* @type {
|
|
9106
|
+
* @type {GetSignableTransferRequest}
|
|
9428
9107
|
* @memberof TransfersApiGetSignableTransferV1
|
|
9429
9108
|
*/
|
|
9430
|
-
readonly getSignableTransferRequest:
|
|
9109
|
+
readonly getSignableTransferRequest: GetSignableTransferRequest;
|
|
9431
9110
|
}
|
|
9432
9111
|
/**
|
|
9433
9112
|
* Request parameters for getTransfer operation in TransfersApi.
|
|
@@ -9462,10 +9141,10 @@ interface TransfersApiListTransfersRequest {
|
|
|
9462
9141
|
readonly cursor?: string;
|
|
9463
9142
|
/**
|
|
9464
9143
|
* Property to sort by
|
|
9465
|
-
* @type {'transaction_id' | '
|
|
9144
|
+
* @type {'transaction_id' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key'}
|
|
9466
9145
|
* @memberof TransfersApiListTransfers
|
|
9467
9146
|
*/
|
|
9468
|
-
readonly orderBy?: 'transaction_id' | '
|
|
9147
|
+
readonly orderBy?: 'transaction_id' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key';
|
|
9469
9148
|
/**
|
|
9470
9149
|
* Direction to sort (asc/desc)
|
|
9471
9150
|
* @type {string}
|
|
@@ -9566,7 +9245,7 @@ declare class TransfersApi extends BaseAPI {
|
|
|
9566
9245
|
* @throws {RequiredError}
|
|
9567
9246
|
* @memberof TransfersApi
|
|
9568
9247
|
*/
|
|
9569
|
-
createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<
|
|
9248
|
+
createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponseV2, any>>;
|
|
9570
9249
|
/**
|
|
9571
9250
|
* Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransferV1 to get request body params.
|
|
9572
9251
|
* @summary Creates a transfer of tokens between two parties
|
|
@@ -9584,7 +9263,7 @@ declare class TransfersApi extends BaseAPI {
|
|
|
9584
9263
|
* @throws {RequiredError}
|
|
9585
9264
|
* @memberof TransfersApi
|
|
9586
9265
|
*/
|
|
9587
|
-
getSignableTransfer(requestParameters: TransfersApiGetSignableTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<
|
|
9266
|
+
getSignableTransfer(requestParameters: TransfersApiGetSignableTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTransferResponseV2, any>>;
|
|
9588
9267
|
/**
|
|
9589
9268
|
* Gets details of a signable transfer
|
|
9590
9269
|
* @summary Gets details of a signable transfer
|
|
@@ -9726,7 +9405,7 @@ declare class UsersApi extends BaseAPI {
|
|
|
9726
9405
|
* @throws {RequiredError}
|
|
9727
9406
|
* @memberof UsersApi
|
|
9728
9407
|
*/
|
|
9729
|
-
registerPassportUser(requestParameters: UsersApiRegisterPassportUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<
|
|
9408
|
+
registerPassportUser(requestParameters: UsersApiRegisterPassportUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<RegisterPassportUserResult, any>>;
|
|
9730
9409
|
/**
|
|
9731
9410
|
* Registers a user
|
|
9732
9411
|
* @summary Registers a user
|
|
@@ -9911,7 +9590,7 @@ interface WithdrawalsApiListWithdrawalsRequest {
|
|
|
9911
9590
|
*/
|
|
9912
9591
|
declare class WithdrawalsApi extends BaseAPI {
|
|
9913
9592
|
/**
|
|
9914
|
-
* Creates a withdrawal.
|
|
9593
|
+
* Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
|
|
9915
9594
|
* @summary Creates a withdrawal of a token
|
|
9916
9595
|
* @param {WithdrawalsApiCreateWithdrawalRequest} requestParameters Request parameters.
|
|
9917
9596
|
* @param {*} [options] Override http request option.
|
|
@@ -10061,10 +9740,14 @@ declare enum Environment {
|
|
|
10061
9740
|
}
|
|
10062
9741
|
declare class ImmutableConfiguration {
|
|
10063
9742
|
readonly environment: Environment;
|
|
9743
|
+
readonly rateLimitingKey?: string;
|
|
10064
9744
|
readonly apiKey?: string;
|
|
9745
|
+
readonly clientAppId?: string;
|
|
10065
9746
|
constructor(options: {
|
|
10066
9747
|
environment: Environment;
|
|
9748
|
+
rateLimitingKey?: string;
|
|
10067
9749
|
apiKey?: string;
|
|
9750
|
+
clientAppId?: string;
|
|
10068
9751
|
});
|
|
10069
9752
|
}
|
|
10070
9753
|
interface ModuleConfiguration<T> {
|
|
@@ -10315,28 +9998,28 @@ declare class ImmutableXClient {
|
|
|
10315
9998
|
* @returns a promise that resolves with the requested Order
|
|
10316
9999
|
* @throws {@link index.IMXError}
|
|
10317
10000
|
*/
|
|
10318
|
-
getOrder(request:
|
|
10001
|
+
getOrder(request: OrdersApiGetOrderV3Request): Promise<OrderV3>;
|
|
10319
10002
|
/**
|
|
10320
10003
|
* Get a list of Orders
|
|
10321
10004
|
* @param request - optional object containing the parameters to be provided in the API request
|
|
10322
10005
|
* @returns a promise that resolves with the requested list of Orders
|
|
10323
10006
|
* @throws {@link index.IMXError}
|
|
10324
10007
|
*/
|
|
10325
|
-
listOrders(request?:
|
|
10008
|
+
listOrders(request?: OrdersApiListOrdersV3Request): Promise<ListOrdersResponseV3>;
|
|
10326
10009
|
/**
|
|
10327
10010
|
* Get details of a Trade with the given ID
|
|
10328
10011
|
* @param request - the request object containing the parameters to be provided in the API request
|
|
10329
10012
|
* @returns a promise that resolves with the requested Trade
|
|
10330
10013
|
* @throws {@link index.IMXError}
|
|
10331
10014
|
*/
|
|
10332
|
-
getTrade(request:
|
|
10015
|
+
getTrade(request: TradesApiGetTradeV3Request): Promise<Trade>;
|
|
10333
10016
|
/**
|
|
10334
10017
|
* Get a list of Trades
|
|
10335
10018
|
* @param request - optional object containing the parameters to be provided in the API request
|
|
10336
10019
|
* @returns a promise that resolves with the requested list of Trades
|
|
10337
10020
|
* @throws {@link index.IMXError}
|
|
10338
10021
|
*/
|
|
10339
|
-
listTrades(request?:
|
|
10022
|
+
listTrades(request?: TradesApiListTradesV3Request): Promise<ListTradesResponse>;
|
|
10340
10023
|
/**
|
|
10341
10024
|
* Get details of a Token
|
|
10342
10025
|
* @param request - the request object containing the parameters to be provided in the API request
|