@imtbl/sdk 0.28.1-alpha → 0.28.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/blockchain_data.d.ts +4 -0
- package/dist/blockchain_data.js +1 -1
- package/dist/browser/checkout.js +2 -2
- package/dist/checkout_sdk.d.ts +856 -1141
- package/dist/checkout_sdk.js +23 -4
- package/dist/checkout_widgets.d.ts +856 -1141
- package/dist/checkout_widgets.js +1 -1
- 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 +2 -1
- package/dist/index.browser.js +53 -53
- package/dist/index.browser.js.map +1 -1
- package/dist/index.cjs +82 -53
- package/dist/index.d.ts +859 -1144
- package/dist/index.js +82 -53
- package/dist/orderbook.d.ts +4 -0
- package/dist/passport.d.ts +856 -1141
- package/dist/passport.js +57 -49
- package/dist/provider.d.ts +4 -0
- package/dist/provider.js +3 -0
- package/package.json +2 -2
- package/dist/global.d.ts +0 -42
package/dist/checkout_sdk.d.ts
CHANGED
|
@@ -554,10 +554,14 @@ declare enum Environment {
|
|
|
554
554
|
}
|
|
555
555
|
declare class ImmutableConfiguration {
|
|
556
556
|
readonly environment: Environment;
|
|
557
|
+
readonly rateLimitingKey?: string;
|
|
557
558
|
readonly apiKey?: string;
|
|
559
|
+
readonly clientAppId?: string;
|
|
558
560
|
constructor(options: {
|
|
559
561
|
environment: Environment;
|
|
562
|
+
rateLimitingKey?: string;
|
|
560
563
|
apiKey?: string;
|
|
564
|
+
clientAppId?: string;
|
|
561
565
|
});
|
|
562
566
|
}
|
|
563
567
|
interface ModuleConfiguration<T> {
|
|
@@ -1122,6 +1126,25 @@ interface CollectionDetails {
|
|
|
1122
1126
|
'name': string;
|
|
1123
1127
|
}
|
|
1124
1128
|
|
|
1129
|
+
/**
|
|
1130
|
+
* Immutable X API
|
|
1131
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1132
|
+
*
|
|
1133
|
+
* The version of the OpenAPI document: 3.0
|
|
1134
|
+
* Contact: support@immutable.com
|
|
1135
|
+
*
|
|
1136
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1137
|
+
* https://openapi-generator.tech
|
|
1138
|
+
* Do not edit the class manually.
|
|
1139
|
+
*/
|
|
1140
|
+
|
|
1141
|
+
/**
|
|
1142
|
+
* @type AssetPropertiesCollection
|
|
1143
|
+
* Details of this asset\'s collection
|
|
1144
|
+
* @export
|
|
1145
|
+
*/
|
|
1146
|
+
declare type AssetPropertiesCollection = CollectionDetails;
|
|
1147
|
+
|
|
1125
1148
|
/**
|
|
1126
1149
|
* Immutable X API
|
|
1127
1150
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -1142,10 +1165,10 @@ interface CollectionDetails {
|
|
|
1142
1165
|
interface AssetProperties {
|
|
1143
1166
|
/**
|
|
1144
1167
|
*
|
|
1145
|
-
* @type {
|
|
1168
|
+
* @type {AssetPropertiesCollection}
|
|
1146
1169
|
* @memberof AssetProperties
|
|
1147
1170
|
*/
|
|
1148
|
-
'collection'?:
|
|
1171
|
+
'collection'?: AssetPropertiesCollection;
|
|
1149
1172
|
/**
|
|
1150
1173
|
* Image URL of this asset
|
|
1151
1174
|
* @type {string}
|
|
@@ -1329,6 +1352,25 @@ interface FeeData {
|
|
|
1329
1352
|
'decimals'?: number;
|
|
1330
1353
|
}
|
|
1331
1354
|
|
|
1355
|
+
/**
|
|
1356
|
+
* Immutable X API
|
|
1357
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1358
|
+
*
|
|
1359
|
+
* The version of the OpenAPI document: 3.0
|
|
1360
|
+
* Contact: support@immutable.com
|
|
1361
|
+
*
|
|
1362
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1363
|
+
* https://openapi-generator.tech
|
|
1364
|
+
* Do not edit the class manually.
|
|
1365
|
+
*/
|
|
1366
|
+
|
|
1367
|
+
/**
|
|
1368
|
+
* @type FeeTokenData
|
|
1369
|
+
* Fee token data details
|
|
1370
|
+
* @export
|
|
1371
|
+
*/
|
|
1372
|
+
declare type FeeTokenData = FeeData;
|
|
1373
|
+
|
|
1332
1374
|
/**
|
|
1333
1375
|
* Immutable X API
|
|
1334
1376
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -1349,10 +1391,10 @@ interface FeeData {
|
|
|
1349
1391
|
interface FeeToken$1 {
|
|
1350
1392
|
/**
|
|
1351
1393
|
*
|
|
1352
|
-
* @type {
|
|
1394
|
+
* @type {FeeTokenData}
|
|
1353
1395
|
* @memberof FeeToken
|
|
1354
1396
|
*/
|
|
1355
|
-
'data'?:
|
|
1397
|
+
'data'?: FeeTokenData;
|
|
1356
1398
|
/**
|
|
1357
1399
|
* Fee token type. One of ETH/ERC20
|
|
1358
1400
|
* @type {string}
|
|
@@ -1486,29 +1528,48 @@ interface ApiRegisterPassportUserRequest {
|
|
|
1486
1528
|
/**
|
|
1487
1529
|
*
|
|
1488
1530
|
* @export
|
|
1489
|
-
* @interface
|
|
1531
|
+
* @interface ApiSDKVersionCheckResponse
|
|
1490
1532
|
*/
|
|
1491
|
-
interface
|
|
1533
|
+
interface ApiSDKVersionCheckResponse {
|
|
1492
1534
|
/**
|
|
1493
|
-
*
|
|
1535
|
+
*
|
|
1494
1536
|
* @type {string}
|
|
1495
|
-
* @memberof
|
|
1537
|
+
* @memberof ApiSDKVersionCheckResponse
|
|
1496
1538
|
*/
|
|
1497
|
-
'
|
|
1539
|
+
'message'?: string;
|
|
1498
1540
|
/**
|
|
1499
|
-
*
|
|
1500
|
-
* @type {
|
|
1501
|
-
* @memberof
|
|
1541
|
+
*
|
|
1542
|
+
* @type {boolean}
|
|
1543
|
+
* @memberof ApiSDKVersionCheckResponse
|
|
1502
1544
|
*/
|
|
1503
|
-
'
|
|
1545
|
+
'ok'?: boolean;
|
|
1504
1546
|
/**
|
|
1505
|
-
*
|
|
1547
|
+
*
|
|
1506
1548
|
* @type {string}
|
|
1507
|
-
* @memberof
|
|
1549
|
+
* @memberof ApiSDKVersionCheckResponse
|
|
1508
1550
|
*/
|
|
1509
|
-
'
|
|
1551
|
+
'runtimeId'?: string;
|
|
1510
1552
|
}
|
|
1511
1553
|
|
|
1554
|
+
/**
|
|
1555
|
+
* Immutable X API
|
|
1556
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1557
|
+
*
|
|
1558
|
+
* The version of the OpenAPI document: 3.0
|
|
1559
|
+
* Contact: support@immutable.com
|
|
1560
|
+
*
|
|
1561
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1562
|
+
* https://openapi-generator.tech
|
|
1563
|
+
* Do not edit the class manually.
|
|
1564
|
+
*/
|
|
1565
|
+
|
|
1566
|
+
/**
|
|
1567
|
+
* @type AssetCollection
|
|
1568
|
+
* Information about the collection to which this asset belongs
|
|
1569
|
+
* @export
|
|
1570
|
+
*/
|
|
1571
|
+
declare type AssetCollection = CollectionDetails;
|
|
1572
|
+
|
|
1512
1573
|
/**
|
|
1513
1574
|
* Immutable X API
|
|
1514
1575
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -1540,6 +1601,62 @@ interface OrderDetails {
|
|
|
1540
1601
|
'sell_orders'?: Array<object>;
|
|
1541
1602
|
}
|
|
1542
1603
|
|
|
1604
|
+
/**
|
|
1605
|
+
* Immutable X API
|
|
1606
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1607
|
+
*
|
|
1608
|
+
* The version of the OpenAPI document: 3.0
|
|
1609
|
+
* Contact: support@immutable.com
|
|
1610
|
+
*
|
|
1611
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1612
|
+
* https://openapi-generator.tech
|
|
1613
|
+
* Do not edit the class manually.
|
|
1614
|
+
*/
|
|
1615
|
+
|
|
1616
|
+
/**
|
|
1617
|
+
* @type AssetOrders
|
|
1618
|
+
* [DEPRECATED] Open orders for this asset will always return empty. Use GET /orders
|
|
1619
|
+
* @export
|
|
1620
|
+
*/
|
|
1621
|
+
declare type AssetOrders = OrderDetails;
|
|
1622
|
+
|
|
1623
|
+
/**
|
|
1624
|
+
* Immutable X API
|
|
1625
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1626
|
+
*
|
|
1627
|
+
* The version of the OpenAPI document: 3.0
|
|
1628
|
+
* Contact: support@immutable.com
|
|
1629
|
+
*
|
|
1630
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1631
|
+
* https://openapi-generator.tech
|
|
1632
|
+
* Do not edit the class manually.
|
|
1633
|
+
*/
|
|
1634
|
+
/**
|
|
1635
|
+
*
|
|
1636
|
+
* @export
|
|
1637
|
+
* @interface Fee
|
|
1638
|
+
*/
|
|
1639
|
+
interface Fee$1 {
|
|
1640
|
+
/**
|
|
1641
|
+
* Wallet address
|
|
1642
|
+
* @type {string}
|
|
1643
|
+
* @memberof Fee
|
|
1644
|
+
*/
|
|
1645
|
+
'address': string;
|
|
1646
|
+
/**
|
|
1647
|
+
* The percentage of fee
|
|
1648
|
+
* @type {number}
|
|
1649
|
+
* @memberof Fee
|
|
1650
|
+
*/
|
|
1651
|
+
'percentage': number;
|
|
1652
|
+
/**
|
|
1653
|
+
* Type of fee. Examples: `royalty`, `maker`, `taker` or `protocol`
|
|
1654
|
+
* @type {string}
|
|
1655
|
+
* @memberof Fee
|
|
1656
|
+
*/
|
|
1657
|
+
'type': string;
|
|
1658
|
+
}
|
|
1659
|
+
|
|
1543
1660
|
/**
|
|
1544
1661
|
* Immutable X API
|
|
1545
1662
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -1560,10 +1677,10 @@ interface OrderDetails {
|
|
|
1560
1677
|
interface Asset {
|
|
1561
1678
|
/**
|
|
1562
1679
|
*
|
|
1563
|
-
* @type {
|
|
1680
|
+
* @type {AssetCollection}
|
|
1564
1681
|
* @memberof Asset
|
|
1565
1682
|
*/
|
|
1566
|
-
'collection':
|
|
1683
|
+
'collection': AssetCollection;
|
|
1567
1684
|
/**
|
|
1568
1685
|
* Timestamp of when the asset was created
|
|
1569
1686
|
* @type {string}
|
|
@@ -1608,10 +1725,10 @@ interface Asset {
|
|
|
1608
1725
|
'name': string | null;
|
|
1609
1726
|
/**
|
|
1610
1727
|
*
|
|
1611
|
-
* @type {
|
|
1728
|
+
* @type {AssetOrders}
|
|
1612
1729
|
* @memberof Asset
|
|
1613
1730
|
*/
|
|
1614
|
-
'orders'?:
|
|
1731
|
+
'orders'?: AssetOrders;
|
|
1615
1732
|
/**
|
|
1616
1733
|
* Status of this asset (where it is in the system)
|
|
1617
1734
|
* @type {string}
|
|
@@ -1650,6 +1767,44 @@ interface Asset {
|
|
|
1650
1767
|
'user': string;
|
|
1651
1768
|
}
|
|
1652
1769
|
|
|
1770
|
+
/**
|
|
1771
|
+
* Immutable X API
|
|
1772
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1773
|
+
*
|
|
1774
|
+
* The version of the OpenAPI document: 3.0
|
|
1775
|
+
* Contact: support@immutable.com
|
|
1776
|
+
*
|
|
1777
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1778
|
+
* https://openapi-generator.tech
|
|
1779
|
+
* Do not edit the class manually.
|
|
1780
|
+
*/
|
|
1781
|
+
|
|
1782
|
+
/**
|
|
1783
|
+
* @type AssetWithOrdersCollection
|
|
1784
|
+
* Information about the collection to which this asset belongs
|
|
1785
|
+
* @export
|
|
1786
|
+
*/
|
|
1787
|
+
declare type AssetWithOrdersCollection = CollectionDetails;
|
|
1788
|
+
|
|
1789
|
+
/**
|
|
1790
|
+
* Immutable X API
|
|
1791
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1792
|
+
*
|
|
1793
|
+
* The version of the OpenAPI document: 3.0
|
|
1794
|
+
* Contact: support@immutable.com
|
|
1795
|
+
*
|
|
1796
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1797
|
+
* https://openapi-generator.tech
|
|
1798
|
+
* Do not edit the class manually.
|
|
1799
|
+
*/
|
|
1800
|
+
|
|
1801
|
+
/**
|
|
1802
|
+
* @type AssetWithOrdersOrders
|
|
1803
|
+
* Open orders for this asset
|
|
1804
|
+
* @export
|
|
1805
|
+
*/
|
|
1806
|
+
declare type AssetWithOrdersOrders = OrderDetails;
|
|
1807
|
+
|
|
1653
1808
|
/**
|
|
1654
1809
|
* Immutable X API
|
|
1655
1810
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -1670,10 +1825,10 @@ interface Asset {
|
|
|
1670
1825
|
interface AssetWithOrders {
|
|
1671
1826
|
/**
|
|
1672
1827
|
*
|
|
1673
|
-
* @type {
|
|
1828
|
+
* @type {AssetWithOrdersCollection}
|
|
1674
1829
|
* @memberof AssetWithOrders
|
|
1675
1830
|
*/
|
|
1676
|
-
'collection':
|
|
1831
|
+
'collection': AssetWithOrdersCollection;
|
|
1677
1832
|
/**
|
|
1678
1833
|
* Timestamp of when the asset was created
|
|
1679
1834
|
* @type {string}
|
|
@@ -1718,10 +1873,10 @@ interface AssetWithOrders {
|
|
|
1718
1873
|
'name': string | null;
|
|
1719
1874
|
/**
|
|
1720
1875
|
*
|
|
1721
|
-
* @type {
|
|
1876
|
+
* @type {AssetWithOrdersOrders}
|
|
1722
1877
|
* @memberof AssetWithOrders
|
|
1723
1878
|
*/
|
|
1724
|
-
'orders'?:
|
|
1879
|
+
'orders'?: AssetWithOrdersOrders;
|
|
1725
1880
|
/**
|
|
1726
1881
|
* Status of this asset (where it is in the system)
|
|
1727
1882
|
* @type {string}
|
|
@@ -1981,6 +2136,25 @@ interface Range {
|
|
|
1981
2136
|
'min'?: number;
|
|
1982
2137
|
}
|
|
1983
2138
|
|
|
2139
|
+
/**
|
|
2140
|
+
* Immutable X API
|
|
2141
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2142
|
+
*
|
|
2143
|
+
* The version of the OpenAPI document: 3.0
|
|
2144
|
+
* Contact: support@immutable.com
|
|
2145
|
+
*
|
|
2146
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2147
|
+
* https://openapi-generator.tech
|
|
2148
|
+
* Do not edit the class manually.
|
|
2149
|
+
*/
|
|
2150
|
+
|
|
2151
|
+
/**
|
|
2152
|
+
* @type CollectionFilterRange
|
|
2153
|
+
* Range of values for this property
|
|
2154
|
+
* @export
|
|
2155
|
+
*/
|
|
2156
|
+
declare type CollectionFilterRange = Range;
|
|
2157
|
+
|
|
1984
2158
|
/**
|
|
1985
2159
|
* Immutable X API
|
|
1986
2160
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -2007,10 +2181,10 @@ interface CollectionFilter {
|
|
|
2007
2181
|
'key'?: string;
|
|
2008
2182
|
/**
|
|
2009
2183
|
*
|
|
2010
|
-
* @type {
|
|
2184
|
+
* @type {CollectionFilterRange}
|
|
2011
2185
|
* @memberof CollectionFilter
|
|
2012
2186
|
*/
|
|
2013
|
-
'range'?:
|
|
2187
|
+
'range'?: CollectionFilterRange;
|
|
2014
2188
|
/**
|
|
2015
2189
|
* Type of this filter
|
|
2016
2190
|
* @type {string}
|
|
@@ -2332,98 +2506,6 @@ interface FeeEntry {
|
|
|
2332
2506
|
'fee_percentage'?: number;
|
|
2333
2507
|
}
|
|
2334
2508
|
|
|
2335
|
-
/**
|
|
2336
|
-
* Immutable X API
|
|
2337
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2338
|
-
*
|
|
2339
|
-
* The version of the OpenAPI document: 3.0
|
|
2340
|
-
* Contact: support@immutable.com
|
|
2341
|
-
*
|
|
2342
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2343
|
-
* https://openapi-generator.tech
|
|
2344
|
-
* Do not edit the class manually.
|
|
2345
|
-
*/
|
|
2346
|
-
|
|
2347
|
-
/**
|
|
2348
|
-
*
|
|
2349
|
-
* @export
|
|
2350
|
-
* @interface CreateOrderRequest
|
|
2351
|
-
*/
|
|
2352
|
-
interface CreateOrderRequest {
|
|
2353
|
-
/**
|
|
2354
|
-
* Amount to buy
|
|
2355
|
-
* @type {string}
|
|
2356
|
-
* @memberof CreateOrderRequest
|
|
2357
|
-
*/
|
|
2358
|
-
'amount_buy': string;
|
|
2359
|
-
/**
|
|
2360
|
-
* Amount to sell
|
|
2361
|
-
* @type {string}
|
|
2362
|
-
* @memberof CreateOrderRequest
|
|
2363
|
-
*/
|
|
2364
|
-
'amount_sell': string;
|
|
2365
|
-
/**
|
|
2366
|
-
* ID of the asset to buy
|
|
2367
|
-
* @type {string}
|
|
2368
|
-
* @memberof CreateOrderRequest
|
|
2369
|
-
*/
|
|
2370
|
-
'asset_id_buy': string;
|
|
2371
|
-
/**
|
|
2372
|
-
* ID of the asset to sell
|
|
2373
|
-
* @type {string}
|
|
2374
|
-
* @memberof CreateOrderRequest
|
|
2375
|
-
*/
|
|
2376
|
-
'asset_id_sell': string;
|
|
2377
|
-
/**
|
|
2378
|
-
* Expiration timestamp for this order
|
|
2379
|
-
* @type {number}
|
|
2380
|
-
* @memberof CreateOrderRequest
|
|
2381
|
-
*/
|
|
2382
|
-
'expiration_timestamp': number;
|
|
2383
|
-
/**
|
|
2384
|
-
* Fee information
|
|
2385
|
-
* @type {Array<FeeEntry>}
|
|
2386
|
-
* @memberof CreateOrderRequest
|
|
2387
|
-
*/
|
|
2388
|
-
'fees'?: Array<FeeEntry>;
|
|
2389
|
-
/**
|
|
2390
|
-
* Whether to include fees in order
|
|
2391
|
-
* @type {boolean}
|
|
2392
|
-
* @memberof CreateOrderRequest
|
|
2393
|
-
*/
|
|
2394
|
-
'include_fees'?: boolean;
|
|
2395
|
-
/**
|
|
2396
|
-
* Nonce of the order
|
|
2397
|
-
* @type {number}
|
|
2398
|
-
* @memberof CreateOrderRequest
|
|
2399
|
-
*/
|
|
2400
|
-
'nonce': number;
|
|
2401
|
-
/**
|
|
2402
|
-
* Public stark key of the user creating order
|
|
2403
|
-
* @type {string}
|
|
2404
|
-
* @memberof CreateOrderRequest
|
|
2405
|
-
*/
|
|
2406
|
-
'stark_key': string;
|
|
2407
|
-
/**
|
|
2408
|
-
* Payload signature
|
|
2409
|
-
* @type {string}
|
|
2410
|
-
* @memberof CreateOrderRequest
|
|
2411
|
-
*/
|
|
2412
|
-
'stark_signature': string;
|
|
2413
|
-
/**
|
|
2414
|
-
* ID of the vault into which the bought asset will be placed
|
|
2415
|
-
* @type {number}
|
|
2416
|
-
* @memberof CreateOrderRequest
|
|
2417
|
-
*/
|
|
2418
|
-
'vault_id_buy': number;
|
|
2419
|
-
/**
|
|
2420
|
-
* ID of the vault to sell from
|
|
2421
|
-
* @type {number}
|
|
2422
|
-
* @memberof CreateOrderRequest
|
|
2423
|
-
*/
|
|
2424
|
-
'vault_id_sell': number;
|
|
2425
|
-
}
|
|
2426
|
-
|
|
2427
2509
|
/**
|
|
2428
2510
|
* Immutable X API
|
|
2429
2511
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -2614,11 +2696,11 @@ interface CreateProjectRequest {
|
|
|
2614
2696
|
*/
|
|
2615
2697
|
interface CreateProjectResponse {
|
|
2616
2698
|
/**
|
|
2617
|
-
* The project ID
|
|
2618
|
-
* @type {
|
|
2699
|
+
* The project group ID
|
|
2700
|
+
* @type {string}
|
|
2619
2701
|
* @memberof CreateProjectResponse
|
|
2620
2702
|
*/
|
|
2621
|
-
'id':
|
|
2703
|
+
'id': string;
|
|
2622
2704
|
}
|
|
2623
2705
|
|
|
2624
2706
|
/**
|
|
@@ -2669,133 +2751,10 @@ interface FeeInfo {
|
|
|
2669
2751
|
* https://openapi-generator.tech
|
|
2670
2752
|
* Do not edit the class manually.
|
|
2671
2753
|
*/
|
|
2672
|
-
|
|
2673
2754
|
/**
|
|
2674
|
-
*
|
|
2675
|
-
* Fee details
|
|
2755
|
+
*
|
|
2676
2756
|
* @export
|
|
2677
|
-
|
|
2678
|
-
declare type CreateTradeRequestV1FeeInfo = FeeInfo;
|
|
2679
|
-
|
|
2680
|
-
/**
|
|
2681
|
-
* Immutable X API
|
|
2682
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2683
|
-
*
|
|
2684
|
-
* The version of the OpenAPI document: 3.0
|
|
2685
|
-
* Contact: support@immutable.com
|
|
2686
|
-
*
|
|
2687
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2688
|
-
* https://openapi-generator.tech
|
|
2689
|
-
* Do not edit the class manually.
|
|
2690
|
-
*/
|
|
2691
|
-
|
|
2692
|
-
/**
|
|
2693
|
-
*
|
|
2694
|
-
* @export
|
|
2695
|
-
* @interface CreateTradeRequestV1
|
|
2696
|
-
*/
|
|
2697
|
-
interface CreateTradeRequestV1 {
|
|
2698
|
-
/**
|
|
2699
|
-
* Amount to buy
|
|
2700
|
-
* @type {string}
|
|
2701
|
-
* @memberof CreateTradeRequestV1
|
|
2702
|
-
*/
|
|
2703
|
-
'amount_buy': string;
|
|
2704
|
-
/**
|
|
2705
|
-
* Amount to sell
|
|
2706
|
-
* @type {string}
|
|
2707
|
-
* @memberof CreateTradeRequestV1
|
|
2708
|
-
*/
|
|
2709
|
-
'amount_sell': string;
|
|
2710
|
-
/**
|
|
2711
|
-
* ID of the asset to buy
|
|
2712
|
-
* @type {string}
|
|
2713
|
-
* @memberof CreateTradeRequestV1
|
|
2714
|
-
*/
|
|
2715
|
-
'asset_id_buy': string;
|
|
2716
|
-
/**
|
|
2717
|
-
* ID of the asset to sell
|
|
2718
|
-
* @type {string}
|
|
2719
|
-
* @memberof CreateTradeRequestV1
|
|
2720
|
-
*/
|
|
2721
|
-
'asset_id_sell': string;
|
|
2722
|
-
/**
|
|
2723
|
-
* Expiration timestamp for this trade
|
|
2724
|
-
* @type {number}
|
|
2725
|
-
* @memberof CreateTradeRequestV1
|
|
2726
|
-
*/
|
|
2727
|
-
'expiration_timestamp': number;
|
|
2728
|
-
/**
|
|
2729
|
-
*
|
|
2730
|
-
* @type {CreateTradeRequestV1FeeInfo}
|
|
2731
|
-
* @memberof CreateTradeRequestV1
|
|
2732
|
-
*/
|
|
2733
|
-
'fee_info'?: CreateTradeRequestV1FeeInfo;
|
|
2734
|
-
/**
|
|
2735
|
-
* Fee information
|
|
2736
|
-
* @type {Array<FeeEntry>}
|
|
2737
|
-
* @memberof CreateTradeRequestV1
|
|
2738
|
-
*/
|
|
2739
|
-
'fees'?: Array<FeeEntry>;
|
|
2740
|
-
/**
|
|
2741
|
-
* [deprecated] All orders include fees since the introduction of protocol fees
|
|
2742
|
-
* @type {boolean}
|
|
2743
|
-
* @memberof CreateTradeRequestV1
|
|
2744
|
-
*/
|
|
2745
|
-
'include_fees'?: boolean;
|
|
2746
|
-
/**
|
|
2747
|
-
* Nonce of the trade
|
|
2748
|
-
* @type {number}
|
|
2749
|
-
* @memberof CreateTradeRequestV1
|
|
2750
|
-
*/
|
|
2751
|
-
'nonce': number;
|
|
2752
|
-
/**
|
|
2753
|
-
* ID of the order
|
|
2754
|
-
* @type {number}
|
|
2755
|
-
* @memberof CreateTradeRequestV1
|
|
2756
|
-
*/
|
|
2757
|
-
'order_id': number;
|
|
2758
|
-
/**
|
|
2759
|
-
* Public stark key of the user creating trade
|
|
2760
|
-
* @type {string}
|
|
2761
|
-
* @memberof CreateTradeRequestV1
|
|
2762
|
-
*/
|
|
2763
|
-
'stark_key': string;
|
|
2764
|
-
/**
|
|
2765
|
-
* Payload signature
|
|
2766
|
-
* @type {string}
|
|
2767
|
-
* @memberof CreateTradeRequestV1
|
|
2768
|
-
*/
|
|
2769
|
-
'stark_signature': string;
|
|
2770
|
-
/**
|
|
2771
|
-
* ID of the vault into which the traded asset will be placed
|
|
2772
|
-
* @type {number}
|
|
2773
|
-
* @memberof CreateTradeRequestV1
|
|
2774
|
-
*/
|
|
2775
|
-
'vault_id_buy': number;
|
|
2776
|
-
/**
|
|
2777
|
-
* ID of the vault to sell from
|
|
2778
|
-
* @type {number}
|
|
2779
|
-
* @memberof CreateTradeRequestV1
|
|
2780
|
-
*/
|
|
2781
|
-
'vault_id_sell': number;
|
|
2782
|
-
}
|
|
2783
|
-
|
|
2784
|
-
/**
|
|
2785
|
-
* Immutable X API
|
|
2786
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2787
|
-
*
|
|
2788
|
-
* The version of the OpenAPI document: 3.0
|
|
2789
|
-
* Contact: support@immutable.com
|
|
2790
|
-
*
|
|
2791
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2792
|
-
* https://openapi-generator.tech
|
|
2793
|
-
* Do not edit the class manually.
|
|
2794
|
-
*/
|
|
2795
|
-
/**
|
|
2796
|
-
*
|
|
2797
|
-
* @export
|
|
2798
|
-
* @interface CreateTradeResponse
|
|
2757
|
+
* @interface CreateTradeResponse
|
|
2799
2758
|
*/
|
|
2800
2759
|
interface CreateTradeResponse {
|
|
2801
2760
|
/**
|
|
@@ -3058,6 +3017,31 @@ interface CreateTransferResponseV1 {
|
|
|
3058
3017
|
'transfer_id': number;
|
|
3059
3018
|
}
|
|
3060
3019
|
|
|
3020
|
+
/**
|
|
3021
|
+
* Immutable X API
|
|
3022
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3023
|
+
*
|
|
3024
|
+
* The version of the OpenAPI document: 3.0
|
|
3025
|
+
* Contact: support@immutable.com
|
|
3026
|
+
*
|
|
3027
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3028
|
+
* https://openapi-generator.tech
|
|
3029
|
+
* Do not edit the class manually.
|
|
3030
|
+
*/
|
|
3031
|
+
/**
|
|
3032
|
+
*
|
|
3033
|
+
* @export
|
|
3034
|
+
* @interface CreateTransferResponseV2
|
|
3035
|
+
*/
|
|
3036
|
+
interface CreateTransferResponseV2 {
|
|
3037
|
+
/**
|
|
3038
|
+
* List of transfer IDs
|
|
3039
|
+
* @type {Array<number>}
|
|
3040
|
+
* @memberof CreateTransferResponseV2
|
|
3041
|
+
*/
|
|
3042
|
+
'transfer_ids': Array<number>;
|
|
3043
|
+
}
|
|
3044
|
+
|
|
3061
3045
|
/**
|
|
3062
3046
|
* Immutable X API
|
|
3063
3047
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -3194,6 +3178,25 @@ interface CurrencyWithLimits {
|
|
|
3194
3178
|
'symbol'?: string;
|
|
3195
3179
|
}
|
|
3196
3180
|
|
|
3181
|
+
/**
|
|
3182
|
+
* Immutable X API
|
|
3183
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3184
|
+
*
|
|
3185
|
+
* The version of the OpenAPI document: 3.0
|
|
3186
|
+
* Contact: support@immutable.com
|
|
3187
|
+
*
|
|
3188
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3189
|
+
* https://openapi-generator.tech
|
|
3190
|
+
* Do not edit the class manually.
|
|
3191
|
+
*/
|
|
3192
|
+
|
|
3193
|
+
/**
|
|
3194
|
+
* @type DepositToken
|
|
3195
|
+
* Details of the asset being deposited
|
|
3196
|
+
* @export
|
|
3197
|
+
*/
|
|
3198
|
+
declare type DepositToken = Token;
|
|
3199
|
+
|
|
3197
3200
|
/**
|
|
3198
3201
|
* Immutable X API
|
|
3199
3202
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -3226,10 +3229,10 @@ interface Deposit {
|
|
|
3226
3229
|
'timestamp': string;
|
|
3227
3230
|
/**
|
|
3228
3231
|
*
|
|
3229
|
-
* @type {
|
|
3232
|
+
* @type {DepositToken}
|
|
3230
3233
|
* @memberof Deposit
|
|
3231
3234
|
*/
|
|
3232
|
-
'token':
|
|
3235
|
+
'token': DepositToken;
|
|
3233
3236
|
/**
|
|
3234
3237
|
* Sequential ID of this transaction within Immutable X
|
|
3235
3238
|
* @type {number}
|
|
@@ -3737,65 +3740,29 @@ interface GetMetadataRefreshes {
|
|
|
3737
3740
|
*/
|
|
3738
3741
|
interface Project {
|
|
3739
3742
|
/**
|
|
3740
|
-
* The
|
|
3741
|
-
* @type {string}
|
|
3742
|
-
* @memberof Project
|
|
3743
|
-
*/
|
|
3744
|
-
'collection_limit_expires_at': string;
|
|
3745
|
-
/**
|
|
3746
|
-
* The total monthly collection limit
|
|
3747
|
-
* @type {number}
|
|
3748
|
-
* @memberof Project
|
|
3749
|
-
*/
|
|
3750
|
-
'collection_monthly_limit': number;
|
|
3751
|
-
/**
|
|
3752
|
-
* The number of collection remaining in the current period
|
|
3753
|
-
* @type {number}
|
|
3754
|
-
* @memberof Project
|
|
3755
|
-
*/
|
|
3756
|
-
'collection_remaining': number;
|
|
3757
|
-
/**
|
|
3758
|
-
* The company name
|
|
3743
|
+
* The project ChainType
|
|
3759
3744
|
* @type {string}
|
|
3760
3745
|
* @memberof Project
|
|
3761
3746
|
*/
|
|
3762
|
-
'
|
|
3747
|
+
'chain_type'?: string;
|
|
3763
3748
|
/**
|
|
3764
|
-
* The project
|
|
3749
|
+
* The project group ID
|
|
3765
3750
|
* @type {string}
|
|
3766
3751
|
* @memberof Project
|
|
3767
3752
|
*/
|
|
3768
|
-
'
|
|
3769
|
-
/**
|
|
3770
|
-
* The project ID
|
|
3771
|
-
* @type {number}
|
|
3772
|
-
* @memberof Project
|
|
3773
|
-
*/
|
|
3774
|
-
'id': number;
|
|
3753
|
+
'id': string;
|
|
3775
3754
|
/**
|
|
3776
|
-
* The
|
|
3755
|
+
* The project group name
|
|
3777
3756
|
* @type {string}
|
|
3778
3757
|
* @memberof Project
|
|
3779
3758
|
*/
|
|
3780
|
-
'
|
|
3781
|
-
/**
|
|
3782
|
-
* The total monthly mint operation limit
|
|
3783
|
-
* @type {number}
|
|
3784
|
-
* @memberof Project
|
|
3785
|
-
*/
|
|
3786
|
-
'mint_monthly_limit': number;
|
|
3787
|
-
/**
|
|
3788
|
-
* The number of mint operation remaining in the current period
|
|
3789
|
-
* @type {number}
|
|
3790
|
-
* @memberof Project
|
|
3791
|
-
*/
|
|
3792
|
-
'mint_remaining': number;
|
|
3759
|
+
'name': string;
|
|
3793
3760
|
/**
|
|
3794
|
-
* The project
|
|
3761
|
+
* The organisation ID that the project belongs to
|
|
3795
3762
|
* @type {string}
|
|
3796
3763
|
* @memberof Project
|
|
3797
3764
|
*/
|
|
3798
|
-
'
|
|
3765
|
+
'org_id'?: string;
|
|
3799
3766
|
}
|
|
3800
3767
|
|
|
3801
3768
|
/**
|
|
@@ -3890,12 +3857,24 @@ interface GetSignableCancelOrderResponse {
|
|
|
3890
3857
|
* @memberof GetSignableCancelOrderResponse
|
|
3891
3858
|
*/
|
|
3892
3859
|
'payload_hash': string;
|
|
3860
|
+
/**
|
|
3861
|
+
* EIP-712 encoding of the StarkEx cancel order request to be displayed to the user
|
|
3862
|
+
* @type {string}
|
|
3863
|
+
* @memberof GetSignableCancelOrderResponse
|
|
3864
|
+
*/
|
|
3865
|
+
'readable_transaction': string;
|
|
3893
3866
|
/**
|
|
3894
3867
|
* Message to sign from wallet to confirm cancel order
|
|
3895
3868
|
* @type {string}
|
|
3896
3869
|
* @memberof GetSignableCancelOrderResponse
|
|
3897
3870
|
*/
|
|
3898
3871
|
'signable_message': string;
|
|
3872
|
+
/**
|
|
3873
|
+
* IMX signed readable_transaction and payload_hash
|
|
3874
|
+
* @type {string}
|
|
3875
|
+
* @memberof GetSignableCancelOrderResponse
|
|
3876
|
+
*/
|
|
3877
|
+
'verification_signature': string;
|
|
3899
3878
|
}
|
|
3900
3879
|
|
|
3901
3880
|
/**
|
|
@@ -3929,6 +3908,25 @@ interface SignableToken {
|
|
|
3929
3908
|
'type'?: string;
|
|
3930
3909
|
}
|
|
3931
3910
|
|
|
3911
|
+
/**
|
|
3912
|
+
* Immutable X API
|
|
3913
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3914
|
+
*
|
|
3915
|
+
* The version of the OpenAPI document: 3.0
|
|
3916
|
+
* Contact: support@immutable.com
|
|
3917
|
+
*
|
|
3918
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3919
|
+
* https://openapi-generator.tech
|
|
3920
|
+
* Do not edit the class manually.
|
|
3921
|
+
*/
|
|
3922
|
+
|
|
3923
|
+
/**
|
|
3924
|
+
* @type GetSignableDepositRequestToken
|
|
3925
|
+
* Details of the token the user is depositing
|
|
3926
|
+
* @export
|
|
3927
|
+
*/
|
|
3928
|
+
declare type GetSignableDepositRequestToken = SignableToken;
|
|
3929
|
+
|
|
3932
3930
|
/**
|
|
3933
3931
|
* Immutable X API
|
|
3934
3932
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -3955,10 +3953,10 @@ interface GetSignableDepositRequest {
|
|
|
3955
3953
|
'amount': string;
|
|
3956
3954
|
/**
|
|
3957
3955
|
*
|
|
3958
|
-
* @type {
|
|
3956
|
+
* @type {GetSignableDepositRequestToken}
|
|
3959
3957
|
* @memberof GetSignableDepositRequest
|
|
3960
3958
|
*/
|
|
3961
|
-
'token':
|
|
3959
|
+
'token': GetSignableDepositRequestToken;
|
|
3962
3960
|
/**
|
|
3963
3961
|
* User who is depositing
|
|
3964
3962
|
* @type {string}
|
|
@@ -4097,7 +4095,7 @@ interface GetSignableOrderRequestV3 {
|
|
|
4097
4095
|
*/
|
|
4098
4096
|
'fees'?: Array<FeeEntry>;
|
|
4099
4097
|
/**
|
|
4100
|
-
* SplitFees
|
|
4098
|
+
* SplitFees is a deprecated field. It\'s value is ignored.
|
|
4101
4099
|
* @type {boolean}
|
|
4102
4100
|
* @memberof GetSignableOrderRequestV3
|
|
4103
4101
|
*/
|
|
@@ -4207,6 +4205,12 @@ interface GetSignableOrderResponse {
|
|
|
4207
4205
|
* @memberof GetSignableOrderResponse
|
|
4208
4206
|
*/
|
|
4209
4207
|
'payload_hash': string;
|
|
4208
|
+
/**
|
|
4209
|
+
* EIP-712 encoding of the StarkEx order transaction to be displayed to the user
|
|
4210
|
+
* @type {string}
|
|
4211
|
+
* @memberof GetSignableOrderResponse
|
|
4212
|
+
*/
|
|
4213
|
+
'readable_transaction': string;
|
|
4210
4214
|
/**
|
|
4211
4215
|
* Message to sign with L1 wallet to confirm order request
|
|
4212
4216
|
* @type {string}
|
|
@@ -4231,6 +4235,12 @@ interface GetSignableOrderResponse {
|
|
|
4231
4235
|
* @memberof GetSignableOrderResponse
|
|
4232
4236
|
*/
|
|
4233
4237
|
'vault_id_sell': number;
|
|
4238
|
+
/**
|
|
4239
|
+
* IMX signed readable_transaction and payload_hash
|
|
4240
|
+
* @type {string}
|
|
4241
|
+
* @memberof GetSignableOrderResponse
|
|
4242
|
+
*/
|
|
4243
|
+
'verification_signature': string;
|
|
4234
4244
|
}
|
|
4235
4245
|
|
|
4236
4246
|
/**
|
|
@@ -4256,12 +4266,24 @@ interface GetSignableRegistrationOffchainResponse {
|
|
|
4256
4266
|
* @memberof GetSignableRegistrationOffchainResponse
|
|
4257
4267
|
*/
|
|
4258
4268
|
'payload_hash': string;
|
|
4269
|
+
/**
|
|
4270
|
+
* EIP-712 encoding of the StarkEx Register User Offchain request to be displayed to the user
|
|
4271
|
+
* @type {string}
|
|
4272
|
+
* @memberof GetSignableRegistrationOffchainResponse
|
|
4273
|
+
*/
|
|
4274
|
+
'readable_transaction': string;
|
|
4259
4275
|
/**
|
|
4260
4276
|
* Message to sign with L1 wallet to register user offchain
|
|
4261
4277
|
* @type {string}
|
|
4262
4278
|
* @memberof GetSignableRegistrationOffchainResponse
|
|
4263
4279
|
*/
|
|
4264
4280
|
'signable_message': string;
|
|
4281
|
+
/**
|
|
4282
|
+
* IMX signed readable_transaction and payload_hash
|
|
4283
|
+
* @type {string}
|
|
4284
|
+
* @memberof GetSignableRegistrationOffchainResponse
|
|
4285
|
+
*/
|
|
4286
|
+
'verification_signature': string;
|
|
4265
4287
|
}
|
|
4266
4288
|
|
|
4267
4289
|
/**
|
|
@@ -4324,6 +4346,18 @@ interface GetSignableRegistrationResponse {
|
|
|
4324
4346
|
* @memberof GetSignableRegistrationResponse
|
|
4325
4347
|
*/
|
|
4326
4348
|
'payload_hash': string;
|
|
4349
|
+
/**
|
|
4350
|
+
* EIP-712 encoding of the StarkEx Register User request to be displayed to the user
|
|
4351
|
+
* @type {string}
|
|
4352
|
+
* @memberof GetSignableRegistrationResponse
|
|
4353
|
+
*/
|
|
4354
|
+
'readable_transaction': string;
|
|
4355
|
+
/**
|
|
4356
|
+
* IMX signed readable_transaction and payload_hash
|
|
4357
|
+
* @type {string}
|
|
4358
|
+
* @memberof GetSignableRegistrationResponse
|
|
4359
|
+
*/
|
|
4360
|
+
'verification_signature': string;
|
|
4327
4361
|
}
|
|
4328
4362
|
|
|
4329
4363
|
/**
|
|
@@ -4455,6 +4489,12 @@ interface GetSignableTradeResponse {
|
|
|
4455
4489
|
* @memberof GetSignableTradeResponse
|
|
4456
4490
|
*/
|
|
4457
4491
|
'payload_hash': string;
|
|
4492
|
+
/**
|
|
4493
|
+
* EIP-712 encoding of the StarkEx trade transaction to be displayed to the user
|
|
4494
|
+
* @type {string}
|
|
4495
|
+
* @memberof GetSignableTradeResponse
|
|
4496
|
+
*/
|
|
4497
|
+
'readable_transaction': string;
|
|
4458
4498
|
/**
|
|
4459
4499
|
* Message to sign with L1 wallet to confirm trade request
|
|
4460
4500
|
* @type {string}
|
|
@@ -4479,8 +4519,33 @@ interface GetSignableTradeResponse {
|
|
|
4479
4519
|
* @memberof GetSignableTradeResponse
|
|
4480
4520
|
*/
|
|
4481
4521
|
'vault_id_sell': number;
|
|
4522
|
+
/**
|
|
4523
|
+
* IMX signed readable_transaction and payload_hash
|
|
4524
|
+
* @type {string}
|
|
4525
|
+
* @memberof GetSignableTradeResponse
|
|
4526
|
+
*/
|
|
4527
|
+
'verification_signature': string;
|
|
4482
4528
|
}
|
|
4483
4529
|
|
|
4530
|
+
/**
|
|
4531
|
+
* Immutable X API
|
|
4532
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4533
|
+
*
|
|
4534
|
+
* The version of the OpenAPI document: 3.0
|
|
4535
|
+
* Contact: support@immutable.com
|
|
4536
|
+
*
|
|
4537
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4538
|
+
* https://openapi-generator.tech
|
|
4539
|
+
* Do not edit the class manually.
|
|
4540
|
+
*/
|
|
4541
|
+
|
|
4542
|
+
/**
|
|
4543
|
+
* @type GetSignableTransferRequestToken
|
|
4544
|
+
* Token to transfer
|
|
4545
|
+
* @export
|
|
4546
|
+
*/
|
|
4547
|
+
declare type GetSignableTransferRequestToken = SignableToken;
|
|
4548
|
+
|
|
4484
4549
|
/**
|
|
4485
4550
|
* Immutable X API
|
|
4486
4551
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -4496,27 +4561,33 @@ interface GetSignableTradeResponse {
|
|
|
4496
4561
|
/**
|
|
4497
4562
|
*
|
|
4498
4563
|
* @export
|
|
4499
|
-
* @interface
|
|
4564
|
+
* @interface GetSignableTransferRequest
|
|
4500
4565
|
*/
|
|
4501
|
-
interface
|
|
4566
|
+
interface GetSignableTransferRequest {
|
|
4502
4567
|
/**
|
|
4503
4568
|
* Amount of the token to transfer
|
|
4504
4569
|
* @type {string}
|
|
4505
|
-
* @memberof
|
|
4570
|
+
* @memberof GetSignableTransferRequest
|
|
4506
4571
|
*/
|
|
4507
4572
|
'amount': string;
|
|
4508
4573
|
/**
|
|
4509
4574
|
* Ethereum address of the receiving user
|
|
4510
4575
|
* @type {string}
|
|
4511
|
-
* @memberof
|
|
4576
|
+
* @memberof GetSignableTransferRequest
|
|
4512
4577
|
*/
|
|
4513
4578
|
'receiver': string;
|
|
4579
|
+
/**
|
|
4580
|
+
* Ethereum address of the transferring user
|
|
4581
|
+
* @type {string}
|
|
4582
|
+
* @memberof GetSignableTransferRequest
|
|
4583
|
+
*/
|
|
4584
|
+
'sender': string;
|
|
4514
4585
|
/**
|
|
4515
4586
|
*
|
|
4516
|
-
* @type {
|
|
4517
|
-
* @memberof
|
|
4587
|
+
* @type {GetSignableTransferRequestToken}
|
|
4588
|
+
* @memberof GetSignableTransferRequest
|
|
4518
4589
|
*/
|
|
4519
|
-
'token':
|
|
4590
|
+
'token': GetSignableTransferRequestToken;
|
|
4520
4591
|
}
|
|
4521
4592
|
|
|
4522
4593
|
/**
|
|
@@ -4534,23 +4605,54 @@ interface SignableTransferDetails {
|
|
|
4534
4605
|
/**
|
|
4535
4606
|
*
|
|
4536
4607
|
* @export
|
|
4537
|
-
* @interface
|
|
4608
|
+
* @interface GetSignableTransferRequestV1
|
|
4538
4609
|
*/
|
|
4539
|
-
interface
|
|
4610
|
+
interface GetSignableTransferRequestV1 {
|
|
4611
|
+
/**
|
|
4612
|
+
* Amount of the token to transfer
|
|
4613
|
+
* @type {string}
|
|
4614
|
+
* @memberof GetSignableTransferRequestV1
|
|
4615
|
+
*/
|
|
4616
|
+
'amount': string;
|
|
4617
|
+
/**
|
|
4618
|
+
* Ethereum address of the receiving user
|
|
4619
|
+
* @type {string}
|
|
4620
|
+
* @memberof GetSignableTransferRequestV1
|
|
4621
|
+
*/
|
|
4622
|
+
'receiver': string;
|
|
4540
4623
|
/**
|
|
4541
4624
|
* Ethereum address of the transferring user
|
|
4542
4625
|
* @type {string}
|
|
4543
|
-
* @memberof
|
|
4626
|
+
* @memberof GetSignableTransferRequestV1
|
|
4544
4627
|
*/
|
|
4545
|
-
'
|
|
4628
|
+
'sender': string;
|
|
4546
4629
|
/**
|
|
4547
|
-
*
|
|
4548
|
-
* @type {
|
|
4549
|
-
* @memberof
|
|
4630
|
+
*
|
|
4631
|
+
* @type {SignableToken}
|
|
4632
|
+
* @memberof GetSignableTransferRequestV1
|
|
4550
4633
|
*/
|
|
4551
|
-
'
|
|
4634
|
+
'token': SignableToken;
|
|
4552
4635
|
}
|
|
4553
4636
|
|
|
4637
|
+
/**
|
|
4638
|
+
* Immutable X API
|
|
4639
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4640
|
+
*
|
|
4641
|
+
* The version of the OpenAPI document: 3.0
|
|
4642
|
+
* Contact: support@immutable.com
|
|
4643
|
+
*
|
|
4644
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4645
|
+
* https://openapi-generator.tech
|
|
4646
|
+
* Do not edit the class manually.
|
|
4647
|
+
*/
|
|
4648
|
+
|
|
4649
|
+
/**
|
|
4650
|
+
* @type SignableTransferDetailsV2Token
|
|
4651
|
+
* Token to transfer
|
|
4652
|
+
* @export
|
|
4653
|
+
*/
|
|
4654
|
+
declare type SignableTransferDetailsV2Token = SignableToken;
|
|
4655
|
+
|
|
4554
4656
|
/**
|
|
4555
4657
|
* Immutable X API
|
|
4556
4658
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -4566,35 +4668,80 @@ interface GetSignableTransferRequest {
|
|
|
4566
4668
|
/**
|
|
4567
4669
|
*
|
|
4568
4670
|
* @export
|
|
4569
|
-
* @interface
|
|
4671
|
+
* @interface SignableTransferDetailsV2
|
|
4570
4672
|
*/
|
|
4571
|
-
interface
|
|
4673
|
+
interface SignableTransferDetailsV2 {
|
|
4572
4674
|
/**
|
|
4573
4675
|
* Amount of the token to transfer
|
|
4574
4676
|
* @type {string}
|
|
4575
|
-
* @memberof
|
|
4677
|
+
* @memberof SignableTransferDetailsV2
|
|
4576
4678
|
*/
|
|
4577
4679
|
'amount': string;
|
|
4578
4680
|
/**
|
|
4579
4681
|
* Ethereum address of the receiving user
|
|
4580
4682
|
* @type {string}
|
|
4581
|
-
* @memberof
|
|
4683
|
+
* @memberof SignableTransferDetailsV2
|
|
4582
4684
|
*/
|
|
4583
4685
|
'receiver': string;
|
|
4686
|
+
/**
|
|
4687
|
+
*
|
|
4688
|
+
* @type {SignableTransferDetailsV2Token}
|
|
4689
|
+
* @memberof SignableTransferDetailsV2
|
|
4690
|
+
*/
|
|
4691
|
+
'token': SignableTransferDetailsV2Token;
|
|
4692
|
+
}
|
|
4693
|
+
|
|
4694
|
+
/**
|
|
4695
|
+
* Immutable X API
|
|
4696
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4697
|
+
*
|
|
4698
|
+
* The version of the OpenAPI document: 3.0
|
|
4699
|
+
* Contact: support@immutable.com
|
|
4700
|
+
*
|
|
4701
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4702
|
+
* https://openapi-generator.tech
|
|
4703
|
+
* Do not edit the class manually.
|
|
4704
|
+
*/
|
|
4705
|
+
|
|
4706
|
+
/**
|
|
4707
|
+
*
|
|
4708
|
+
* @export
|
|
4709
|
+
* @interface GetSignableTransferRequestV2
|
|
4710
|
+
*/
|
|
4711
|
+
interface GetSignableTransferRequestV2 {
|
|
4584
4712
|
/**
|
|
4585
4713
|
* Ethereum address of the transferring user
|
|
4586
4714
|
* @type {string}
|
|
4587
|
-
* @memberof
|
|
4715
|
+
* @memberof GetSignableTransferRequestV2
|
|
4588
4716
|
*/
|
|
4589
|
-
'
|
|
4717
|
+
'sender_ether_key': string;
|
|
4590
4718
|
/**
|
|
4591
|
-
*
|
|
4592
|
-
* @type {
|
|
4593
|
-
* @memberof
|
|
4719
|
+
* List of signable transfer details
|
|
4720
|
+
* @type {Array<SignableTransferDetailsV2>}
|
|
4721
|
+
* @memberof GetSignableTransferRequestV2
|
|
4594
4722
|
*/
|
|
4595
|
-
'
|
|
4723
|
+
'signable_requests': Array<SignableTransferDetailsV2>;
|
|
4596
4724
|
}
|
|
4597
4725
|
|
|
4726
|
+
/**
|
|
4727
|
+
* Immutable X API
|
|
4728
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4729
|
+
*
|
|
4730
|
+
* The version of the OpenAPI document: 3.0
|
|
4731
|
+
* Contact: support@immutable.com
|
|
4732
|
+
*
|
|
4733
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4734
|
+
* https://openapi-generator.tech
|
|
4735
|
+
* Do not edit the class manually.
|
|
4736
|
+
*/
|
|
4737
|
+
|
|
4738
|
+
/**
|
|
4739
|
+
* @type SignableTransferResponseDetailsToken
|
|
4740
|
+
* Token in request to match in SDK implementation
|
|
4741
|
+
* @export
|
|
4742
|
+
*/
|
|
4743
|
+
declare type SignableTransferResponseDetailsToken = SignableToken;
|
|
4744
|
+
|
|
4598
4745
|
/**
|
|
4599
4746
|
* Immutable X API
|
|
4600
4747
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -4643,6 +4790,12 @@ interface SignableTransferResponseDetails {
|
|
|
4643
4790
|
* @memberof SignableTransferResponseDetails
|
|
4644
4791
|
*/
|
|
4645
4792
|
'payload_hash': string;
|
|
4793
|
+
/**
|
|
4794
|
+
* EIP-712 encoding of the StarkEx transfer request to be displayed to the user
|
|
4795
|
+
* @type {string}
|
|
4796
|
+
* @memberof SignableTransferResponseDetails
|
|
4797
|
+
*/
|
|
4798
|
+
'readable_transaction': string;
|
|
4646
4799
|
/**
|
|
4647
4800
|
* Receiver of the transfer
|
|
4648
4801
|
* @type {string}
|
|
@@ -4663,48 +4816,16 @@ interface SignableTransferResponseDetails {
|
|
|
4663
4816
|
'sender_vault_id': number;
|
|
4664
4817
|
/**
|
|
4665
4818
|
*
|
|
4666
|
-
* @type {
|
|
4819
|
+
* @type {SignableTransferResponseDetailsToken}
|
|
4667
4820
|
* @memberof SignableTransferResponseDetails
|
|
4668
4821
|
*/
|
|
4669
|
-
'token':
|
|
4670
|
-
}
|
|
4671
|
-
|
|
4672
|
-
/**
|
|
4673
|
-
* Immutable X API
|
|
4674
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4675
|
-
*
|
|
4676
|
-
* The version of the OpenAPI document: 3.0
|
|
4677
|
-
* Contact: support@immutable.com
|
|
4678
|
-
*
|
|
4679
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4680
|
-
* https://openapi-generator.tech
|
|
4681
|
-
* Do not edit the class manually.
|
|
4682
|
-
*/
|
|
4683
|
-
|
|
4684
|
-
/**
|
|
4685
|
-
*
|
|
4686
|
-
* @export
|
|
4687
|
-
* @interface GetSignableTransferResponse
|
|
4688
|
-
*/
|
|
4689
|
-
interface GetSignableTransferResponse {
|
|
4690
|
-
/**
|
|
4691
|
-
* Sender of the transfer
|
|
4692
|
-
* @type {string}
|
|
4693
|
-
* @memberof GetSignableTransferResponse
|
|
4694
|
-
*/
|
|
4695
|
-
'sender_stark_key': string;
|
|
4822
|
+
'token': SignableTransferResponseDetailsToken;
|
|
4696
4823
|
/**
|
|
4697
|
-
*
|
|
4824
|
+
* IMX signed readable_transaction and payload_hash
|
|
4698
4825
|
* @type {string}
|
|
4699
|
-
* @memberof
|
|
4700
|
-
*/
|
|
4701
|
-
'signable_message': string;
|
|
4702
|
-
/**
|
|
4703
|
-
* List of transfer responses without the sender stark key
|
|
4704
|
-
* @type {Array<SignableTransferResponseDetails>}
|
|
4705
|
-
* @memberof GetSignableTransferResponse
|
|
4826
|
+
* @memberof SignableTransferResponseDetails
|
|
4706
4827
|
*/
|
|
4707
|
-
'
|
|
4828
|
+
'verification_signature': string;
|
|
4708
4829
|
}
|
|
4709
4830
|
|
|
4710
4831
|
/**
|
|
@@ -4754,6 +4875,12 @@ interface GetSignableTransferResponseV1 {
|
|
|
4754
4875
|
* @memberof GetSignableTransferResponseV1
|
|
4755
4876
|
*/
|
|
4756
4877
|
'payload_hash': string;
|
|
4878
|
+
/**
|
|
4879
|
+
* EIP-712 encoding of the StarkEx transfer transaction to be displayed to the user
|
|
4880
|
+
* @type {string}
|
|
4881
|
+
* @memberof GetSignableTransferResponseV1
|
|
4882
|
+
*/
|
|
4883
|
+
'readable_transaction': string;
|
|
4757
4884
|
/**
|
|
4758
4885
|
* Receiver of the transfer
|
|
4759
4886
|
* @type {string}
|
|
@@ -4784,8 +4911,71 @@ interface GetSignableTransferResponseV1 {
|
|
|
4784
4911
|
* @memberof GetSignableTransferResponseV1
|
|
4785
4912
|
*/
|
|
4786
4913
|
'signable_message': string;
|
|
4914
|
+
/**
|
|
4915
|
+
* IMX signed readable_transaction and payload_hash
|
|
4916
|
+
* @type {string}
|
|
4917
|
+
* @memberof GetSignableTransferResponseV1
|
|
4918
|
+
*/
|
|
4919
|
+
'verification_signature': string;
|
|
4920
|
+
}
|
|
4921
|
+
|
|
4922
|
+
/**
|
|
4923
|
+
* Immutable X API
|
|
4924
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4925
|
+
*
|
|
4926
|
+
* The version of the OpenAPI document: 3.0
|
|
4927
|
+
* Contact: support@immutable.com
|
|
4928
|
+
*
|
|
4929
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4930
|
+
* https://openapi-generator.tech
|
|
4931
|
+
* Do not edit the class manually.
|
|
4932
|
+
*/
|
|
4933
|
+
|
|
4934
|
+
/**
|
|
4935
|
+
*
|
|
4936
|
+
* @export
|
|
4937
|
+
* @interface GetSignableTransferResponseV2
|
|
4938
|
+
*/
|
|
4939
|
+
interface GetSignableTransferResponseV2 {
|
|
4940
|
+
/**
|
|
4941
|
+
* Sender of the transfer
|
|
4942
|
+
* @type {string}
|
|
4943
|
+
* @memberof GetSignableTransferResponseV2
|
|
4944
|
+
*/
|
|
4945
|
+
'sender_stark_key': string;
|
|
4946
|
+
/**
|
|
4947
|
+
* Message to sign with L1 wallet to confirm transfer request
|
|
4948
|
+
* @type {string}
|
|
4949
|
+
* @memberof GetSignableTransferResponseV2
|
|
4950
|
+
*/
|
|
4951
|
+
'signable_message': string;
|
|
4952
|
+
/**
|
|
4953
|
+
* List of transfer responses without the sender stark key
|
|
4954
|
+
* @type {Array<SignableTransferResponseDetails>}
|
|
4955
|
+
* @memberof GetSignableTransferResponseV2
|
|
4956
|
+
*/
|
|
4957
|
+
'signable_responses': Array<SignableTransferResponseDetails>;
|
|
4787
4958
|
}
|
|
4788
4959
|
|
|
4960
|
+
/**
|
|
4961
|
+
* Immutable X API
|
|
4962
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4963
|
+
*
|
|
4964
|
+
* The version of the OpenAPI document: 3.0
|
|
4965
|
+
* Contact: support@immutable.com
|
|
4966
|
+
*
|
|
4967
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4968
|
+
* https://openapi-generator.tech
|
|
4969
|
+
* Do not edit the class manually.
|
|
4970
|
+
*/
|
|
4971
|
+
|
|
4972
|
+
/**
|
|
4973
|
+
* @type GetSignableWithdrawalRequestToken
|
|
4974
|
+
* Token to withdraw
|
|
4975
|
+
* @export
|
|
4976
|
+
*/
|
|
4977
|
+
declare type GetSignableWithdrawalRequestToken = SignableToken;
|
|
4978
|
+
|
|
4789
4979
|
/**
|
|
4790
4980
|
* Immutable X API
|
|
4791
4981
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -4812,10 +5002,10 @@ interface GetSignableWithdrawalRequest {
|
|
|
4812
5002
|
'amount': string;
|
|
4813
5003
|
/**
|
|
4814
5004
|
*
|
|
4815
|
-
* @type {
|
|
5005
|
+
* @type {GetSignableWithdrawalRequestToken}
|
|
4816
5006
|
* @memberof GetSignableWithdrawalRequest
|
|
4817
5007
|
*/
|
|
4818
|
-
'token':
|
|
5008
|
+
'token': GetSignableWithdrawalRequestToken;
|
|
4819
5009
|
/**
|
|
4820
5010
|
* Ethereum address of the user who is making this withdrawal
|
|
4821
5011
|
* @type {string}
|
|
@@ -4865,6 +5055,12 @@ interface GetSignableWithdrawalResponse {
|
|
|
4865
5055
|
* @memberof GetSignableWithdrawalResponse
|
|
4866
5056
|
*/
|
|
4867
5057
|
'payload_hash': string;
|
|
5058
|
+
/**
|
|
5059
|
+
* EIP-712 encoding of the StarkEx withdrawal request to be displayed to the user
|
|
5060
|
+
* @type {string}
|
|
5061
|
+
* @memberof GetSignableWithdrawalResponse
|
|
5062
|
+
*/
|
|
5063
|
+
'readable_transaction': string;
|
|
4868
5064
|
/**
|
|
4869
5065
|
* Message to sign with L1 wallet to verity withdrawal request
|
|
4870
5066
|
* @type {string}
|
|
@@ -4883,6 +5079,12 @@ interface GetSignableWithdrawalResponse {
|
|
|
4883
5079
|
* @memberof GetSignableWithdrawalResponse
|
|
4884
5080
|
*/
|
|
4885
5081
|
'vault_id': number;
|
|
5082
|
+
/**
|
|
5083
|
+
* IMX signed readable_transaction and payload_hash
|
|
5084
|
+
* @type {string}
|
|
5085
|
+
* @memberof GetSignableWithdrawalResponse
|
|
5086
|
+
*/
|
|
5087
|
+
'verification_signature': string;
|
|
4886
5088
|
}
|
|
4887
5089
|
|
|
4888
5090
|
/**
|
|
@@ -5100,6 +5302,25 @@ interface ListDepositsResponse {
|
|
|
5100
5302
|
'result': Array<Deposit>;
|
|
5101
5303
|
}
|
|
5102
5304
|
|
|
5305
|
+
/**
|
|
5306
|
+
* Immutable X API
|
|
5307
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
5308
|
+
*
|
|
5309
|
+
* The version of the OpenAPI document: 3.0
|
|
5310
|
+
* Contact: support@immutable.com
|
|
5311
|
+
*
|
|
5312
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
5313
|
+
* https://openapi-generator.tech
|
|
5314
|
+
* Do not edit the class manually.
|
|
5315
|
+
*/
|
|
5316
|
+
|
|
5317
|
+
/**
|
|
5318
|
+
* @type MintToken
|
|
5319
|
+
* Details of the asset which has been minted
|
|
5320
|
+
* @export
|
|
5321
|
+
*/
|
|
5322
|
+
declare type MintToken = Token;
|
|
5323
|
+
|
|
5103
5324
|
/**
|
|
5104
5325
|
* Immutable X API
|
|
5105
5326
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -5138,10 +5359,10 @@ interface Mint {
|
|
|
5138
5359
|
'timestamp': string;
|
|
5139
5360
|
/**
|
|
5140
5361
|
*
|
|
5141
|
-
* @type {
|
|
5362
|
+
* @type {MintToken}
|
|
5142
5363
|
* @memberof Mint
|
|
5143
5364
|
*/
|
|
5144
|
-
'token':
|
|
5365
|
+
'token': MintToken;
|
|
5145
5366
|
/**
|
|
5146
5367
|
* Sequential ID of transaction in Immutable X
|
|
5147
5368
|
* @type {number}
|
|
@@ -5207,11 +5428,11 @@ interface ListMintsResponse {
|
|
|
5207
5428
|
*/
|
|
5208
5429
|
|
|
5209
5430
|
/**
|
|
5210
|
-
* @type
|
|
5431
|
+
* @type OrderV3Buy
|
|
5211
5432
|
* Details of the asset being bought
|
|
5212
5433
|
* @export
|
|
5213
5434
|
*/
|
|
5214
|
-
declare type
|
|
5435
|
+
declare type OrderV3Buy = Token;
|
|
5215
5436
|
|
|
5216
5437
|
/**
|
|
5217
5438
|
* Immutable X API
|
|
@@ -5226,11 +5447,48 @@ declare type OrderBuy = Token;
|
|
|
5226
5447
|
*/
|
|
5227
5448
|
|
|
5228
5449
|
/**
|
|
5229
|
-
*
|
|
5230
|
-
* Details of the asset being sold
|
|
5450
|
+
*
|
|
5231
5451
|
* @export
|
|
5452
|
+
* @interface OrdersMakerTakerFee
|
|
5232
5453
|
*/
|
|
5233
|
-
|
|
5454
|
+
interface OrdersMakerTakerFee {
|
|
5455
|
+
/**
|
|
5456
|
+
* Number of Decimals supported the fee token
|
|
5457
|
+
* @type {number}
|
|
5458
|
+
* @memberof OrdersMakerTakerFee
|
|
5459
|
+
*/
|
|
5460
|
+
'decimals'?: number;
|
|
5461
|
+
/**
|
|
5462
|
+
* Fees
|
|
5463
|
+
* @type {Array<OrderFeeInfo>}
|
|
5464
|
+
* @memberof OrdersMakerTakerFee
|
|
5465
|
+
*/
|
|
5466
|
+
'fees'?: Array<OrderFeeInfo>;
|
|
5467
|
+
/**
|
|
5468
|
+
* Quantity of this asset with the sum of all fees applied to the asset
|
|
5469
|
+
* @type {string}
|
|
5470
|
+
* @memberof OrdersMakerTakerFee
|
|
5471
|
+
*/
|
|
5472
|
+
'quantity_with_fees': string;
|
|
5473
|
+
/**
|
|
5474
|
+
* Symbol of the fee token
|
|
5475
|
+
* @type {string}
|
|
5476
|
+
* @memberof OrdersMakerTakerFee
|
|
5477
|
+
*/
|
|
5478
|
+
'symbol'?: string;
|
|
5479
|
+
/**
|
|
5480
|
+
* Address of the ERC20 contract for the fee token
|
|
5481
|
+
* @type {string}
|
|
5482
|
+
* @memberof OrdersMakerTakerFee
|
|
5483
|
+
*/
|
|
5484
|
+
'token_address'?: string;
|
|
5485
|
+
/**
|
|
5486
|
+
* Type of the fee token (ETH/ERC20)
|
|
5487
|
+
* @type {string}
|
|
5488
|
+
* @memberof OrdersMakerTakerFee
|
|
5489
|
+
*/
|
|
5490
|
+
'token_type'?: string;
|
|
5491
|
+
}
|
|
5234
5492
|
|
|
5235
5493
|
/**
|
|
5236
5494
|
* Immutable X API
|
|
@@ -5245,201 +5503,8 @@ declare type OrderSell = Token;
|
|
|
5245
5503
|
*/
|
|
5246
5504
|
|
|
5247
5505
|
/**
|
|
5248
|
-
*
|
|
5249
|
-
*
|
|
5250
|
-
* @interface Order
|
|
5251
|
-
*/
|
|
5252
|
-
interface Order {
|
|
5253
|
-
/**
|
|
5254
|
-
* Amount of the asset already sold by this order
|
|
5255
|
-
* @type {string}
|
|
5256
|
-
* @memberof Order
|
|
5257
|
-
*/
|
|
5258
|
-
'amount_sold': string | null;
|
|
5259
|
-
/**
|
|
5260
|
-
*
|
|
5261
|
-
* @type {OrderBuy}
|
|
5262
|
-
* @memberof Order
|
|
5263
|
-
*/
|
|
5264
|
-
'buy': OrderBuy;
|
|
5265
|
-
/**
|
|
5266
|
-
* Expiration timestamp of this order
|
|
5267
|
-
* @type {string}
|
|
5268
|
-
* @memberof Order
|
|
5269
|
-
*/
|
|
5270
|
-
'expiration_timestamp': string | null;
|
|
5271
|
-
/**
|
|
5272
|
-
* Fee information for the order
|
|
5273
|
-
* @type {Array<OrderFeeInfo>}
|
|
5274
|
-
* @memberof Order
|
|
5275
|
-
*/
|
|
5276
|
-
'fees'?: Array<OrderFeeInfo>;
|
|
5277
|
-
/**
|
|
5278
|
-
* ID of the order
|
|
5279
|
-
* @type {number}
|
|
5280
|
-
* @memberof Order
|
|
5281
|
-
*/
|
|
5282
|
-
'order_id': number;
|
|
5283
|
-
/**
|
|
5284
|
-
*
|
|
5285
|
-
* @type {OrderSell}
|
|
5286
|
-
* @memberof Order
|
|
5287
|
-
*/
|
|
5288
|
-
'sell': OrderSell;
|
|
5289
|
-
/**
|
|
5290
|
-
* Status of the order
|
|
5291
|
-
* @type {string}
|
|
5292
|
-
* @memberof Order
|
|
5293
|
-
*/
|
|
5294
|
-
'status': string;
|
|
5295
|
-
/**
|
|
5296
|
-
* Timestamp this order was created
|
|
5297
|
-
* @type {string}
|
|
5298
|
-
* @memberof Order
|
|
5299
|
-
*/
|
|
5300
|
-
'timestamp': string | null;
|
|
5301
|
-
/**
|
|
5302
|
-
* Updated timestamp of this order
|
|
5303
|
-
* @type {string}
|
|
5304
|
-
* @memberof Order
|
|
5305
|
-
*/
|
|
5306
|
-
'updated_timestamp': string | null;
|
|
5307
|
-
/**
|
|
5308
|
-
* Ethereum address of the user who submitted the order
|
|
5309
|
-
* @type {string}
|
|
5310
|
-
* @memberof Order
|
|
5311
|
-
*/
|
|
5312
|
-
'user': string;
|
|
5313
|
-
}
|
|
5314
|
-
|
|
5315
|
-
/**
|
|
5316
|
-
* Immutable X API
|
|
5317
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
5318
|
-
*
|
|
5319
|
-
* The version of the OpenAPI document: 3.0
|
|
5320
|
-
* Contact: support@immutable.com
|
|
5321
|
-
*
|
|
5322
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
5323
|
-
* https://openapi-generator.tech
|
|
5324
|
-
* Do not edit the class manually.
|
|
5325
|
-
*/
|
|
5326
|
-
|
|
5327
|
-
/**
|
|
5328
|
-
*
|
|
5329
|
-
* @export
|
|
5330
|
-
* @interface ListOrdersResponse
|
|
5331
|
-
*/
|
|
5332
|
-
interface ListOrdersResponse {
|
|
5333
|
-
/**
|
|
5334
|
-
* Generated cursor returned by previous query
|
|
5335
|
-
* @type {string}
|
|
5336
|
-
* @memberof ListOrdersResponse
|
|
5337
|
-
*/
|
|
5338
|
-
'cursor': string;
|
|
5339
|
-
/**
|
|
5340
|
-
* Remaining results flag. 1: there are remaining results matching this query, 0: no remaining results
|
|
5341
|
-
* @type {number}
|
|
5342
|
-
* @memberof ListOrdersResponse
|
|
5343
|
-
*/
|
|
5344
|
-
'remaining': number;
|
|
5345
|
-
/**
|
|
5346
|
-
* Orders matching query parameters
|
|
5347
|
-
* @type {Array<Order>}
|
|
5348
|
-
* @memberof ListOrdersResponse
|
|
5349
|
-
*/
|
|
5350
|
-
'result': Array<Order>;
|
|
5351
|
-
}
|
|
5352
|
-
|
|
5353
|
-
/**
|
|
5354
|
-
* Immutable X API
|
|
5355
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
5356
|
-
*
|
|
5357
|
-
* The version of the OpenAPI document: 3.0
|
|
5358
|
-
* Contact: support@immutable.com
|
|
5359
|
-
*
|
|
5360
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
5361
|
-
* https://openapi-generator.tech
|
|
5362
|
-
* Do not edit the class manually.
|
|
5363
|
-
*/
|
|
5364
|
-
|
|
5365
|
-
/**
|
|
5366
|
-
* @type OrderV3Buy
|
|
5367
|
-
* Details of the asset being bought
|
|
5368
|
-
* @export
|
|
5369
|
-
*/
|
|
5370
|
-
declare type OrderV3Buy = Token;
|
|
5371
|
-
|
|
5372
|
-
/**
|
|
5373
|
-
* Immutable X API
|
|
5374
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
5375
|
-
*
|
|
5376
|
-
* The version of the OpenAPI document: 3.0
|
|
5377
|
-
* Contact: support@immutable.com
|
|
5378
|
-
*
|
|
5379
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
5380
|
-
* https://openapi-generator.tech
|
|
5381
|
-
* Do not edit the class manually.
|
|
5382
|
-
*/
|
|
5383
|
-
|
|
5384
|
-
/**
|
|
5385
|
-
*
|
|
5386
|
-
* @export
|
|
5387
|
-
* @interface OrdersMakerTakerFee
|
|
5388
|
-
*/
|
|
5389
|
-
interface OrdersMakerTakerFee {
|
|
5390
|
-
/**
|
|
5391
|
-
* Number of Decimals supported the fee token
|
|
5392
|
-
* @type {number}
|
|
5393
|
-
* @memberof OrdersMakerTakerFee
|
|
5394
|
-
*/
|
|
5395
|
-
'decimals'?: number;
|
|
5396
|
-
/**
|
|
5397
|
-
* Fees
|
|
5398
|
-
* @type {Array<OrderFeeInfo>}
|
|
5399
|
-
* @memberof OrdersMakerTakerFee
|
|
5400
|
-
*/
|
|
5401
|
-
'fees'?: Array<OrderFeeInfo>;
|
|
5402
|
-
/**
|
|
5403
|
-
* Quantity of this asset with the sum of all fees applied to the asset
|
|
5404
|
-
* @type {string}
|
|
5405
|
-
* @memberof OrdersMakerTakerFee
|
|
5406
|
-
*/
|
|
5407
|
-
'quantity_with_fees': string;
|
|
5408
|
-
/**
|
|
5409
|
-
* Symbol of the fee token
|
|
5410
|
-
* @type {string}
|
|
5411
|
-
* @memberof OrdersMakerTakerFee
|
|
5412
|
-
*/
|
|
5413
|
-
'symbol'?: string;
|
|
5414
|
-
/**
|
|
5415
|
-
* Address of the ERC20 contract for the fee token
|
|
5416
|
-
* @type {string}
|
|
5417
|
-
* @memberof OrdersMakerTakerFee
|
|
5418
|
-
*/
|
|
5419
|
-
'token_address'?: string;
|
|
5420
|
-
/**
|
|
5421
|
-
* Type of the fee token (ETH/ERC20)
|
|
5422
|
-
* @type {string}
|
|
5423
|
-
* @memberof OrdersMakerTakerFee
|
|
5424
|
-
*/
|
|
5425
|
-
'token_type'?: string;
|
|
5426
|
-
}
|
|
5427
|
-
|
|
5428
|
-
/**
|
|
5429
|
-
* Immutable X API
|
|
5430
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
5431
|
-
*
|
|
5432
|
-
* The version of the OpenAPI document: 3.0
|
|
5433
|
-
* Contact: support@immutable.com
|
|
5434
|
-
*
|
|
5435
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
5436
|
-
* https://openapi-generator.tech
|
|
5437
|
-
* Do not edit the class manually.
|
|
5438
|
-
*/
|
|
5439
|
-
|
|
5440
|
-
/**
|
|
5441
|
-
* @type OrderV3MakerFees
|
|
5442
|
-
* MakerFees is the information about the fees that needs to be paid by the maker (liquidity)
|
|
5506
|
+
* @type OrderV3MakerFees
|
|
5507
|
+
* MakerFees is the information about the fees that needs to be paid by the maker (liquidity)
|
|
5443
5508
|
* @export
|
|
5444
5509
|
*/
|
|
5445
5510
|
declare type OrderV3MakerFees = OrdersMakerTakerFee;
|
|
@@ -5666,7 +5731,7 @@ interface TokenDetails {
|
|
|
5666
5731
|
*/
|
|
5667
5732
|
'symbol': string;
|
|
5668
5733
|
/**
|
|
5669
|
-
* Address of the
|
|
5734
|
+
* Address of the ERC20 contract
|
|
5670
5735
|
* @type {string}
|
|
5671
5736
|
* @memberof TokenDetails
|
|
5672
5737
|
*/
|
|
@@ -5880,6 +5945,25 @@ interface ListTradesResponse {
|
|
|
5880
5945
|
'result': Array<Trade>;
|
|
5881
5946
|
}
|
|
5882
5947
|
|
|
5948
|
+
/**
|
|
5949
|
+
* Immutable X API
|
|
5950
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
5951
|
+
*
|
|
5952
|
+
* The version of the OpenAPI document: 3.0
|
|
5953
|
+
* Contact: support@immutable.com
|
|
5954
|
+
*
|
|
5955
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
5956
|
+
* https://openapi-generator.tech
|
|
5957
|
+
* Do not edit the class manually.
|
|
5958
|
+
*/
|
|
5959
|
+
|
|
5960
|
+
/**
|
|
5961
|
+
* @type TransferToken
|
|
5962
|
+
* Token transferred by the user
|
|
5963
|
+
* @export
|
|
5964
|
+
*/
|
|
5965
|
+
declare type TransferToken = Token;
|
|
5966
|
+
|
|
5883
5967
|
/**
|
|
5884
5968
|
* Immutable X API
|
|
5885
5969
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -5918,10 +6002,10 @@ interface Transfer {
|
|
|
5918
6002
|
'timestamp': string | null;
|
|
5919
6003
|
/**
|
|
5920
6004
|
*
|
|
5921
|
-
* @type {
|
|
6005
|
+
* @type {TransferToken}
|
|
5922
6006
|
* @memberof Transfer
|
|
5923
6007
|
*/
|
|
5924
|
-
'token':
|
|
6008
|
+
'token': TransferToken;
|
|
5925
6009
|
/**
|
|
5926
6010
|
* Sequential transaction ID
|
|
5927
6011
|
* @type {number}
|
|
@@ -5974,6 +6058,25 @@ interface ListTransfersResponse {
|
|
|
5974
6058
|
'result': Array<Transfer>;
|
|
5975
6059
|
}
|
|
5976
6060
|
|
|
6061
|
+
/**
|
|
6062
|
+
* Immutable X API
|
|
6063
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6064
|
+
*
|
|
6065
|
+
* The version of the OpenAPI document: 3.0
|
|
6066
|
+
* Contact: support@immutable.com
|
|
6067
|
+
*
|
|
6068
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
6069
|
+
* https://openapi-generator.tech
|
|
6070
|
+
* Do not edit the class manually.
|
|
6071
|
+
*/
|
|
6072
|
+
|
|
6073
|
+
/**
|
|
6074
|
+
* @type WithdrawalToken
|
|
6075
|
+
* Details of the asset this user is withdrawing
|
|
6076
|
+
* @export
|
|
6077
|
+
*/
|
|
6078
|
+
declare type WithdrawalToken = Token;
|
|
6079
|
+
|
|
5977
6080
|
/**
|
|
5978
6081
|
* Immutable X API
|
|
5979
6082
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -6018,10 +6121,10 @@ interface Withdrawal {
|
|
|
6018
6121
|
'timestamp': string;
|
|
6019
6122
|
/**
|
|
6020
6123
|
*
|
|
6021
|
-
* @type {
|
|
6124
|
+
* @type {WithdrawalToken}
|
|
6022
6125
|
* @memberof Withdrawal
|
|
6023
6126
|
*/
|
|
6024
|
-
'token':
|
|
6127
|
+
'token': WithdrawalToken;
|
|
6025
6128
|
/**
|
|
6026
6129
|
* Sequential ID of this transaction
|
|
6027
6130
|
* @type {number}
|
|
@@ -6730,6 +6833,43 @@ interface NftprimarytransactionListTransactionsResponse {
|
|
|
6730
6833
|
'result'?: Array<NftprimarytransactionTransactionData>;
|
|
6731
6834
|
}
|
|
6732
6835
|
|
|
6836
|
+
/**
|
|
6837
|
+
* Immutable X API
|
|
6838
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6839
|
+
*
|
|
6840
|
+
* The version of the OpenAPI document: 3.0
|
|
6841
|
+
* Contact: support@immutable.com
|
|
6842
|
+
*
|
|
6843
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
6844
|
+
* https://openapi-generator.tech
|
|
6845
|
+
* Do not edit the class manually.
|
|
6846
|
+
*/
|
|
6847
|
+
/**
|
|
6848
|
+
*
|
|
6849
|
+
* @export
|
|
6850
|
+
* @interface RegisterPassportUserResult
|
|
6851
|
+
*/
|
|
6852
|
+
interface RegisterPassportUserResult {
|
|
6853
|
+
/**
|
|
6854
|
+
* The ether key of the user
|
|
6855
|
+
* @type {string}
|
|
6856
|
+
* @memberof RegisterPassportUserResult
|
|
6857
|
+
*/
|
|
6858
|
+
'ether_key'?: string;
|
|
6859
|
+
/**
|
|
6860
|
+
* The stark key of the user
|
|
6861
|
+
* @type {string}
|
|
6862
|
+
* @memberof RegisterPassportUserResult
|
|
6863
|
+
*/
|
|
6864
|
+
'stark_key'?: string;
|
|
6865
|
+
/**
|
|
6866
|
+
* The admin key of the user
|
|
6867
|
+
* @type {string}
|
|
6868
|
+
* @memberof RegisterPassportUserResult
|
|
6869
|
+
*/
|
|
6870
|
+
'user_admin_key'?: string;
|
|
6871
|
+
}
|
|
6872
|
+
|
|
6733
6873
|
/**
|
|
6734
6874
|
* Immutable X API
|
|
6735
6875
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -8466,43 +8606,6 @@ declare class NftCheckoutPrimaryApi extends BaseAPI {
|
|
|
8466
8606
|
*/
|
|
8467
8607
|
registerNftPrimarySalesContract(requestParameters: NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ContractCreateResponse, any>>;
|
|
8468
8608
|
}
|
|
8469
|
-
/**
|
|
8470
|
-
* Request parameters for cancelOrder operation in OrdersApi.
|
|
8471
|
-
* @export
|
|
8472
|
-
* @interface OrdersApiCancelOrderRequest
|
|
8473
|
-
*/
|
|
8474
|
-
interface OrdersApiCancelOrderRequest {
|
|
8475
|
-
/**
|
|
8476
|
-
* Order ID to cancel
|
|
8477
|
-
* @type {string}
|
|
8478
|
-
* @memberof OrdersApiCancelOrder
|
|
8479
|
-
*/
|
|
8480
|
-
readonly id: string;
|
|
8481
|
-
/**
|
|
8482
|
-
* cancel an order
|
|
8483
|
-
* @type {CancelOrderRequest}
|
|
8484
|
-
* @memberof OrdersApiCancelOrder
|
|
8485
|
-
*/
|
|
8486
|
-
readonly cancelOrderRequest: CancelOrderRequest;
|
|
8487
|
-
/**
|
|
8488
|
-
* eth address
|
|
8489
|
-
* @type {string}
|
|
8490
|
-
* @memberof OrdersApiCancelOrder
|
|
8491
|
-
*/
|
|
8492
|
-
readonly xImxEthAddress?: string;
|
|
8493
|
-
/**
|
|
8494
|
-
* eth signature
|
|
8495
|
-
* @type {string}
|
|
8496
|
-
* @memberof OrdersApiCancelOrder
|
|
8497
|
-
*/
|
|
8498
|
-
readonly xImxEthSignature?: string;
|
|
8499
|
-
/**
|
|
8500
|
-
* Authorization header
|
|
8501
|
-
* @type {string}
|
|
8502
|
-
* @memberof OrdersApiCancelOrder
|
|
8503
|
-
*/
|
|
8504
|
-
readonly authorization?: string;
|
|
8505
|
-
}
|
|
8506
8609
|
/**
|
|
8507
8610
|
* Request parameters for cancelOrderV3 operation in OrdersApi.
|
|
8508
8611
|
* @export
|
|
@@ -8510,379 +8613,123 @@ interface OrdersApiCancelOrderRequest {
|
|
|
8510
8613
|
*/
|
|
8511
8614
|
interface OrdersApiCancelOrderV3Request {
|
|
8512
8615
|
/**
|
|
8513
|
-
* Order ID to cancel
|
|
8514
|
-
* @type {string}
|
|
8515
|
-
* @memberof OrdersApiCancelOrderV3
|
|
8516
|
-
*/
|
|
8517
|
-
readonly id: string;
|
|
8518
|
-
/**
|
|
8519
|
-
* cancel an order
|
|
8520
|
-
* @type {CancelOrderRequest}
|
|
8521
|
-
* @memberof OrdersApiCancelOrderV3
|
|
8522
|
-
*/
|
|
8523
|
-
readonly cancelOrderRequest: CancelOrderRequest;
|
|
8524
|
-
/**
|
|
8525
|
-
* eth address
|
|
8526
|
-
* @type {string}
|
|
8527
|
-
* @memberof OrdersApiCancelOrderV3
|
|
8528
|
-
*/
|
|
8529
|
-
readonly xImxEthAddress?: string;
|
|
8530
|
-
/**
|
|
8531
|
-
* eth signature
|
|
8532
|
-
* @type {string}
|
|
8533
|
-
* @memberof OrdersApiCancelOrderV3
|
|
8534
|
-
*/
|
|
8535
|
-
readonly xImxEthSignature?: string;
|
|
8536
|
-
/**
|
|
8537
|
-
* Authorization header
|
|
8538
|
-
* @type {string}
|
|
8539
|
-
* @memberof OrdersApiCancelOrderV3
|
|
8540
|
-
*/
|
|
8541
|
-
readonly authorization?: string;
|
|
8542
|
-
}
|
|
8543
|
-
/**
|
|
8544
|
-
* Request parameters for createOrder operation in OrdersApi.
|
|
8545
|
-
* @export
|
|
8546
|
-
* @interface OrdersApiCreateOrderRequest
|
|
8547
|
-
*/
|
|
8548
|
-
interface OrdersApiCreateOrderRequest {
|
|
8549
|
-
/**
|
|
8550
|
-
* create an order
|
|
8551
|
-
* @type {CreateOrderRequest}
|
|
8552
|
-
* @memberof OrdersApiCreateOrder
|
|
8553
|
-
*/
|
|
8554
|
-
readonly createOrderRequest: CreateOrderRequest;
|
|
8555
|
-
/**
|
|
8556
|
-
* eth address
|
|
8557
|
-
* @type {string}
|
|
8558
|
-
* @memberof OrdersApiCreateOrder
|
|
8559
|
-
*/
|
|
8560
|
-
readonly xImxEthAddress?: string;
|
|
8561
|
-
/**
|
|
8562
|
-
* eth signature
|
|
8563
|
-
* @type {string}
|
|
8564
|
-
* @memberof OrdersApiCreateOrder
|
|
8565
|
-
*/
|
|
8566
|
-
readonly xImxEthSignature?: string;
|
|
8567
|
-
/**
|
|
8568
|
-
* Authorization header
|
|
8569
|
-
* @type {string}
|
|
8570
|
-
* @memberof OrdersApiCreateOrder
|
|
8571
|
-
*/
|
|
8572
|
-
readonly authorization?: string;
|
|
8573
|
-
}
|
|
8574
|
-
/**
|
|
8575
|
-
* Request parameters for createOrderV3 operation in OrdersApi.
|
|
8576
|
-
* @export
|
|
8577
|
-
* @interface OrdersApiCreateOrderV3Request
|
|
8578
|
-
*/
|
|
8579
|
-
interface OrdersApiCreateOrderV3Request {
|
|
8580
|
-
/**
|
|
8581
|
-
* create an order
|
|
8582
|
-
* @type {CreateOrderRequestV3}
|
|
8583
|
-
* @memberof OrdersApiCreateOrderV3
|
|
8584
|
-
*/
|
|
8585
|
-
readonly createOrderRequest: CreateOrderRequestV3;
|
|
8586
|
-
/**
|
|
8587
|
-
* eth address
|
|
8588
|
-
* @type {string}
|
|
8589
|
-
* @memberof OrdersApiCreateOrderV3
|
|
8590
|
-
*/
|
|
8591
|
-
readonly xImxEthAddress?: string;
|
|
8592
|
-
/**
|
|
8593
|
-
* eth signature
|
|
8594
|
-
* @type {string}
|
|
8595
|
-
* @memberof OrdersApiCreateOrderV3
|
|
8596
|
-
*/
|
|
8597
|
-
readonly xImxEthSignature?: string;
|
|
8598
|
-
/**
|
|
8599
|
-
* Authorization header
|
|
8600
|
-
* @type {string}
|
|
8601
|
-
* @memberof OrdersApiCreateOrderV3
|
|
8602
|
-
*/
|
|
8603
|
-
readonly authorization?: string;
|
|
8604
|
-
}
|
|
8605
|
-
/**
|
|
8606
|
-
* Request parameters for getOrder operation in OrdersApi.
|
|
8607
|
-
* @export
|
|
8608
|
-
* @interface OrdersApiGetOrderRequest
|
|
8609
|
-
*/
|
|
8610
|
-
interface OrdersApiGetOrderRequest {
|
|
8611
|
-
/**
|
|
8612
|
-
* Order ID
|
|
8613
|
-
* @type {string}
|
|
8614
|
-
* @memberof OrdersApiGetOrder
|
|
8615
|
-
*/
|
|
8616
|
-
readonly id: string;
|
|
8617
|
-
/**
|
|
8618
|
-
* Set flag to true to include fee body for the order
|
|
8619
|
-
* @type {boolean}
|
|
8620
|
-
* @memberof OrdersApiGetOrder
|
|
8621
|
-
*/
|
|
8622
|
-
readonly includeFees?: boolean;
|
|
8623
|
-
/**
|
|
8624
|
-
* Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
|
|
8625
|
-
* @type {string}
|
|
8626
|
-
* @memberof OrdersApiGetOrder
|
|
8627
|
-
*/
|
|
8628
|
-
readonly auxiliaryFeePercentages?: string;
|
|
8629
|
-
/**
|
|
8630
|
-
* Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
|
|
8631
|
-
* @type {string}
|
|
8632
|
-
* @memberof OrdersApiGetOrder
|
|
8633
|
-
*/
|
|
8634
|
-
readonly auxiliaryFeeRecipients?: string;
|
|
8635
|
-
}
|
|
8636
|
-
/**
|
|
8637
|
-
* Request parameters for getOrderV3 operation in OrdersApi.
|
|
8638
|
-
* @export
|
|
8639
|
-
* @interface OrdersApiGetOrderV3Request
|
|
8640
|
-
*/
|
|
8641
|
-
interface OrdersApiGetOrderV3Request {
|
|
8642
|
-
/**
|
|
8643
|
-
* Order ID
|
|
8644
|
-
* @type {string}
|
|
8645
|
-
* @memberof OrdersApiGetOrderV3
|
|
8646
|
-
*/
|
|
8647
|
-
readonly id: string;
|
|
8648
|
-
/**
|
|
8649
|
-
* Set flag to true to include fee body for the order
|
|
8650
|
-
* @type {boolean}
|
|
8651
|
-
* @memberof OrdersApiGetOrderV3
|
|
8652
|
-
*/
|
|
8653
|
-
readonly includeFees?: boolean;
|
|
8654
|
-
/**
|
|
8655
|
-
* Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
|
|
8656
|
-
* @type {string}
|
|
8657
|
-
* @memberof OrdersApiGetOrderV3
|
|
8658
|
-
*/
|
|
8659
|
-
readonly auxiliaryFeePercentages?: string;
|
|
8660
|
-
/**
|
|
8661
|
-
* Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
|
|
8662
|
-
* @type {string}
|
|
8663
|
-
* @memberof OrdersApiGetOrderV3
|
|
8664
|
-
*/
|
|
8665
|
-
readonly auxiliaryFeeRecipients?: string;
|
|
8666
|
-
}
|
|
8667
|
-
/**
|
|
8668
|
-
* Request parameters for getSignableCancelOrder operation in OrdersApi.
|
|
8669
|
-
* @export
|
|
8670
|
-
* @interface OrdersApiGetSignableCancelOrderRequest
|
|
8671
|
-
*/
|
|
8672
|
-
interface OrdersApiGetSignableCancelOrderRequest {
|
|
8673
|
-
/**
|
|
8674
|
-
* get a signable cancel order
|
|
8675
|
-
* @type {GetSignableCancelOrderRequest}
|
|
8676
|
-
* @memberof OrdersApiGetSignableCancelOrder
|
|
8677
|
-
*/
|
|
8678
|
-
readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
|
|
8679
|
-
}
|
|
8680
|
-
/**
|
|
8681
|
-
* Request parameters for getSignableCancelOrderV3 operation in OrdersApi.
|
|
8682
|
-
* @export
|
|
8683
|
-
* @interface OrdersApiGetSignableCancelOrderV3Request
|
|
8684
|
-
*/
|
|
8685
|
-
interface OrdersApiGetSignableCancelOrderV3Request {
|
|
8686
|
-
/**
|
|
8687
|
-
* get a signable cancel order
|
|
8688
|
-
* @type {GetSignableCancelOrderRequest}
|
|
8689
|
-
* @memberof OrdersApiGetSignableCancelOrderV3
|
|
8690
|
-
*/
|
|
8691
|
-
readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
|
|
8692
|
-
}
|
|
8693
|
-
/**
|
|
8694
|
-
* Request parameters for getSignableOrder operation in OrdersApi.
|
|
8695
|
-
* @export
|
|
8696
|
-
* @interface OrdersApiGetSignableOrderRequest
|
|
8697
|
-
*/
|
|
8698
|
-
interface OrdersApiGetSignableOrderRequest {
|
|
8699
|
-
/**
|
|
8700
|
-
* get a signable order v3
|
|
8701
|
-
* @type {GetSignableOrderRequestV3}
|
|
8702
|
-
* @memberof OrdersApiGetSignableOrder
|
|
8703
|
-
*/
|
|
8704
|
-
readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
|
|
8705
|
-
}
|
|
8706
|
-
/**
|
|
8707
|
-
* Request parameters for listOrders operation in OrdersApi.
|
|
8708
|
-
* @export
|
|
8709
|
-
* @interface OrdersApiListOrdersRequest
|
|
8710
|
-
*/
|
|
8711
|
-
interface OrdersApiListOrdersRequest {
|
|
8712
|
-
/**
|
|
8713
|
-
* Page size of the result
|
|
8714
|
-
* @type {number}
|
|
8715
|
-
* @memberof OrdersApiListOrders
|
|
8716
|
-
*/
|
|
8717
|
-
readonly pageSize?: number;
|
|
8718
|
-
/**
|
|
8719
|
-
* Cursor
|
|
8720
|
-
* @type {string}
|
|
8721
|
-
* @memberof OrdersApiListOrders
|
|
8722
|
-
*/
|
|
8723
|
-
readonly cursor?: string;
|
|
8724
|
-
/**
|
|
8725
|
-
* Property to sort by
|
|
8726
|
-
* @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
|
|
8727
|
-
* @memberof OrdersApiListOrders
|
|
8728
|
-
*/
|
|
8729
|
-
readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
|
|
8730
|
-
/**
|
|
8731
|
-
* Direction to sort (asc/desc)
|
|
8732
|
-
* @type {string}
|
|
8733
|
-
* @memberof OrdersApiListOrders
|
|
8734
|
-
*/
|
|
8735
|
-
readonly direction?: string;
|
|
8736
|
-
/**
|
|
8737
|
-
* Ethereum address of the user who submitted this order
|
|
8738
|
-
* @type {string}
|
|
8739
|
-
* @memberof OrdersApiListOrders
|
|
8740
|
-
*/
|
|
8741
|
-
readonly user?: string;
|
|
8742
|
-
/**
|
|
8743
|
-
* Status of this order
|
|
8744
|
-
* @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
|
|
8745
|
-
* @memberof OrdersApiListOrders
|
|
8746
|
-
*/
|
|
8747
|
-
readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
|
|
8748
|
-
/**
|
|
8749
|
-
* Filter orders to include those with created_at timestamps after this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
8750
|
-
* @type {string}
|
|
8751
|
-
* @memberof OrdersApiListOrders
|
|
8752
|
-
*/
|
|
8753
|
-
readonly minTimestamp?: string;
|
|
8754
|
-
/**
|
|
8755
|
-
* Filter orders to include those with created_at timestamps before this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
8756
|
-
* @type {string}
|
|
8757
|
-
* @memberof OrdersApiListOrders
|
|
8758
|
-
*/
|
|
8759
|
-
readonly maxTimestamp?: string;
|
|
8760
|
-
/**
|
|
8761
|
-
* Filter orders to include those with updated_at timestamps after this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
8762
|
-
* @type {string}
|
|
8763
|
-
* @memberof OrdersApiListOrders
|
|
8764
|
-
*/
|
|
8765
|
-
readonly updatedMinTimestamp?: string;
|
|
8766
|
-
/**
|
|
8767
|
-
* Filter orders to include those with updated_at timestamps before this time, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
8768
|
-
* @type {string}
|
|
8769
|
-
* @memberof OrdersApiListOrders
|
|
8770
|
-
*/
|
|
8771
|
-
readonly updatedMaxTimestamp?: string;
|
|
8772
|
-
/**
|
|
8773
|
-
* Token type of the asset this order buys
|
|
8774
|
-
* @type {string}
|
|
8775
|
-
* @memberof OrdersApiListOrders
|
|
8776
|
-
*/
|
|
8777
|
-
readonly buyTokenType?: string;
|
|
8778
|
-
/**
|
|
8779
|
-
* ERC721 Token ID of the asset this order buys
|
|
8780
|
-
* @type {string}
|
|
8781
|
-
* @memberof OrdersApiListOrders
|
|
8782
|
-
*/
|
|
8783
|
-
readonly buyTokenId?: string;
|
|
8784
|
-
/**
|
|
8785
|
-
* Internal IMX ID of the asset this order buys
|
|
8786
|
-
* @type {string}
|
|
8787
|
-
* @memberof OrdersApiListOrders
|
|
8788
|
-
*/
|
|
8789
|
-
readonly buyAssetId?: string;
|
|
8790
|
-
/**
|
|
8791
|
-
* Token address of the asset this order buys
|
|
8792
|
-
* @type {string}
|
|
8793
|
-
* @memberof OrdersApiListOrders
|
|
8794
|
-
*/
|
|
8795
|
-
readonly buyTokenAddress?: string;
|
|
8796
|
-
/**
|
|
8797
|
-
* Token name of the asset this order buys
|
|
8798
|
-
* @type {string}
|
|
8799
|
-
* @memberof OrdersApiListOrders
|
|
8800
|
-
*/
|
|
8801
|
-
readonly buyTokenName?: string;
|
|
8802
|
-
/**
|
|
8803
|
-
* Min quantity for the asset this order buys
|
|
8616
|
+
* Order ID to cancel
|
|
8804
8617
|
* @type {string}
|
|
8805
|
-
* @memberof
|
|
8618
|
+
* @memberof OrdersApiCancelOrderV3
|
|
8806
8619
|
*/
|
|
8807
|
-
readonly
|
|
8620
|
+
readonly id: string;
|
|
8808
8621
|
/**
|
|
8809
|
-
*
|
|
8810
|
-
* @type {
|
|
8811
|
-
* @memberof
|
|
8622
|
+
* cancel an order
|
|
8623
|
+
* @type {CancelOrderRequest}
|
|
8624
|
+
* @memberof OrdersApiCancelOrderV3
|
|
8812
8625
|
*/
|
|
8813
|
-
readonly
|
|
8626
|
+
readonly cancelOrderRequest: CancelOrderRequest;
|
|
8814
8627
|
/**
|
|
8815
|
-
*
|
|
8628
|
+
* eth address
|
|
8816
8629
|
* @type {string}
|
|
8817
|
-
* @memberof
|
|
8630
|
+
* @memberof OrdersApiCancelOrderV3
|
|
8818
8631
|
*/
|
|
8819
|
-
readonly
|
|
8632
|
+
readonly xImxEthAddress?: string;
|
|
8820
8633
|
/**
|
|
8821
|
-
*
|
|
8634
|
+
* eth signature
|
|
8822
8635
|
* @type {string}
|
|
8823
|
-
* @memberof
|
|
8636
|
+
* @memberof OrdersApiCancelOrderV3
|
|
8824
8637
|
*/
|
|
8825
|
-
readonly
|
|
8638
|
+
readonly xImxEthSignature?: string;
|
|
8826
8639
|
/**
|
|
8827
|
-
*
|
|
8640
|
+
* Authorization header
|
|
8828
8641
|
* @type {string}
|
|
8829
|
-
* @memberof
|
|
8642
|
+
* @memberof OrdersApiCancelOrderV3
|
|
8830
8643
|
*/
|
|
8831
|
-
readonly
|
|
8644
|
+
readonly authorization?: string;
|
|
8645
|
+
}
|
|
8646
|
+
/**
|
|
8647
|
+
* Request parameters for createOrderV3 operation in OrdersApi.
|
|
8648
|
+
* @export
|
|
8649
|
+
* @interface OrdersApiCreateOrderV3Request
|
|
8650
|
+
*/
|
|
8651
|
+
interface OrdersApiCreateOrderV3Request {
|
|
8832
8652
|
/**
|
|
8833
|
-
*
|
|
8834
|
-
* @type {
|
|
8835
|
-
* @memberof
|
|
8653
|
+
* create an order
|
|
8654
|
+
* @type {CreateOrderRequestV3}
|
|
8655
|
+
* @memberof OrdersApiCreateOrderV3
|
|
8836
8656
|
*/
|
|
8837
|
-
readonly
|
|
8657
|
+
readonly createOrderRequest: CreateOrderRequestV3;
|
|
8838
8658
|
/**
|
|
8839
|
-
*
|
|
8659
|
+
* eth address
|
|
8840
8660
|
* @type {string}
|
|
8841
|
-
* @memberof
|
|
8661
|
+
* @memberof OrdersApiCreateOrderV3
|
|
8842
8662
|
*/
|
|
8843
|
-
readonly
|
|
8663
|
+
readonly xImxEthAddress?: string;
|
|
8844
8664
|
/**
|
|
8845
|
-
*
|
|
8665
|
+
* eth signature
|
|
8846
8666
|
* @type {string}
|
|
8847
|
-
* @memberof
|
|
8667
|
+
* @memberof OrdersApiCreateOrderV3
|
|
8848
8668
|
*/
|
|
8849
|
-
readonly
|
|
8669
|
+
readonly xImxEthSignature?: string;
|
|
8850
8670
|
/**
|
|
8851
|
-
*
|
|
8671
|
+
* Authorization header
|
|
8852
8672
|
* @type {string}
|
|
8853
|
-
* @memberof
|
|
8673
|
+
* @memberof OrdersApiCreateOrderV3
|
|
8854
8674
|
*/
|
|
8855
|
-
readonly
|
|
8675
|
+
readonly authorization?: string;
|
|
8676
|
+
}
|
|
8677
|
+
/**
|
|
8678
|
+
* Request parameters for getOrderV3 operation in OrdersApi.
|
|
8679
|
+
* @export
|
|
8680
|
+
* @interface OrdersApiGetOrderV3Request
|
|
8681
|
+
*/
|
|
8682
|
+
interface OrdersApiGetOrderV3Request {
|
|
8856
8683
|
/**
|
|
8857
|
-
*
|
|
8684
|
+
* Order ID
|
|
8858
8685
|
* @type {string}
|
|
8859
|
-
* @memberof
|
|
8686
|
+
* @memberof OrdersApiGetOrderV3
|
|
8860
8687
|
*/
|
|
8861
|
-
readonly
|
|
8688
|
+
readonly id: string;
|
|
8862
8689
|
/**
|
|
8863
|
-
*
|
|
8864
|
-
* @type {
|
|
8865
|
-
* @memberof
|
|
8690
|
+
* Set flag to true to include fee body for the order
|
|
8691
|
+
* @type {boolean}
|
|
8692
|
+
* @memberof OrdersApiGetOrderV3
|
|
8866
8693
|
*/
|
|
8867
|
-
readonly
|
|
8694
|
+
readonly includeFees?: boolean;
|
|
8868
8695
|
/**
|
|
8869
8696
|
* Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
|
|
8870
8697
|
* @type {string}
|
|
8871
|
-
* @memberof
|
|
8698
|
+
* @memberof OrdersApiGetOrderV3
|
|
8872
8699
|
*/
|
|
8873
8700
|
readonly auxiliaryFeePercentages?: string;
|
|
8874
8701
|
/**
|
|
8875
8702
|
* Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
|
|
8876
8703
|
* @type {string}
|
|
8877
|
-
* @memberof
|
|
8704
|
+
* @memberof OrdersApiGetOrderV3
|
|
8878
8705
|
*/
|
|
8879
8706
|
readonly auxiliaryFeeRecipients?: string;
|
|
8707
|
+
}
|
|
8708
|
+
/**
|
|
8709
|
+
* Request parameters for getSignableCancelOrderV3 operation in OrdersApi.
|
|
8710
|
+
* @export
|
|
8711
|
+
* @interface OrdersApiGetSignableCancelOrderV3Request
|
|
8712
|
+
*/
|
|
8713
|
+
interface OrdersApiGetSignableCancelOrderV3Request {
|
|
8880
8714
|
/**
|
|
8881
|
-
*
|
|
8882
|
-
* @type {
|
|
8883
|
-
* @memberof
|
|
8715
|
+
* get a signable cancel order
|
|
8716
|
+
* @type {GetSignableCancelOrderRequest}
|
|
8717
|
+
* @memberof OrdersApiGetSignableCancelOrderV3
|
|
8884
8718
|
*/
|
|
8885
|
-
readonly
|
|
8719
|
+
readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
|
|
8720
|
+
}
|
|
8721
|
+
/**
|
|
8722
|
+
* Request parameters for getSignableOrder operation in OrdersApi.
|
|
8723
|
+
* @export
|
|
8724
|
+
* @interface OrdersApiGetSignableOrderRequest
|
|
8725
|
+
*/
|
|
8726
|
+
interface OrdersApiGetSignableOrderRequest {
|
|
8727
|
+
/**
|
|
8728
|
+
* get a signable order v3
|
|
8729
|
+
* @type {GetSignableOrderRequestV3}
|
|
8730
|
+
* @memberof OrdersApiGetSignableOrder
|
|
8731
|
+
*/
|
|
8732
|
+
readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
|
|
8886
8733
|
}
|
|
8887
8734
|
/**
|
|
8888
8735
|
* Request parameters for listOrdersV3 operation in OrdersApi.
|
|
@@ -9072,16 +8919,6 @@ interface OrdersApiListOrdersV3Request {
|
|
|
9072
8919
|
* @extends {BaseAPI}
|
|
9073
8920
|
*/
|
|
9074
8921
|
declare class OrdersApi extends BaseAPI {
|
|
9075
|
-
/**
|
|
9076
|
-
* 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
|
|
9077
|
-
* @summary Cancel an order
|
|
9078
|
-
* @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
|
|
9079
|
-
* @param {*} [options] Override http request option.
|
|
9080
|
-
* @deprecated
|
|
9081
|
-
* @throws {RequiredError}
|
|
9082
|
-
* @memberof OrdersApi
|
|
9083
|
-
*/
|
|
9084
|
-
cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
|
|
9085
8922
|
/**
|
|
9086
8923
|
* Cancel an order (V3)
|
|
9087
8924
|
* @summary Cancel an order (V3)
|
|
@@ -9092,17 +8929,7 @@ declare class OrdersApi extends BaseAPI {
|
|
|
9092
8929
|
*/
|
|
9093
8930
|
cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
|
|
9094
8931
|
/**
|
|
9095
|
-
* Create an order
|
|
9096
|
-
* @summary Create an order
|
|
9097
|
-
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
9098
|
-
* @param {*} [options] Override http request option.
|
|
9099
|
-
* @deprecated
|
|
9100
|
-
* @throws {RequiredError}
|
|
9101
|
-
* @memberof OrdersApi
|
|
9102
|
-
*/
|
|
9103
|
-
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
|
|
9104
|
-
/**
|
|
9105
|
-
* Create an order using the v3 orderbook. Currently only buy NFT orders are supported.
|
|
8932
|
+
* Create an order using the v3 orderbook.
|
|
9106
8933
|
* @summary Create an order (V3)
|
|
9107
8934
|
* @param {OrdersApiCreateOrderV3Request} requestParameters Request parameters.
|
|
9108
8935
|
* @param {*} [options] Override http request option.
|
|
@@ -9110,16 +8937,6 @@ declare class OrdersApi extends BaseAPI {
|
|
|
9110
8937
|
* @memberof OrdersApi
|
|
9111
8938
|
*/
|
|
9112
8939
|
createOrderV3(requestParameters: OrdersApiCreateOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
|
|
9113
|
-
/**
|
|
9114
|
-
* 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
|
|
9115
|
-
* @summary Get an order
|
|
9116
|
-
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
9117
|
-
* @param {*} [options] Override http request option.
|
|
9118
|
-
* @deprecated
|
|
9119
|
-
* @throws {RequiredError}
|
|
9120
|
-
* @memberof OrdersApi
|
|
9121
|
-
*/
|
|
9122
|
-
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Order, any>>;
|
|
9123
8940
|
/**
|
|
9124
8941
|
* Get an order (V3)
|
|
9125
8942
|
* @summary Get an order (V3)
|
|
@@ -9129,16 +8946,6 @@ declare class OrdersApi extends BaseAPI {
|
|
|
9129
8946
|
* @memberof OrdersApi
|
|
9130
8947
|
*/
|
|
9131
8948
|
getOrderV3(requestParameters: OrdersApiGetOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<OrderV3, any>>;
|
|
9132
|
-
/**
|
|
9133
|
-
* 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
|
|
9134
|
-
* @summary Sign cancel order message
|
|
9135
|
-
* @param {OrdersApiGetSignableCancelOrderRequest} requestParameters Request parameters.
|
|
9136
|
-
* @param {*} [options] Override http request option.
|
|
9137
|
-
* @deprecated
|
|
9138
|
-
* @throws {RequiredError}
|
|
9139
|
-
* @memberof OrdersApi
|
|
9140
|
-
*/
|
|
9141
|
-
getSignableCancelOrder(requestParameters: OrdersApiGetSignableCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
|
|
9142
8949
|
/**
|
|
9143
8950
|
* Generate a signable cancel order message (V3)
|
|
9144
8951
|
* @summary Generate a signable cancel order message (V3)
|
|
@@ -9157,16 +8964,6 @@ declare class OrdersApi extends BaseAPI {
|
|
|
9157
8964
|
* @memberof OrdersApi
|
|
9158
8965
|
*/
|
|
9159
8966
|
getSignableOrder(requestParameters: OrdersApiGetSignableOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableOrderResponse, any>>;
|
|
9160
|
-
/**
|
|
9161
|
-
* 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
|
|
9162
|
-
* @summary Get a list of orders.
|
|
9163
|
-
* @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
|
|
9164
|
-
* @param {*} [options] Override http request option.
|
|
9165
|
-
* @deprecated
|
|
9166
|
-
* @throws {RequiredError}
|
|
9167
|
-
* @memberof OrdersApi
|
|
9168
|
-
*/
|
|
9169
|
-
listOrders(requestParameters?: OrdersApiListOrdersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponse, any>>;
|
|
9170
8967
|
/**
|
|
9171
8968
|
* Get a list of orders (V3)
|
|
9172
8969
|
* @summary Get a list of orders (V3)
|
|
@@ -9270,6 +9067,31 @@ interface ProjectsApiGetProjectsRequest {
|
|
|
9270
9067
|
*/
|
|
9271
9068
|
readonly direction?: string;
|
|
9272
9069
|
}
|
|
9070
|
+
/**
|
|
9071
|
+
* Request parameters for getSdkVersion operation in ProjectsApi.
|
|
9072
|
+
* @export
|
|
9073
|
+
* @interface ProjectsApiGetSdkVersionRequest
|
|
9074
|
+
*/
|
|
9075
|
+
interface ProjectsApiGetSdkVersionRequest {
|
|
9076
|
+
/**
|
|
9077
|
+
* Runtime Details
|
|
9078
|
+
* @type {string}
|
|
9079
|
+
* @memberof ProjectsApiGetSdkVersion
|
|
9080
|
+
*/
|
|
9081
|
+
readonly details: string;
|
|
9082
|
+
/**
|
|
9083
|
+
* SDK Version
|
|
9084
|
+
* @type {string}
|
|
9085
|
+
* @memberof ProjectsApiGetSdkVersion
|
|
9086
|
+
*/
|
|
9087
|
+
readonly version?: string;
|
|
9088
|
+
/**
|
|
9089
|
+
* Runtime ID
|
|
9090
|
+
* @type {string}
|
|
9091
|
+
* @memberof ProjectsApiGetSdkVersion
|
|
9092
|
+
*/
|
|
9093
|
+
readonly id?: string;
|
|
9094
|
+
}
|
|
9273
9095
|
/**
|
|
9274
9096
|
* ProjectsApi - object-oriented interface
|
|
9275
9097
|
* @export
|
|
@@ -9282,6 +9104,7 @@ declare class ProjectsApi extends BaseAPI {
|
|
|
9282
9104
|
* @summary Create a project
|
|
9283
9105
|
* @param {ProjectsApiCreateProjectRequest} requestParameters Request parameters.
|
|
9284
9106
|
* @param {*} [options] Override http request option.
|
|
9107
|
+
* @deprecated
|
|
9285
9108
|
* @throws {RequiredError}
|
|
9286
9109
|
* @memberof ProjectsApi
|
|
9287
9110
|
*/
|
|
@@ -9304,6 +9127,15 @@ declare class ProjectsApi extends BaseAPI {
|
|
|
9304
9127
|
* @memberof ProjectsApi
|
|
9305
9128
|
*/
|
|
9306
9129
|
getProjects(requestParameters: ProjectsApiGetProjectsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetProjectsResponse, any>>;
|
|
9130
|
+
/**
|
|
9131
|
+
* Checks the SDK Version of caller against the current SDK Version and returns a message.
|
|
9132
|
+
* @summary Checks the SDK Version of caller against the current SDK Version
|
|
9133
|
+
* @param {ProjectsApiGetSdkVersionRequest} requestParameters Request parameters.
|
|
9134
|
+
* @param {*} [options] Override http request option.
|
|
9135
|
+
* @throws {RequiredError}
|
|
9136
|
+
* @memberof ProjectsApi
|
|
9137
|
+
*/
|
|
9138
|
+
getSdkVersion(requestParameters: ProjectsApiGetSdkVersionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ApiSDKVersionCheckResponse, any>>;
|
|
9307
9139
|
}
|
|
9308
9140
|
/**
|
|
9309
9141
|
* Request parameters for getToken operation in TokensApi.
|
|
@@ -9387,37 +9219,6 @@ declare class TokensApi extends BaseAPI {
|
|
|
9387
9219
|
*/
|
|
9388
9220
|
listTokens(requestParameters?: TokensApiListTokensRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTokensResponse, any>>;
|
|
9389
9221
|
}
|
|
9390
|
-
/**
|
|
9391
|
-
* Request parameters for createTrade operation in TradesApi.
|
|
9392
|
-
* @export
|
|
9393
|
-
* @interface TradesApiCreateTradeRequest
|
|
9394
|
-
*/
|
|
9395
|
-
interface TradesApiCreateTradeRequest {
|
|
9396
|
-
/**
|
|
9397
|
-
* create a trade
|
|
9398
|
-
* @type {CreateTradeRequestV1}
|
|
9399
|
-
* @memberof TradesApiCreateTrade
|
|
9400
|
-
*/
|
|
9401
|
-
readonly createTradeRequest: CreateTradeRequestV1;
|
|
9402
|
-
/**
|
|
9403
|
-
* eth address
|
|
9404
|
-
* @type {string}
|
|
9405
|
-
* @memberof TradesApiCreateTrade
|
|
9406
|
-
*/
|
|
9407
|
-
readonly xImxEthAddress?: string;
|
|
9408
|
-
/**
|
|
9409
|
-
* eth signature
|
|
9410
|
-
* @type {string}
|
|
9411
|
-
* @memberof TradesApiCreateTrade
|
|
9412
|
-
*/
|
|
9413
|
-
readonly xImxEthSignature?: string;
|
|
9414
|
-
/**
|
|
9415
|
-
* Authorization header
|
|
9416
|
-
* @type {string}
|
|
9417
|
-
* @memberof TradesApiCreateTrade
|
|
9418
|
-
*/
|
|
9419
|
-
readonly authorization?: string;
|
|
9420
|
-
}
|
|
9421
9222
|
/**
|
|
9422
9223
|
* Request parameters for createTradeV3 operation in TradesApi.
|
|
9423
9224
|
* @export
|
|
@@ -9463,91 +9264,18 @@ interface TradesApiGetSignableTradeRequest {
|
|
|
9463
9264
|
readonly getSignableTradeRequest: GetSignableTradeRequest;
|
|
9464
9265
|
}
|
|
9465
9266
|
/**
|
|
9466
|
-
* Request parameters for
|
|
9267
|
+
* Request parameters for getTradeV3 operation in TradesApi.
|
|
9467
9268
|
* @export
|
|
9468
|
-
* @interface
|
|
9269
|
+
* @interface TradesApiGetTradeV3Request
|
|
9469
9270
|
*/
|
|
9470
|
-
interface
|
|
9271
|
+
interface TradesApiGetTradeV3Request {
|
|
9471
9272
|
/**
|
|
9472
9273
|
* Trade ID
|
|
9473
9274
|
* @type {string}
|
|
9474
|
-
* @memberof
|
|
9275
|
+
* @memberof TradesApiGetTradeV3
|
|
9475
9276
|
*/
|
|
9476
9277
|
readonly id: string;
|
|
9477
9278
|
}
|
|
9478
|
-
/**
|
|
9479
|
-
* Request parameters for listTrades operation in TradesApi.
|
|
9480
|
-
* @export
|
|
9481
|
-
* @interface TradesApiListTradesRequest
|
|
9482
|
-
*/
|
|
9483
|
-
interface TradesApiListTradesRequest {
|
|
9484
|
-
/**
|
|
9485
|
-
* Party A\'s (buy order) token type of currency used to buy
|
|
9486
|
-
* @type {string}
|
|
9487
|
-
* @memberof TradesApiListTrades
|
|
9488
|
-
*/
|
|
9489
|
-
readonly partyATokenType?: string;
|
|
9490
|
-
/**
|
|
9491
|
-
* Party A\'s (buy order) token address of currency used to buy
|
|
9492
|
-
* @type {string}
|
|
9493
|
-
* @memberof TradesApiListTrades
|
|
9494
|
-
*/
|
|
9495
|
-
readonly partyATokenAddress?: string;
|
|
9496
|
-
/**
|
|
9497
|
-
* Party B\'s (sell order) token type of NFT sold - always ERC721
|
|
9498
|
-
* @type {string}
|
|
9499
|
-
* @memberof TradesApiListTrades
|
|
9500
|
-
*/
|
|
9501
|
-
readonly partyBTokenType?: string;
|
|
9502
|
-
/**
|
|
9503
|
-
* Party B\'s (sell order) collection address of NFT sold
|
|
9504
|
-
* @type {string}
|
|
9505
|
-
* @memberof TradesApiListTrades
|
|
9506
|
-
*/
|
|
9507
|
-
readonly partyBTokenAddress?: string;
|
|
9508
|
-
/**
|
|
9509
|
-
* Party B\'s (sell order) token id of NFT sold
|
|
9510
|
-
* @type {string}
|
|
9511
|
-
* @memberof TradesApiListTrades
|
|
9512
|
-
*/
|
|
9513
|
-
readonly partyBTokenId?: string;
|
|
9514
|
-
/**
|
|
9515
|
-
* Page size of the result
|
|
9516
|
-
* @type {number}
|
|
9517
|
-
* @memberof TradesApiListTrades
|
|
9518
|
-
*/
|
|
9519
|
-
readonly pageSize?: number;
|
|
9520
|
-
/**
|
|
9521
|
-
* Cursor
|
|
9522
|
-
* @type {string}
|
|
9523
|
-
* @memberof TradesApiListTrades
|
|
9524
|
-
*/
|
|
9525
|
-
readonly cursor?: string;
|
|
9526
|
-
/**
|
|
9527
|
-
* Property to sort by
|
|
9528
|
-
* @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
|
|
9529
|
-
* @memberof TradesApiListTrades
|
|
9530
|
-
*/
|
|
9531
|
-
readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
|
|
9532
|
-
/**
|
|
9533
|
-
* Direction to sort (asc/desc)
|
|
9534
|
-
* @type {string}
|
|
9535
|
-
* @memberof TradesApiListTrades
|
|
9536
|
-
*/
|
|
9537
|
-
readonly direction?: string;
|
|
9538
|
-
/**
|
|
9539
|
-
* Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
9540
|
-
* @type {string}
|
|
9541
|
-
* @memberof TradesApiListTrades
|
|
9542
|
-
*/
|
|
9543
|
-
readonly minTimestamp?: string;
|
|
9544
|
-
/**
|
|
9545
|
-
* Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-05-27T00:10:22Z\'
|
|
9546
|
-
* @type {string}
|
|
9547
|
-
* @memberof TradesApiListTrades
|
|
9548
|
-
*/
|
|
9549
|
-
readonly maxTimestamp?: string;
|
|
9550
|
-
}
|
|
9551
9279
|
/**
|
|
9552
9280
|
* Request parameters for listTradesV3 operation in TradesApi.
|
|
9553
9281
|
* @export
|
|
@@ -9609,13 +9337,13 @@ interface TradesApiListTradesV3Request {
|
|
|
9609
9337
|
*/
|
|
9610
9338
|
readonly direction?: string;
|
|
9611
9339
|
/**
|
|
9612
|
-
* Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-
|
|
9340
|
+
* Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-06-27T00:10:22Z\'
|
|
9613
9341
|
* @type {string}
|
|
9614
9342
|
* @memberof TradesApiListTradesV3
|
|
9615
9343
|
*/
|
|
9616
9344
|
readonly minTimestamp?: string;
|
|
9617
9345
|
/**
|
|
9618
|
-
* Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-
|
|
9346
|
+
* Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \'2022-06-27T00:10:22Z\'
|
|
9619
9347
|
* @type {string}
|
|
9620
9348
|
* @memberof TradesApiListTradesV3
|
|
9621
9349
|
*/
|
|
@@ -9629,17 +9357,7 @@ interface TradesApiListTradesV3Request {
|
|
|
9629
9357
|
*/
|
|
9630
9358
|
declare class TradesApi extends BaseAPI {
|
|
9631
9359
|
/**
|
|
9632
|
-
* Create a
|
|
9633
|
-
* @summary Create a Trade between two parties
|
|
9634
|
-
* @param {TradesApiCreateTradeRequest} requestParameters Request parameters.
|
|
9635
|
-
* @param {*} [options] Override http request option.
|
|
9636
|
-
* @deprecated
|
|
9637
|
-
* @throws {RequiredError}
|
|
9638
|
-
* @memberof TradesApi
|
|
9639
|
-
*/
|
|
9640
|
-
createTrade(requestParameters: TradesApiCreateTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
|
|
9641
|
-
/**
|
|
9642
|
-
* Create a Trade. Currently only buy order is supported.
|
|
9360
|
+
* Create a Trade.
|
|
9643
9361
|
* @summary Create a Trade (V3)
|
|
9644
9362
|
* @param {TradesApiCreateTradeV3Request} requestParameters Request parameters.
|
|
9645
9363
|
* @param {*} [options] Override http request option.
|
|
@@ -9659,22 +9377,12 @@ declare class TradesApi extends BaseAPI {
|
|
|
9659
9377
|
/**
|
|
9660
9378
|
* Get details of a trade with the given ID
|
|
9661
9379
|
* @summary Get details of a trade with the given ID
|
|
9662
|
-
* @param {
|
|
9663
|
-
* @param {*} [options] Override http request option.
|
|
9664
|
-
* @throws {RequiredError}
|
|
9665
|
-
* @memberof TradesApi
|
|
9666
|
-
*/
|
|
9667
|
-
getTrade(requestParameters: TradesApiGetTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
|
|
9668
|
-
/**
|
|
9669
|
-
* 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
|
|
9670
|
-
* @summary Get a list of trades
|
|
9671
|
-
* @param {TradesApiListTradesRequest} requestParameters Request parameters.
|
|
9380
|
+
* @param {TradesApiGetTradeV3Request} requestParameters Request parameters.
|
|
9672
9381
|
* @param {*} [options] Override http request option.
|
|
9673
|
-
* @deprecated
|
|
9674
9382
|
* @throws {RequiredError}
|
|
9675
9383
|
* @memberof TradesApi
|
|
9676
9384
|
*/
|
|
9677
|
-
|
|
9385
|
+
getTradeV3(requestParameters: TradesApiGetTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
|
|
9678
9386
|
/**
|
|
9679
9387
|
* Get a list of trades (V3)
|
|
9680
9388
|
* @summary Get a list of trades (V3)
|
|
@@ -9755,10 +9463,10 @@ interface TransfersApiCreateTransferV1Request {
|
|
|
9755
9463
|
interface TransfersApiGetSignableTransferRequest {
|
|
9756
9464
|
/**
|
|
9757
9465
|
* get details of signable transfer
|
|
9758
|
-
* @type {
|
|
9466
|
+
* @type {GetSignableTransferRequestV2}
|
|
9759
9467
|
* @memberof TransfersApiGetSignableTransfer
|
|
9760
9468
|
*/
|
|
9761
|
-
readonly getSignableTransferRequestV2:
|
|
9469
|
+
readonly getSignableTransferRequestV2: GetSignableTransferRequestV2;
|
|
9762
9470
|
}
|
|
9763
9471
|
/**
|
|
9764
9472
|
* Request parameters for getSignableTransferV1 operation in TransfersApi.
|
|
@@ -9768,10 +9476,10 @@ interface TransfersApiGetSignableTransferRequest {
|
|
|
9768
9476
|
interface TransfersApiGetSignableTransferV1Request {
|
|
9769
9477
|
/**
|
|
9770
9478
|
* get details of signable transfer
|
|
9771
|
-
* @type {
|
|
9479
|
+
* @type {GetSignableTransferRequest}
|
|
9772
9480
|
* @memberof TransfersApiGetSignableTransferV1
|
|
9773
9481
|
*/
|
|
9774
|
-
readonly getSignableTransferRequest:
|
|
9482
|
+
readonly getSignableTransferRequest: GetSignableTransferRequest;
|
|
9775
9483
|
}
|
|
9776
9484
|
/**
|
|
9777
9485
|
* Request parameters for getTransfer operation in TransfersApi.
|
|
@@ -9806,10 +9514,10 @@ interface TransfersApiListTransfersRequest {
|
|
|
9806
9514
|
readonly cursor?: string;
|
|
9807
9515
|
/**
|
|
9808
9516
|
* Property to sort by
|
|
9809
|
-
* @type {'transaction_id' | '
|
|
9517
|
+
* @type {'transaction_id' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key'}
|
|
9810
9518
|
* @memberof TransfersApiListTransfers
|
|
9811
9519
|
*/
|
|
9812
|
-
readonly orderBy?: 'transaction_id' | '
|
|
9520
|
+
readonly orderBy?: 'transaction_id' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key';
|
|
9813
9521
|
/**
|
|
9814
9522
|
* Direction to sort (asc/desc)
|
|
9815
9523
|
* @type {string}
|
|
@@ -9910,7 +9618,7 @@ declare class TransfersApi extends BaseAPI {
|
|
|
9910
9618
|
* @throws {RequiredError}
|
|
9911
9619
|
* @memberof TransfersApi
|
|
9912
9620
|
*/
|
|
9913
|
-
createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<
|
|
9621
|
+
createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponseV2, any>>;
|
|
9914
9622
|
/**
|
|
9915
9623
|
* Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransferV1 to get request body params.
|
|
9916
9624
|
* @summary Creates a transfer of tokens between two parties
|
|
@@ -9928,7 +9636,7 @@ declare class TransfersApi extends BaseAPI {
|
|
|
9928
9636
|
* @throws {RequiredError}
|
|
9929
9637
|
* @memberof TransfersApi
|
|
9930
9638
|
*/
|
|
9931
|
-
getSignableTransfer(requestParameters: TransfersApiGetSignableTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<
|
|
9639
|
+
getSignableTransfer(requestParameters: TransfersApiGetSignableTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTransferResponseV2, any>>;
|
|
9932
9640
|
/**
|
|
9933
9641
|
* Gets details of a signable transfer
|
|
9934
9642
|
* @summary Gets details of a signable transfer
|
|
@@ -10070,7 +9778,7 @@ declare class UsersApi extends BaseAPI {
|
|
|
10070
9778
|
* @throws {RequiredError}
|
|
10071
9779
|
* @memberof UsersApi
|
|
10072
9780
|
*/
|
|
10073
|
-
registerPassportUser(requestParameters: UsersApiRegisterPassportUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<
|
|
9781
|
+
registerPassportUser(requestParameters: UsersApiRegisterPassportUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<RegisterPassportUserResult, any>>;
|
|
10074
9782
|
/**
|
|
10075
9783
|
* Registers a user
|
|
10076
9784
|
* @summary Registers a user
|
|
@@ -10255,7 +9963,7 @@ interface WithdrawalsApiListWithdrawalsRequest {
|
|
|
10255
9963
|
*/
|
|
10256
9964
|
declare class WithdrawalsApi extends BaseAPI {
|
|
10257
9965
|
/**
|
|
10258
|
-
* Creates a withdrawal.
|
|
9966
|
+
* Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
|
|
10259
9967
|
* @summary Creates a withdrawal of a token
|
|
10260
9968
|
* @param {WithdrawalsApiCreateWithdrawalRequest} requestParameters Request parameters.
|
|
10261
9969
|
* @param {*} [options] Override http request option.
|
|
@@ -10708,28 +10416,28 @@ declare class ImmutableXClient {
|
|
|
10708
10416
|
* @returns a promise that resolves with the requested Order
|
|
10709
10417
|
* @throws {@link index.IMXError}
|
|
10710
10418
|
*/
|
|
10711
|
-
getOrder(request:
|
|
10419
|
+
getOrder(request: OrdersApiGetOrderV3Request): Promise<OrderV3>;
|
|
10712
10420
|
/**
|
|
10713
10421
|
* Get a list of Orders
|
|
10714
10422
|
* @param request - optional object containing the parameters to be provided in the API request
|
|
10715
10423
|
* @returns a promise that resolves with the requested list of Orders
|
|
10716
10424
|
* @throws {@link index.IMXError}
|
|
10717
10425
|
*/
|
|
10718
|
-
listOrders(request?:
|
|
10426
|
+
listOrders(request?: OrdersApiListOrdersV3Request): Promise<ListOrdersResponseV3>;
|
|
10719
10427
|
/**
|
|
10720
10428
|
* Get details of a Trade with the given ID
|
|
10721
10429
|
* @param request - the request object containing the parameters to be provided in the API request
|
|
10722
10430
|
* @returns a promise that resolves with the requested Trade
|
|
10723
10431
|
* @throws {@link index.IMXError}
|
|
10724
10432
|
*/
|
|
10725
|
-
getTrade(request:
|
|
10433
|
+
getTrade(request: TradesApiGetTradeV3Request): Promise<Trade>;
|
|
10726
10434
|
/**
|
|
10727
10435
|
* Get a list of Trades
|
|
10728
10436
|
* @param request - optional object containing the parameters to be provided in the API request
|
|
10729
10437
|
* @returns a promise that resolves with the requested list of Trades
|
|
10730
10438
|
* @throws {@link index.IMXError}
|
|
10731
10439
|
*/
|
|
10732
|
-
listTrades(request?:
|
|
10440
|
+
listTrades(request?: TradesApiListTradesV3Request): Promise<ListTradesResponse>;
|
|
10733
10441
|
/**
|
|
10734
10442
|
* Get details of a Token
|
|
10735
10443
|
* @param request - the request object containing the parameters to be provided in the API request
|
|
@@ -10931,17 +10639,12 @@ declare class Passport {
|
|
|
10931
10639
|
private readonly passportImxProviderFactory;
|
|
10932
10640
|
private readonly passportEventEmitter;
|
|
10933
10641
|
constructor(passportModuleConfiguration: PassportModuleConfiguration);
|
|
10934
|
-
signIn(options?: {
|
|
10935
|
-
useCachedSession: boolean;
|
|
10936
|
-
}): Promise<UserProfile | null>;
|
|
10937
10642
|
/**
|
|
10938
|
-
* @deprecated The method
|
|
10643
|
+
* @deprecated The method `login` with an argument of `{ useCachedSession: true }` should be used in conjunction with
|
|
10644
|
+
* `connectImx` instead.
|
|
10939
10645
|
*/
|
|
10940
10646
|
connectImxSilent(): Promise<IMXProvider | null>;
|
|
10941
|
-
connectImx(
|
|
10942
|
-
useCachedSession: boolean;
|
|
10943
|
-
}): Promise<IMXProvider | null>;
|
|
10944
|
-
loginWithDeviceFlow(): Promise<DeviceConnectResponse>;
|
|
10647
|
+
connectImx(): Promise<IMXProvider>;
|
|
10945
10648
|
connectImxDeviceFlow(deviceCode: string, interval: number, timeoutMs?: number): Promise<IMXProvider | null>;
|
|
10946
10649
|
getPKCEAuthorizationUrl(): string;
|
|
10947
10650
|
connectImxPKCEFlow(authorizationCode: string, state: string): Promise<IMXProvider | null>;
|
|
@@ -10951,6 +10654,18 @@ declare class Passport {
|
|
|
10951
10654
|
checkStoredDeviceFlowCredentials(): DeviceTokenResponse | null;
|
|
10952
10655
|
connectImxWithCredentials(tokenResponse: DeviceTokenResponse): Promise<IMXProvider | null>;
|
|
10953
10656
|
connectEvm(): Provider;
|
|
10657
|
+
/**
|
|
10658
|
+
*
|
|
10659
|
+
* Initiates the authorisation flow.
|
|
10660
|
+
*
|
|
10661
|
+
* @param options.useCachedSession = false - If true, and no active session exists, then the user will not be
|
|
10662
|
+
* prompted to log in and the Promise will resolve with a null value.
|
|
10663
|
+
* @returns {Promise<UserProfile | null>} the user profile if the user is logged in, otherwise null
|
|
10664
|
+
*/
|
|
10665
|
+
login(options?: {
|
|
10666
|
+
useCachedSession: boolean;
|
|
10667
|
+
}): Promise<UserProfile | null>;
|
|
10668
|
+
loginWithDeviceFlow(): Promise<DeviceConnectResponse>;
|
|
10954
10669
|
loginCallback(): Promise<void>;
|
|
10955
10670
|
logout(): Promise<void>;
|
|
10956
10671
|
/**
|