@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/index.d.ts CHANGED
@@ -8,10 +8,14 @@ declare enum Environment {
8
8
  }
9
9
  declare class ImmutableConfiguration {
10
10
  readonly environment: Environment;
11
+ readonly rateLimitingKey?: string;
11
12
  readonly apiKey?: string;
13
+ readonly clientAppId?: string;
12
14
  constructor(options: {
13
15
  environment: Environment;
16
+ rateLimitingKey?: string;
14
17
  apiKey?: string;
18
+ clientAppId?: string;
15
19
  });
16
20
  }
17
21
  interface ModuleConfiguration<T> {
@@ -5005,6 +5009,25 @@ interface CollectionDetails {
5005
5009
  'name': string;
5006
5010
  }
5007
5011
 
5012
+ /**
5013
+ * Immutable X API
5014
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5015
+ *
5016
+ * The version of the OpenAPI document: 3.0
5017
+ * Contact: support@immutable.com
5018
+ *
5019
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5020
+ * https://openapi-generator.tech
5021
+ * Do not edit the class manually.
5022
+ */
5023
+
5024
+ /**
5025
+ * @type AssetPropertiesCollection
5026
+ * Details of this asset\'s collection
5027
+ * @export
5028
+ */
5029
+ declare type AssetPropertiesCollection = CollectionDetails;
5030
+
5008
5031
  /**
5009
5032
  * Immutable X API
5010
5033
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -5025,10 +5048,10 @@ interface CollectionDetails {
5025
5048
  interface AssetProperties {
5026
5049
  /**
5027
5050
  *
5028
- * @type {CollectionDetails}
5051
+ * @type {AssetPropertiesCollection}
5029
5052
  * @memberof AssetProperties
5030
5053
  */
5031
- 'collection'?: CollectionDetails;
5054
+ 'collection'?: AssetPropertiesCollection;
5032
5055
  /**
5033
5056
  * Image URL of this asset
5034
5057
  * @type {string}
@@ -5212,6 +5235,25 @@ interface FeeData {
5212
5235
  'decimals'?: number;
5213
5236
  }
5214
5237
 
5238
+ /**
5239
+ * Immutable X API
5240
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5241
+ *
5242
+ * The version of the OpenAPI document: 3.0
5243
+ * Contact: support@immutable.com
5244
+ *
5245
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5246
+ * https://openapi-generator.tech
5247
+ * Do not edit the class manually.
5248
+ */
5249
+
5250
+ /**
5251
+ * @type FeeTokenData
5252
+ * Fee token data details
5253
+ * @export
5254
+ */
5255
+ declare type FeeTokenData = FeeData;
5256
+
5215
5257
  /**
5216
5258
  * Immutable X API
5217
5259
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -5232,10 +5274,10 @@ interface FeeData {
5232
5274
  interface FeeToken$1 {
5233
5275
  /**
5234
5276
  *
5235
- * @type {FeeData}
5277
+ * @type {FeeTokenData}
5236
5278
  * @memberof FeeToken
5237
5279
  */
5238
- 'data'?: FeeData;
5280
+ 'data'?: FeeTokenData;
5239
5281
  /**
5240
5282
  * Fee token type. One of ETH/ERC20
5241
5283
  * @type {string}
@@ -5369,29 +5411,48 @@ interface ApiRegisterPassportUserRequest {
5369
5411
  /**
5370
5412
  *
5371
5413
  * @export
5372
- * @interface Fee
5414
+ * @interface ApiSDKVersionCheckResponse
5373
5415
  */
5374
- interface Fee$3 {
5416
+ interface ApiSDKVersionCheckResponse {
5375
5417
  /**
5376
- * Wallet address
5418
+ *
5377
5419
  * @type {string}
5378
- * @memberof Fee
5420
+ * @memberof ApiSDKVersionCheckResponse
5379
5421
  */
5380
- 'address': string;
5422
+ 'message'?: string;
5381
5423
  /**
5382
- * The percentage of fee
5383
- * @type {number}
5384
- * @memberof Fee
5424
+ *
5425
+ * @type {boolean}
5426
+ * @memberof ApiSDKVersionCheckResponse
5385
5427
  */
5386
- 'percentage': number;
5428
+ 'ok'?: boolean;
5387
5429
  /**
5388
- * Type of fee. Examples: `royalty`, `maker`, `taker` or `protocol`
5430
+ *
5389
5431
  * @type {string}
5390
- * @memberof Fee
5432
+ * @memberof ApiSDKVersionCheckResponse
5391
5433
  */
5392
- 'type': string;
5434
+ 'runtimeId'?: string;
5393
5435
  }
5394
5436
 
5437
+ /**
5438
+ * Immutable X API
5439
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5440
+ *
5441
+ * The version of the OpenAPI document: 3.0
5442
+ * Contact: support@immutable.com
5443
+ *
5444
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5445
+ * https://openapi-generator.tech
5446
+ * Do not edit the class manually.
5447
+ */
5448
+
5449
+ /**
5450
+ * @type AssetCollection
5451
+ * Information about the collection to which this asset belongs
5452
+ * @export
5453
+ */
5454
+ declare type AssetCollection = CollectionDetails;
5455
+
5395
5456
  /**
5396
5457
  * Immutable X API
5397
5458
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -5423,6 +5484,62 @@ interface OrderDetails {
5423
5484
  'sell_orders'?: Array<object>;
5424
5485
  }
5425
5486
 
5487
+ /**
5488
+ * Immutable X API
5489
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5490
+ *
5491
+ * The version of the OpenAPI document: 3.0
5492
+ * Contact: support@immutable.com
5493
+ *
5494
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5495
+ * https://openapi-generator.tech
5496
+ * Do not edit the class manually.
5497
+ */
5498
+
5499
+ /**
5500
+ * @type AssetOrders
5501
+ * [DEPRECATED] Open orders for this asset will always return empty. Use GET /orders
5502
+ * @export
5503
+ */
5504
+ declare type AssetOrders = OrderDetails;
5505
+
5506
+ /**
5507
+ * Immutable X API
5508
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5509
+ *
5510
+ * The version of the OpenAPI document: 3.0
5511
+ * Contact: support@immutable.com
5512
+ *
5513
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5514
+ * https://openapi-generator.tech
5515
+ * Do not edit the class manually.
5516
+ */
5517
+ /**
5518
+ *
5519
+ * @export
5520
+ * @interface Fee
5521
+ */
5522
+ interface Fee$3 {
5523
+ /**
5524
+ * Wallet address
5525
+ * @type {string}
5526
+ * @memberof Fee
5527
+ */
5528
+ 'address': string;
5529
+ /**
5530
+ * The percentage of fee
5531
+ * @type {number}
5532
+ * @memberof Fee
5533
+ */
5534
+ 'percentage': number;
5535
+ /**
5536
+ * Type of fee. Examples: `royalty`, `maker`, `taker` or `protocol`
5537
+ * @type {string}
5538
+ * @memberof Fee
5539
+ */
5540
+ 'type': string;
5541
+ }
5542
+
5426
5543
  /**
5427
5544
  * Immutable X API
5428
5545
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -5443,10 +5560,10 @@ interface OrderDetails {
5443
5560
  interface Asset {
5444
5561
  /**
5445
5562
  *
5446
- * @type {CollectionDetails}
5563
+ * @type {AssetCollection}
5447
5564
  * @memberof Asset
5448
5565
  */
5449
- 'collection': CollectionDetails;
5566
+ 'collection': AssetCollection;
5450
5567
  /**
5451
5568
  * Timestamp of when the asset was created
5452
5569
  * @type {string}
@@ -5491,10 +5608,10 @@ interface Asset {
5491
5608
  'name': string | null;
5492
5609
  /**
5493
5610
  *
5494
- * @type {OrderDetails}
5611
+ * @type {AssetOrders}
5495
5612
  * @memberof Asset
5496
5613
  */
5497
- 'orders'?: OrderDetails;
5614
+ 'orders'?: AssetOrders;
5498
5615
  /**
5499
5616
  * Status of this asset (where it is in the system)
5500
5617
  * @type {string}
@@ -5533,6 +5650,44 @@ interface Asset {
5533
5650
  'user': string;
5534
5651
  }
5535
5652
 
5653
+ /**
5654
+ * Immutable X API
5655
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5656
+ *
5657
+ * The version of the OpenAPI document: 3.0
5658
+ * Contact: support@immutable.com
5659
+ *
5660
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5661
+ * https://openapi-generator.tech
5662
+ * Do not edit the class manually.
5663
+ */
5664
+
5665
+ /**
5666
+ * @type AssetWithOrdersCollection
5667
+ * Information about the collection to which this asset belongs
5668
+ * @export
5669
+ */
5670
+ declare type AssetWithOrdersCollection = CollectionDetails;
5671
+
5672
+ /**
5673
+ * Immutable X API
5674
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5675
+ *
5676
+ * The version of the OpenAPI document: 3.0
5677
+ * Contact: support@immutable.com
5678
+ *
5679
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5680
+ * https://openapi-generator.tech
5681
+ * Do not edit the class manually.
5682
+ */
5683
+
5684
+ /**
5685
+ * @type AssetWithOrdersOrders
5686
+ * Open orders for this asset
5687
+ * @export
5688
+ */
5689
+ declare type AssetWithOrdersOrders = OrderDetails;
5690
+
5536
5691
  /**
5537
5692
  * Immutable X API
5538
5693
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -5553,10 +5708,10 @@ interface Asset {
5553
5708
  interface AssetWithOrders {
5554
5709
  /**
5555
5710
  *
5556
- * @type {CollectionDetails}
5711
+ * @type {AssetWithOrdersCollection}
5557
5712
  * @memberof AssetWithOrders
5558
5713
  */
5559
- 'collection': CollectionDetails;
5714
+ 'collection': AssetWithOrdersCollection;
5560
5715
  /**
5561
5716
  * Timestamp of when the asset was created
5562
5717
  * @type {string}
@@ -5601,10 +5756,10 @@ interface AssetWithOrders {
5601
5756
  'name': string | null;
5602
5757
  /**
5603
5758
  *
5604
- * @type {OrderDetails}
5759
+ * @type {AssetWithOrdersOrders}
5605
5760
  * @memberof AssetWithOrders
5606
5761
  */
5607
- 'orders'?: OrderDetails;
5762
+ 'orders'?: AssetWithOrdersOrders;
5608
5763
  /**
5609
5764
  * Status of this asset (where it is in the system)
5610
5765
  * @type {string}
@@ -5864,6 +6019,25 @@ interface Range {
5864
6019
  'min'?: number;
5865
6020
  }
5866
6021
 
6022
+ /**
6023
+ * Immutable X API
6024
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6025
+ *
6026
+ * The version of the OpenAPI document: 3.0
6027
+ * Contact: support@immutable.com
6028
+ *
6029
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6030
+ * https://openapi-generator.tech
6031
+ * Do not edit the class manually.
6032
+ */
6033
+
6034
+ /**
6035
+ * @type CollectionFilterRange
6036
+ * Range of values for this property
6037
+ * @export
6038
+ */
6039
+ declare type CollectionFilterRange = Range;
6040
+
5867
6041
  /**
5868
6042
  * Immutable X API
5869
6043
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -5890,10 +6064,10 @@ interface CollectionFilter {
5890
6064
  'key'?: string;
5891
6065
  /**
5892
6066
  *
5893
- * @type {Range}
6067
+ * @type {CollectionFilterRange}
5894
6068
  * @memberof CollectionFilter
5895
6069
  */
5896
- 'range'?: Range;
6070
+ 'range'?: CollectionFilterRange;
5897
6071
  /**
5898
6072
  * Type of this filter
5899
6073
  * @type {string}
@@ -6215,98 +6389,6 @@ interface FeeEntry {
6215
6389
  'fee_percentage'?: number;
6216
6390
  }
6217
6391
 
6218
- /**
6219
- * Immutable X API
6220
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6221
- *
6222
- * The version of the OpenAPI document: 3.0
6223
- * Contact: support@immutable.com
6224
- *
6225
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6226
- * https://openapi-generator.tech
6227
- * Do not edit the class manually.
6228
- */
6229
-
6230
- /**
6231
- *
6232
- * @export
6233
- * @interface CreateOrderRequest
6234
- */
6235
- interface CreateOrderRequest {
6236
- /**
6237
- * Amount to buy
6238
- * @type {string}
6239
- * @memberof CreateOrderRequest
6240
- */
6241
- 'amount_buy': string;
6242
- /**
6243
- * Amount to sell
6244
- * @type {string}
6245
- * @memberof CreateOrderRequest
6246
- */
6247
- 'amount_sell': string;
6248
- /**
6249
- * ID of the asset to buy
6250
- * @type {string}
6251
- * @memberof CreateOrderRequest
6252
- */
6253
- 'asset_id_buy': string;
6254
- /**
6255
- * ID of the asset to sell
6256
- * @type {string}
6257
- * @memberof CreateOrderRequest
6258
- */
6259
- 'asset_id_sell': string;
6260
- /**
6261
- * Expiration timestamp for this order
6262
- * @type {number}
6263
- * @memberof CreateOrderRequest
6264
- */
6265
- 'expiration_timestamp': number;
6266
- /**
6267
- * Fee information
6268
- * @type {Array<FeeEntry>}
6269
- * @memberof CreateOrderRequest
6270
- */
6271
- 'fees'?: Array<FeeEntry>;
6272
- /**
6273
- * Whether to include fees in order
6274
- * @type {boolean}
6275
- * @memberof CreateOrderRequest
6276
- */
6277
- 'include_fees'?: boolean;
6278
- /**
6279
- * Nonce of the order
6280
- * @type {number}
6281
- * @memberof CreateOrderRequest
6282
- */
6283
- 'nonce': number;
6284
- /**
6285
- * Public stark key of the user creating order
6286
- * @type {string}
6287
- * @memberof CreateOrderRequest
6288
- */
6289
- 'stark_key': string;
6290
- /**
6291
- * Payload signature
6292
- * @type {string}
6293
- * @memberof CreateOrderRequest
6294
- */
6295
- 'stark_signature': string;
6296
- /**
6297
- * ID of the vault into which the bought asset will be placed
6298
- * @type {number}
6299
- * @memberof CreateOrderRequest
6300
- */
6301
- 'vault_id_buy': number;
6302
- /**
6303
- * ID of the vault to sell from
6304
- * @type {number}
6305
- * @memberof CreateOrderRequest
6306
- */
6307
- 'vault_id_sell': number;
6308
- }
6309
-
6310
6392
  /**
6311
6393
  * Immutable X API
6312
6394
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -6497,11 +6579,11 @@ interface CreateProjectRequest {
6497
6579
  */
6498
6580
  interface CreateProjectResponse {
6499
6581
  /**
6500
- * The project ID
6501
- * @type {number}
6582
+ * The project group ID
6583
+ * @type {string}
6502
6584
  * @memberof CreateProjectResponse
6503
6585
  */
6504
- 'id': number;
6586
+ 'id': string;
6505
6587
  }
6506
6588
 
6507
6589
  /**
@@ -6552,133 +6634,10 @@ interface FeeInfo {
6552
6634
  * https://openapi-generator.tech
6553
6635
  * Do not edit the class manually.
6554
6636
  */
6555
-
6556
6637
  /**
6557
- * @type CreateTradeRequestV1FeeInfo
6558
- * Fee details
6638
+ *
6559
6639
  * @export
6560
- */
6561
- declare type CreateTradeRequestV1FeeInfo = FeeInfo;
6562
-
6563
- /**
6564
- * Immutable X API
6565
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6566
- *
6567
- * The version of the OpenAPI document: 3.0
6568
- * Contact: support@immutable.com
6569
- *
6570
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6571
- * https://openapi-generator.tech
6572
- * Do not edit the class manually.
6573
- */
6574
-
6575
- /**
6576
- *
6577
- * @export
6578
- * @interface CreateTradeRequestV1
6579
- */
6580
- interface CreateTradeRequestV1 {
6581
- /**
6582
- * Amount to buy
6583
- * @type {string}
6584
- * @memberof CreateTradeRequestV1
6585
- */
6586
- 'amount_buy': string;
6587
- /**
6588
- * Amount to sell
6589
- * @type {string}
6590
- * @memberof CreateTradeRequestV1
6591
- */
6592
- 'amount_sell': string;
6593
- /**
6594
- * ID of the asset to buy
6595
- * @type {string}
6596
- * @memberof CreateTradeRequestV1
6597
- */
6598
- 'asset_id_buy': string;
6599
- /**
6600
- * ID of the asset to sell
6601
- * @type {string}
6602
- * @memberof CreateTradeRequestV1
6603
- */
6604
- 'asset_id_sell': string;
6605
- /**
6606
- * Expiration timestamp for this trade
6607
- * @type {number}
6608
- * @memberof CreateTradeRequestV1
6609
- */
6610
- 'expiration_timestamp': number;
6611
- /**
6612
- *
6613
- * @type {CreateTradeRequestV1FeeInfo}
6614
- * @memberof CreateTradeRequestV1
6615
- */
6616
- 'fee_info'?: CreateTradeRequestV1FeeInfo;
6617
- /**
6618
- * Fee information
6619
- * @type {Array<FeeEntry>}
6620
- * @memberof CreateTradeRequestV1
6621
- */
6622
- 'fees'?: Array<FeeEntry>;
6623
- /**
6624
- * [deprecated] All orders include fees since the introduction of protocol fees
6625
- * @type {boolean}
6626
- * @memberof CreateTradeRequestV1
6627
- */
6628
- 'include_fees'?: boolean;
6629
- /**
6630
- * Nonce of the trade
6631
- * @type {number}
6632
- * @memberof CreateTradeRequestV1
6633
- */
6634
- 'nonce': number;
6635
- /**
6636
- * ID of the order
6637
- * @type {number}
6638
- * @memberof CreateTradeRequestV1
6639
- */
6640
- 'order_id': number;
6641
- /**
6642
- * Public stark key of the user creating trade
6643
- * @type {string}
6644
- * @memberof CreateTradeRequestV1
6645
- */
6646
- 'stark_key': string;
6647
- /**
6648
- * Payload signature
6649
- * @type {string}
6650
- * @memberof CreateTradeRequestV1
6651
- */
6652
- 'stark_signature': string;
6653
- /**
6654
- * ID of the vault into which the traded asset will be placed
6655
- * @type {number}
6656
- * @memberof CreateTradeRequestV1
6657
- */
6658
- 'vault_id_buy': number;
6659
- /**
6660
- * ID of the vault to sell from
6661
- * @type {number}
6662
- * @memberof CreateTradeRequestV1
6663
- */
6664
- 'vault_id_sell': number;
6665
- }
6666
-
6667
- /**
6668
- * Immutable X API
6669
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6670
- *
6671
- * The version of the OpenAPI document: 3.0
6672
- * Contact: support@immutable.com
6673
- *
6674
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6675
- * https://openapi-generator.tech
6676
- * Do not edit the class manually.
6677
- */
6678
- /**
6679
- *
6680
- * @export
6681
- * @interface CreateTradeResponse
6640
+ * @interface CreateTradeResponse
6682
6641
  */
6683
6642
  interface CreateTradeResponse {
6684
6643
  /**
@@ -6941,6 +6900,31 @@ interface CreateTransferResponseV1 {
6941
6900
  'transfer_id': number;
6942
6901
  }
6943
6902
 
6903
+ /**
6904
+ * Immutable X API
6905
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6906
+ *
6907
+ * The version of the OpenAPI document: 3.0
6908
+ * Contact: support@immutable.com
6909
+ *
6910
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6911
+ * https://openapi-generator.tech
6912
+ * Do not edit the class manually.
6913
+ */
6914
+ /**
6915
+ *
6916
+ * @export
6917
+ * @interface CreateTransferResponseV2
6918
+ */
6919
+ interface CreateTransferResponseV2 {
6920
+ /**
6921
+ * List of transfer IDs
6922
+ * @type {Array<number>}
6923
+ * @memberof CreateTransferResponseV2
6924
+ */
6925
+ 'transfer_ids': Array<number>;
6926
+ }
6927
+
6944
6928
  /**
6945
6929
  * Immutable X API
6946
6930
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -7077,6 +7061,25 @@ interface CurrencyWithLimits {
7077
7061
  'symbol'?: string;
7078
7062
  }
7079
7063
 
7064
+ /**
7065
+ * Immutable X API
7066
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7067
+ *
7068
+ * The version of the OpenAPI document: 3.0
7069
+ * Contact: support@immutable.com
7070
+ *
7071
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7072
+ * https://openapi-generator.tech
7073
+ * Do not edit the class manually.
7074
+ */
7075
+
7076
+ /**
7077
+ * @type DepositToken
7078
+ * Details of the asset being deposited
7079
+ * @export
7080
+ */
7081
+ declare type DepositToken = Token;
7082
+
7080
7083
  /**
7081
7084
  * Immutable X API
7082
7085
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -7109,10 +7112,10 @@ interface Deposit {
7109
7112
  'timestamp': string;
7110
7113
  /**
7111
7114
  *
7112
- * @type {Token}
7115
+ * @type {DepositToken}
7113
7116
  * @memberof Deposit
7114
7117
  */
7115
- 'token': Token;
7118
+ 'token': DepositToken;
7116
7119
  /**
7117
7120
  * Sequential ID of this transaction within Immutable X
7118
7121
  * @type {number}
@@ -7620,65 +7623,29 @@ interface GetMetadataRefreshes {
7620
7623
  */
7621
7624
  interface Project {
7622
7625
  /**
7623
- * The current period expiry date for collection limit
7624
- * @type {string}
7625
- * @memberof Project
7626
- */
7627
- 'collection_limit_expires_at': string;
7628
- /**
7629
- * The total monthly collection limit
7630
- * @type {number}
7631
- * @memberof Project
7632
- */
7633
- 'collection_monthly_limit': number;
7634
- /**
7635
- * The number of collection remaining in the current period
7636
- * @type {number}
7637
- * @memberof Project
7638
- */
7639
- 'collection_remaining': number;
7640
- /**
7641
- * The company name
7626
+ * The project ChainType
7642
7627
  * @type {string}
7643
7628
  * @memberof Project
7644
7629
  */
7645
- 'company_name': string;
7630
+ 'chain_type'?: string;
7646
7631
  /**
7647
- * The project contact email (must be registered as a developer account with Immutable at https://hub.immutable.com)
7632
+ * The project group ID
7648
7633
  * @type {string}
7649
7634
  * @memberof Project
7650
7635
  */
7651
- 'contact_email': string;
7652
- /**
7653
- * The project ID
7654
- * @type {number}
7655
- * @memberof Project
7656
- */
7657
- 'id': number;
7636
+ 'id': string;
7658
7637
  /**
7659
- * The current period expiry date for mint operation limit
7638
+ * The project group name
7660
7639
  * @type {string}
7661
7640
  * @memberof Project
7662
7641
  */
7663
- 'mint_limit_expires_at': string;
7664
- /**
7665
- * The total monthly mint operation limit
7666
- * @type {number}
7667
- * @memberof Project
7668
- */
7669
- 'mint_monthly_limit': number;
7670
- /**
7671
- * The number of mint operation remaining in the current period
7672
- * @type {number}
7673
- * @memberof Project
7674
- */
7675
- 'mint_remaining': number;
7642
+ 'name': string;
7676
7643
  /**
7677
- * The project name
7644
+ * The organisation ID that the project belongs to
7678
7645
  * @type {string}
7679
7646
  * @memberof Project
7680
7647
  */
7681
- 'name': string;
7648
+ 'org_id'?: string;
7682
7649
  }
7683
7650
 
7684
7651
  /**
@@ -7773,12 +7740,24 @@ interface GetSignableCancelOrderResponse {
7773
7740
  * @memberof GetSignableCancelOrderResponse
7774
7741
  */
7775
7742
  'payload_hash': string;
7743
+ /**
7744
+ * EIP-712 encoding of the StarkEx cancel order request to be displayed to the user
7745
+ * @type {string}
7746
+ * @memberof GetSignableCancelOrderResponse
7747
+ */
7748
+ 'readable_transaction': string;
7776
7749
  /**
7777
7750
  * Message to sign from wallet to confirm cancel order
7778
7751
  * @type {string}
7779
7752
  * @memberof GetSignableCancelOrderResponse
7780
7753
  */
7781
7754
  'signable_message': string;
7755
+ /**
7756
+ * IMX signed readable_transaction and payload_hash
7757
+ * @type {string}
7758
+ * @memberof GetSignableCancelOrderResponse
7759
+ */
7760
+ 'verification_signature': string;
7782
7761
  }
7783
7762
 
7784
7763
  /**
@@ -7812,6 +7791,25 @@ interface SignableToken {
7812
7791
  'type'?: string;
7813
7792
  }
7814
7793
 
7794
+ /**
7795
+ * Immutable X API
7796
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7797
+ *
7798
+ * The version of the OpenAPI document: 3.0
7799
+ * Contact: support@immutable.com
7800
+ *
7801
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7802
+ * https://openapi-generator.tech
7803
+ * Do not edit the class manually.
7804
+ */
7805
+
7806
+ /**
7807
+ * @type GetSignableDepositRequestToken
7808
+ * Details of the token the user is depositing
7809
+ * @export
7810
+ */
7811
+ declare type GetSignableDepositRequestToken = SignableToken;
7812
+
7815
7813
  /**
7816
7814
  * Immutable X API
7817
7815
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -7838,10 +7836,10 @@ interface GetSignableDepositRequest {
7838
7836
  'amount': string;
7839
7837
  /**
7840
7838
  *
7841
- * @type {SignableToken}
7839
+ * @type {GetSignableDepositRequestToken}
7842
7840
  * @memberof GetSignableDepositRequest
7843
7841
  */
7844
- 'token': SignableToken;
7842
+ 'token': GetSignableDepositRequestToken;
7845
7843
  /**
7846
7844
  * User who is depositing
7847
7845
  * @type {string}
@@ -7980,7 +7978,7 @@ interface GetSignableOrderRequestV3 {
7980
7978
  */
7981
7979
  'fees'?: Array<FeeEntry>;
7982
7980
  /**
7983
- * SplitFees dictates whether fees will be split between maker & taker, set split_fees to true when submitting signing to v3 endpoints and vice versa for v1
7981
+ * SplitFees is a deprecated field. It\'s value is ignored.
7984
7982
  * @type {boolean}
7985
7983
  * @memberof GetSignableOrderRequestV3
7986
7984
  */
@@ -8090,6 +8088,12 @@ interface GetSignableOrderResponse {
8090
8088
  * @memberof GetSignableOrderResponse
8091
8089
  */
8092
8090
  'payload_hash': string;
8091
+ /**
8092
+ * EIP-712 encoding of the StarkEx order transaction to be displayed to the user
8093
+ * @type {string}
8094
+ * @memberof GetSignableOrderResponse
8095
+ */
8096
+ 'readable_transaction': string;
8093
8097
  /**
8094
8098
  * Message to sign with L1 wallet to confirm order request
8095
8099
  * @type {string}
@@ -8114,6 +8118,12 @@ interface GetSignableOrderResponse {
8114
8118
  * @memberof GetSignableOrderResponse
8115
8119
  */
8116
8120
  'vault_id_sell': number;
8121
+ /**
8122
+ * IMX signed readable_transaction and payload_hash
8123
+ * @type {string}
8124
+ * @memberof GetSignableOrderResponse
8125
+ */
8126
+ 'verification_signature': string;
8117
8127
  }
8118
8128
 
8119
8129
  /**
@@ -8139,12 +8149,24 @@ interface GetSignableRegistrationOffchainResponse {
8139
8149
  * @memberof GetSignableRegistrationOffchainResponse
8140
8150
  */
8141
8151
  'payload_hash': string;
8152
+ /**
8153
+ * EIP-712 encoding of the StarkEx Register User Offchain request to be displayed to the user
8154
+ * @type {string}
8155
+ * @memberof GetSignableRegistrationOffchainResponse
8156
+ */
8157
+ 'readable_transaction': string;
8142
8158
  /**
8143
8159
  * Message to sign with L1 wallet to register user offchain
8144
8160
  * @type {string}
8145
8161
  * @memberof GetSignableRegistrationOffchainResponse
8146
8162
  */
8147
8163
  'signable_message': string;
8164
+ /**
8165
+ * IMX signed readable_transaction and payload_hash
8166
+ * @type {string}
8167
+ * @memberof GetSignableRegistrationOffchainResponse
8168
+ */
8169
+ 'verification_signature': string;
8148
8170
  }
8149
8171
 
8150
8172
  /**
@@ -8207,6 +8229,18 @@ interface GetSignableRegistrationResponse {
8207
8229
  * @memberof GetSignableRegistrationResponse
8208
8230
  */
8209
8231
  'payload_hash': string;
8232
+ /**
8233
+ * EIP-712 encoding of the StarkEx Register User request to be displayed to the user
8234
+ * @type {string}
8235
+ * @memberof GetSignableRegistrationResponse
8236
+ */
8237
+ 'readable_transaction': string;
8238
+ /**
8239
+ * IMX signed readable_transaction and payload_hash
8240
+ * @type {string}
8241
+ * @memberof GetSignableRegistrationResponse
8242
+ */
8243
+ 'verification_signature': string;
8210
8244
  }
8211
8245
 
8212
8246
  /**
@@ -8338,6 +8372,12 @@ interface GetSignableTradeResponse {
8338
8372
  * @memberof GetSignableTradeResponse
8339
8373
  */
8340
8374
  'payload_hash': string;
8375
+ /**
8376
+ * EIP-712 encoding of the StarkEx trade transaction to be displayed to the user
8377
+ * @type {string}
8378
+ * @memberof GetSignableTradeResponse
8379
+ */
8380
+ 'readable_transaction': string;
8341
8381
  /**
8342
8382
  * Message to sign with L1 wallet to confirm trade request
8343
8383
  * @type {string}
@@ -8362,8 +8402,33 @@ interface GetSignableTradeResponse {
8362
8402
  * @memberof GetSignableTradeResponse
8363
8403
  */
8364
8404
  'vault_id_sell': number;
8405
+ /**
8406
+ * IMX signed readable_transaction and payload_hash
8407
+ * @type {string}
8408
+ * @memberof GetSignableTradeResponse
8409
+ */
8410
+ 'verification_signature': string;
8365
8411
  }
8366
8412
 
8413
+ /**
8414
+ * Immutable X API
8415
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
8416
+ *
8417
+ * The version of the OpenAPI document: 3.0
8418
+ * Contact: support@immutable.com
8419
+ *
8420
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
8421
+ * https://openapi-generator.tech
8422
+ * Do not edit the class manually.
8423
+ */
8424
+
8425
+ /**
8426
+ * @type GetSignableTransferRequestToken
8427
+ * Token to transfer
8428
+ * @export
8429
+ */
8430
+ declare type GetSignableTransferRequestToken = SignableToken;
8431
+
8367
8432
  /**
8368
8433
  * Immutable X API
8369
8434
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -8379,27 +8444,33 @@ interface GetSignableTradeResponse {
8379
8444
  /**
8380
8445
  *
8381
8446
  * @export
8382
- * @interface SignableTransferDetails
8447
+ * @interface GetSignableTransferRequest
8383
8448
  */
8384
- interface SignableTransferDetails {
8449
+ interface GetSignableTransferRequest {
8385
8450
  /**
8386
8451
  * Amount of the token to transfer
8387
8452
  * @type {string}
8388
- * @memberof SignableTransferDetails
8453
+ * @memberof GetSignableTransferRequest
8389
8454
  */
8390
8455
  'amount': string;
8391
8456
  /**
8392
8457
  * Ethereum address of the receiving user
8393
8458
  * @type {string}
8394
- * @memberof SignableTransferDetails
8459
+ * @memberof GetSignableTransferRequest
8395
8460
  */
8396
8461
  'receiver': string;
8462
+ /**
8463
+ * Ethereum address of the transferring user
8464
+ * @type {string}
8465
+ * @memberof GetSignableTransferRequest
8466
+ */
8467
+ 'sender': string;
8397
8468
  /**
8398
8469
  *
8399
- * @type {SignableToken}
8400
- * @memberof SignableTransferDetails
8470
+ * @type {GetSignableTransferRequestToken}
8471
+ * @memberof GetSignableTransferRequest
8401
8472
  */
8402
- 'token': SignableToken;
8473
+ 'token': GetSignableTransferRequestToken;
8403
8474
  }
8404
8475
 
8405
8476
  /**
@@ -8417,23 +8488,54 @@ interface SignableTransferDetails {
8417
8488
  /**
8418
8489
  *
8419
8490
  * @export
8420
- * @interface GetSignableTransferRequest
8491
+ * @interface GetSignableTransferRequestV1
8421
8492
  */
8422
- interface GetSignableTransferRequest {
8493
+ interface GetSignableTransferRequestV1 {
8494
+ /**
8495
+ * Amount of the token to transfer
8496
+ * @type {string}
8497
+ * @memberof GetSignableTransferRequestV1
8498
+ */
8499
+ 'amount': string;
8500
+ /**
8501
+ * Ethereum address of the receiving user
8502
+ * @type {string}
8503
+ * @memberof GetSignableTransferRequestV1
8504
+ */
8505
+ 'receiver': string;
8423
8506
  /**
8424
8507
  * Ethereum address of the transferring user
8425
8508
  * @type {string}
8426
- * @memberof GetSignableTransferRequest
8509
+ * @memberof GetSignableTransferRequestV1
8427
8510
  */
8428
- 'sender_ether_key': string;
8511
+ 'sender': string;
8429
8512
  /**
8430
- * List of signable transfer details
8431
- * @type {Array<SignableTransferDetails>}
8432
- * @memberof GetSignableTransferRequest
8513
+ *
8514
+ * @type {SignableToken}
8515
+ * @memberof GetSignableTransferRequestV1
8433
8516
  */
8434
- 'signable_requests': Array<SignableTransferDetails>;
8517
+ 'token': SignableToken;
8435
8518
  }
8436
8519
 
8520
+ /**
8521
+ * Immutable X API
8522
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
8523
+ *
8524
+ * The version of the OpenAPI document: 3.0
8525
+ * Contact: support@immutable.com
8526
+ *
8527
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
8528
+ * https://openapi-generator.tech
8529
+ * Do not edit the class manually.
8530
+ */
8531
+
8532
+ /**
8533
+ * @type SignableTransferDetailsV2Token
8534
+ * Token to transfer
8535
+ * @export
8536
+ */
8537
+ declare type SignableTransferDetailsV2Token = SignableToken;
8538
+
8437
8539
  /**
8438
8540
  * Immutable X API
8439
8541
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -8449,35 +8551,80 @@ interface GetSignableTransferRequest {
8449
8551
  /**
8450
8552
  *
8451
8553
  * @export
8452
- * @interface GetSignableTransferRequestV1
8554
+ * @interface SignableTransferDetailsV2
8453
8555
  */
8454
- interface GetSignableTransferRequestV1 {
8556
+ interface SignableTransferDetailsV2 {
8455
8557
  /**
8456
8558
  * Amount of the token to transfer
8457
8559
  * @type {string}
8458
- * @memberof GetSignableTransferRequestV1
8560
+ * @memberof SignableTransferDetailsV2
8459
8561
  */
8460
8562
  'amount': string;
8461
8563
  /**
8462
8564
  * Ethereum address of the receiving user
8463
8565
  * @type {string}
8464
- * @memberof GetSignableTransferRequestV1
8566
+ * @memberof SignableTransferDetailsV2
8465
8567
  */
8466
8568
  'receiver': string;
8569
+ /**
8570
+ *
8571
+ * @type {SignableTransferDetailsV2Token}
8572
+ * @memberof SignableTransferDetailsV2
8573
+ */
8574
+ 'token': SignableTransferDetailsV2Token;
8575
+ }
8576
+
8577
+ /**
8578
+ * Immutable X API
8579
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
8580
+ *
8581
+ * The version of the OpenAPI document: 3.0
8582
+ * Contact: support@immutable.com
8583
+ *
8584
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
8585
+ * https://openapi-generator.tech
8586
+ * Do not edit the class manually.
8587
+ */
8588
+
8589
+ /**
8590
+ *
8591
+ * @export
8592
+ * @interface GetSignableTransferRequestV2
8593
+ */
8594
+ interface GetSignableTransferRequestV2 {
8467
8595
  /**
8468
8596
  * Ethereum address of the transferring user
8469
8597
  * @type {string}
8470
- * @memberof GetSignableTransferRequestV1
8598
+ * @memberof GetSignableTransferRequestV2
8471
8599
  */
8472
- 'sender': string;
8600
+ 'sender_ether_key': string;
8473
8601
  /**
8474
- *
8475
- * @type {SignableToken}
8476
- * @memberof GetSignableTransferRequestV1
8602
+ * List of signable transfer details
8603
+ * @type {Array<SignableTransferDetailsV2>}
8604
+ * @memberof GetSignableTransferRequestV2
8477
8605
  */
8478
- 'token': SignableToken;
8606
+ 'signable_requests': Array<SignableTransferDetailsV2>;
8479
8607
  }
8480
8608
 
8609
+ /**
8610
+ * Immutable X API
8611
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
8612
+ *
8613
+ * The version of the OpenAPI document: 3.0
8614
+ * Contact: support@immutable.com
8615
+ *
8616
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
8617
+ * https://openapi-generator.tech
8618
+ * Do not edit the class manually.
8619
+ */
8620
+
8621
+ /**
8622
+ * @type SignableTransferResponseDetailsToken
8623
+ * Token in request to match in SDK implementation
8624
+ * @export
8625
+ */
8626
+ declare type SignableTransferResponseDetailsToken = SignableToken;
8627
+
8481
8628
  /**
8482
8629
  * Immutable X API
8483
8630
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -8526,6 +8673,12 @@ interface SignableTransferResponseDetails {
8526
8673
  * @memberof SignableTransferResponseDetails
8527
8674
  */
8528
8675
  'payload_hash': string;
8676
+ /**
8677
+ * EIP-712 encoding of the StarkEx transfer request to be displayed to the user
8678
+ * @type {string}
8679
+ * @memberof SignableTransferResponseDetails
8680
+ */
8681
+ 'readable_transaction': string;
8529
8682
  /**
8530
8683
  * Receiver of the transfer
8531
8684
  * @type {string}
@@ -8546,48 +8699,16 @@ interface SignableTransferResponseDetails {
8546
8699
  'sender_vault_id': number;
8547
8700
  /**
8548
8701
  *
8549
- * @type {SignableToken}
8702
+ * @type {SignableTransferResponseDetailsToken}
8550
8703
  * @memberof SignableTransferResponseDetails
8551
8704
  */
8552
- 'token': SignableToken;
8553
- }
8554
-
8555
- /**
8556
- * Immutable X API
8557
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
8558
- *
8559
- * The version of the OpenAPI document: 3.0
8560
- * Contact: support@immutable.com
8561
- *
8562
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
8563
- * https://openapi-generator.tech
8564
- * Do not edit the class manually.
8565
- */
8566
-
8567
- /**
8568
- *
8569
- * @export
8570
- * @interface GetSignableTransferResponse
8571
- */
8572
- interface GetSignableTransferResponse {
8573
- /**
8574
- * Sender of the transfer
8575
- * @type {string}
8576
- * @memberof GetSignableTransferResponse
8577
- */
8578
- 'sender_stark_key': string;
8705
+ 'token': SignableTransferResponseDetailsToken;
8579
8706
  /**
8580
- * Message to sign with L1 wallet to confirm transfer request
8707
+ * IMX signed readable_transaction and payload_hash
8581
8708
  * @type {string}
8582
- * @memberof GetSignableTransferResponse
8583
- */
8584
- 'signable_message': string;
8585
- /**
8586
- * List of transfer responses without the sender stark key
8587
- * @type {Array<SignableTransferResponseDetails>}
8588
- * @memberof GetSignableTransferResponse
8709
+ * @memberof SignableTransferResponseDetails
8589
8710
  */
8590
- 'signable_responses': Array<SignableTransferResponseDetails>;
8711
+ 'verification_signature': string;
8591
8712
  }
8592
8713
 
8593
8714
  /**
@@ -8637,6 +8758,12 @@ interface GetSignableTransferResponseV1 {
8637
8758
  * @memberof GetSignableTransferResponseV1
8638
8759
  */
8639
8760
  'payload_hash': string;
8761
+ /**
8762
+ * EIP-712 encoding of the StarkEx transfer transaction to be displayed to the user
8763
+ * @type {string}
8764
+ * @memberof GetSignableTransferResponseV1
8765
+ */
8766
+ 'readable_transaction': string;
8640
8767
  /**
8641
8768
  * Receiver of the transfer
8642
8769
  * @type {string}
@@ -8667,8 +8794,71 @@ interface GetSignableTransferResponseV1 {
8667
8794
  * @memberof GetSignableTransferResponseV1
8668
8795
  */
8669
8796
  'signable_message': string;
8797
+ /**
8798
+ * IMX signed readable_transaction and payload_hash
8799
+ * @type {string}
8800
+ * @memberof GetSignableTransferResponseV1
8801
+ */
8802
+ 'verification_signature': string;
8803
+ }
8804
+
8805
+ /**
8806
+ * Immutable X API
8807
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
8808
+ *
8809
+ * The version of the OpenAPI document: 3.0
8810
+ * Contact: support@immutable.com
8811
+ *
8812
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
8813
+ * https://openapi-generator.tech
8814
+ * Do not edit the class manually.
8815
+ */
8816
+
8817
+ /**
8818
+ *
8819
+ * @export
8820
+ * @interface GetSignableTransferResponseV2
8821
+ */
8822
+ interface GetSignableTransferResponseV2 {
8823
+ /**
8824
+ * Sender of the transfer
8825
+ * @type {string}
8826
+ * @memberof GetSignableTransferResponseV2
8827
+ */
8828
+ 'sender_stark_key': string;
8829
+ /**
8830
+ * Message to sign with L1 wallet to confirm transfer request
8831
+ * @type {string}
8832
+ * @memberof GetSignableTransferResponseV2
8833
+ */
8834
+ 'signable_message': string;
8835
+ /**
8836
+ * List of transfer responses without the sender stark key
8837
+ * @type {Array<SignableTransferResponseDetails>}
8838
+ * @memberof GetSignableTransferResponseV2
8839
+ */
8840
+ 'signable_responses': Array<SignableTransferResponseDetails>;
8670
8841
  }
8671
8842
 
8843
+ /**
8844
+ * Immutable X API
8845
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
8846
+ *
8847
+ * The version of the OpenAPI document: 3.0
8848
+ * Contact: support@immutable.com
8849
+ *
8850
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
8851
+ * https://openapi-generator.tech
8852
+ * Do not edit the class manually.
8853
+ */
8854
+
8855
+ /**
8856
+ * @type GetSignableWithdrawalRequestToken
8857
+ * Token to withdraw
8858
+ * @export
8859
+ */
8860
+ declare type GetSignableWithdrawalRequestToken = SignableToken;
8861
+
8672
8862
  /**
8673
8863
  * Immutable X API
8674
8864
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -8695,10 +8885,10 @@ interface GetSignableWithdrawalRequest {
8695
8885
  'amount': string;
8696
8886
  /**
8697
8887
  *
8698
- * @type {SignableToken}
8888
+ * @type {GetSignableWithdrawalRequestToken}
8699
8889
  * @memberof GetSignableWithdrawalRequest
8700
8890
  */
8701
- 'token': SignableToken;
8891
+ 'token': GetSignableWithdrawalRequestToken;
8702
8892
  /**
8703
8893
  * Ethereum address of the user who is making this withdrawal
8704
8894
  * @type {string}
@@ -8748,6 +8938,12 @@ interface GetSignableWithdrawalResponse {
8748
8938
  * @memberof GetSignableWithdrawalResponse
8749
8939
  */
8750
8940
  'payload_hash': string;
8941
+ /**
8942
+ * EIP-712 encoding of the StarkEx withdrawal request to be displayed to the user
8943
+ * @type {string}
8944
+ * @memberof GetSignableWithdrawalResponse
8945
+ */
8946
+ 'readable_transaction': string;
8751
8947
  /**
8752
8948
  * Message to sign with L1 wallet to verity withdrawal request
8753
8949
  * @type {string}
@@ -8766,6 +8962,12 @@ interface GetSignableWithdrawalResponse {
8766
8962
  * @memberof GetSignableWithdrawalResponse
8767
8963
  */
8768
8964
  'vault_id': number;
8965
+ /**
8966
+ * IMX signed readable_transaction and payload_hash
8967
+ * @type {string}
8968
+ * @memberof GetSignableWithdrawalResponse
8969
+ */
8970
+ 'verification_signature': string;
8769
8971
  }
8770
8972
 
8771
8973
  /**
@@ -8983,6 +9185,25 @@ interface ListDepositsResponse {
8983
9185
  'result': Array<Deposit>;
8984
9186
  }
8985
9187
 
9188
+ /**
9189
+ * Immutable X API
9190
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
9191
+ *
9192
+ * The version of the OpenAPI document: 3.0
9193
+ * Contact: support@immutable.com
9194
+ *
9195
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9196
+ * https://openapi-generator.tech
9197
+ * Do not edit the class manually.
9198
+ */
9199
+
9200
+ /**
9201
+ * @type MintToken
9202
+ * Details of the asset which has been minted
9203
+ * @export
9204
+ */
9205
+ declare type MintToken = Token;
9206
+
8986
9207
  /**
8987
9208
  * Immutable X API
8988
9209
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -9021,10 +9242,10 @@ interface Mint {
9021
9242
  'timestamp': string;
9022
9243
  /**
9023
9244
  *
9024
- * @type {Token}
9245
+ * @type {MintToken}
9025
9246
  * @memberof Mint
9026
9247
  */
9027
- 'token': Token;
9248
+ 'token': MintToken;
9028
9249
  /**
9029
9250
  * Sequential ID of transaction in Immutable X
9030
9251
  * @type {number}
@@ -9090,11 +9311,11 @@ interface ListMintsResponse {
9090
9311
  */
9091
9312
 
9092
9313
  /**
9093
- * @type OrderBuy
9314
+ * @type OrderV3Buy
9094
9315
  * Details of the asset being bought
9095
9316
  * @export
9096
9317
  */
9097
- declare type OrderBuy = Token;
9318
+ declare type OrderV3Buy = Token;
9098
9319
 
9099
9320
  /**
9100
9321
  * Immutable X API
@@ -9109,11 +9330,48 @@ declare type OrderBuy = Token;
9109
9330
  */
9110
9331
 
9111
9332
  /**
9112
- * @type OrderSell
9113
- * Details of the asset being sold
9333
+ *
9114
9334
  * @export
9335
+ * @interface OrdersMakerTakerFee
9115
9336
  */
9116
- declare type OrderSell = Token;
9337
+ interface OrdersMakerTakerFee {
9338
+ /**
9339
+ * Number of Decimals supported the fee token
9340
+ * @type {number}
9341
+ * @memberof OrdersMakerTakerFee
9342
+ */
9343
+ 'decimals'?: number;
9344
+ /**
9345
+ * Fees
9346
+ * @type {Array<OrderFeeInfo>}
9347
+ * @memberof OrdersMakerTakerFee
9348
+ */
9349
+ 'fees'?: Array<OrderFeeInfo>;
9350
+ /**
9351
+ * Quantity of this asset with the sum of all fees applied to the asset
9352
+ * @type {string}
9353
+ * @memberof OrdersMakerTakerFee
9354
+ */
9355
+ 'quantity_with_fees': string;
9356
+ /**
9357
+ * Symbol of the fee token
9358
+ * @type {string}
9359
+ * @memberof OrdersMakerTakerFee
9360
+ */
9361
+ 'symbol'?: string;
9362
+ /**
9363
+ * Address of the ERC20 contract for the fee token
9364
+ * @type {string}
9365
+ * @memberof OrdersMakerTakerFee
9366
+ */
9367
+ 'token_address'?: string;
9368
+ /**
9369
+ * Type of the fee token (ETH/ERC20)
9370
+ * @type {string}
9371
+ * @memberof OrdersMakerTakerFee
9372
+ */
9373
+ 'token_type'?: string;
9374
+ }
9117
9375
 
9118
9376
  /**
9119
9377
  * Immutable X API
@@ -9128,201 +9386,8 @@ declare type OrderSell = Token;
9128
9386
  */
9129
9387
 
9130
9388
  /**
9131
- *
9132
- * @export
9133
- * @interface Order
9134
- */
9135
- interface Order$2 {
9136
- /**
9137
- * Amount of the asset already sold by this order
9138
- * @type {string}
9139
- * @memberof Order
9140
- */
9141
- 'amount_sold': string | null;
9142
- /**
9143
- *
9144
- * @type {OrderBuy}
9145
- * @memberof Order
9146
- */
9147
- 'buy': OrderBuy;
9148
- /**
9149
- * Expiration timestamp of this order
9150
- * @type {string}
9151
- * @memberof Order
9152
- */
9153
- 'expiration_timestamp': string | null;
9154
- /**
9155
- * Fee information for the order
9156
- * @type {Array<OrderFeeInfo>}
9157
- * @memberof Order
9158
- */
9159
- 'fees'?: Array<OrderFeeInfo>;
9160
- /**
9161
- * ID of the order
9162
- * @type {number}
9163
- * @memberof Order
9164
- */
9165
- 'order_id': number;
9166
- /**
9167
- *
9168
- * @type {OrderSell}
9169
- * @memberof Order
9170
- */
9171
- 'sell': OrderSell;
9172
- /**
9173
- * Status of the order
9174
- * @type {string}
9175
- * @memberof Order
9176
- */
9177
- 'status': string;
9178
- /**
9179
- * Timestamp this order was created
9180
- * @type {string}
9181
- * @memberof Order
9182
- */
9183
- 'timestamp': string | null;
9184
- /**
9185
- * Updated timestamp of this order
9186
- * @type {string}
9187
- * @memberof Order
9188
- */
9189
- 'updated_timestamp': string | null;
9190
- /**
9191
- * Ethereum address of the user who submitted the order
9192
- * @type {string}
9193
- * @memberof Order
9194
- */
9195
- 'user': string;
9196
- }
9197
-
9198
- /**
9199
- * Immutable X API
9200
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
9201
- *
9202
- * The version of the OpenAPI document: 3.0
9203
- * Contact: support@immutable.com
9204
- *
9205
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9206
- * https://openapi-generator.tech
9207
- * Do not edit the class manually.
9208
- */
9209
-
9210
- /**
9211
- *
9212
- * @export
9213
- * @interface ListOrdersResponse
9214
- */
9215
- interface ListOrdersResponse {
9216
- /**
9217
- * Generated cursor returned by previous query
9218
- * @type {string}
9219
- * @memberof ListOrdersResponse
9220
- */
9221
- 'cursor': string;
9222
- /**
9223
- * Remaining results flag. 1: there are remaining results matching this query, 0: no remaining results
9224
- * @type {number}
9225
- * @memberof ListOrdersResponse
9226
- */
9227
- 'remaining': number;
9228
- /**
9229
- * Orders matching query parameters
9230
- * @type {Array<Order>}
9231
- * @memberof ListOrdersResponse
9232
- */
9233
- 'result': Array<Order$2>;
9234
- }
9235
-
9236
- /**
9237
- * Immutable X API
9238
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
9239
- *
9240
- * The version of the OpenAPI document: 3.0
9241
- * Contact: support@immutable.com
9242
- *
9243
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9244
- * https://openapi-generator.tech
9245
- * Do not edit the class manually.
9246
- */
9247
-
9248
- /**
9249
- * @type OrderV3Buy
9250
- * Details of the asset being bought
9251
- * @export
9252
- */
9253
- declare type OrderV3Buy = Token;
9254
-
9255
- /**
9256
- * Immutable X API
9257
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
9258
- *
9259
- * The version of the OpenAPI document: 3.0
9260
- * Contact: support@immutable.com
9261
- *
9262
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9263
- * https://openapi-generator.tech
9264
- * Do not edit the class manually.
9265
- */
9266
-
9267
- /**
9268
- *
9269
- * @export
9270
- * @interface OrdersMakerTakerFee
9271
- */
9272
- interface OrdersMakerTakerFee {
9273
- /**
9274
- * Number of Decimals supported the fee token
9275
- * @type {number}
9276
- * @memberof OrdersMakerTakerFee
9277
- */
9278
- 'decimals'?: number;
9279
- /**
9280
- * Fees
9281
- * @type {Array<OrderFeeInfo>}
9282
- * @memberof OrdersMakerTakerFee
9283
- */
9284
- 'fees'?: Array<OrderFeeInfo>;
9285
- /**
9286
- * Quantity of this asset with the sum of all fees applied to the asset
9287
- * @type {string}
9288
- * @memberof OrdersMakerTakerFee
9289
- */
9290
- 'quantity_with_fees': string;
9291
- /**
9292
- * Symbol of the fee token
9293
- * @type {string}
9294
- * @memberof OrdersMakerTakerFee
9295
- */
9296
- 'symbol'?: string;
9297
- /**
9298
- * Address of the ERC20 contract for the fee token
9299
- * @type {string}
9300
- * @memberof OrdersMakerTakerFee
9301
- */
9302
- 'token_address'?: string;
9303
- /**
9304
- * Type of the fee token (ETH/ERC20)
9305
- * @type {string}
9306
- * @memberof OrdersMakerTakerFee
9307
- */
9308
- 'token_type'?: string;
9309
- }
9310
-
9311
- /**
9312
- * Immutable X API
9313
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
9314
- *
9315
- * The version of the OpenAPI document: 3.0
9316
- * Contact: support@immutable.com
9317
- *
9318
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9319
- * https://openapi-generator.tech
9320
- * Do not edit the class manually.
9321
- */
9322
-
9323
- /**
9324
- * @type OrderV3MakerFees
9325
- * MakerFees is the information about the fees that needs to be paid by the maker (liquidity)
9389
+ * @type OrderV3MakerFees
9390
+ * MakerFees is the information about the fees that needs to be paid by the maker (liquidity)
9326
9391
  * @export
9327
9392
  */
9328
9393
  declare type OrderV3MakerFees = OrdersMakerTakerFee;
@@ -9549,7 +9614,7 @@ interface TokenDetails {
9549
9614
  */
9550
9615
  'symbol': string;
9551
9616
  /**
9552
- * Address of the ERC721 contract
9617
+ * Address of the ERC20 contract
9553
9618
  * @type {string}
9554
9619
  * @memberof TokenDetails
9555
9620
  */
@@ -9763,6 +9828,25 @@ interface ListTradesResponse {
9763
9828
  'result': Array<Trade$2>;
9764
9829
  }
9765
9830
 
9831
+ /**
9832
+ * Immutable X API
9833
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
9834
+ *
9835
+ * The version of the OpenAPI document: 3.0
9836
+ * Contact: support@immutable.com
9837
+ *
9838
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9839
+ * https://openapi-generator.tech
9840
+ * Do not edit the class manually.
9841
+ */
9842
+
9843
+ /**
9844
+ * @type TransferToken
9845
+ * Token transferred by the user
9846
+ * @export
9847
+ */
9848
+ declare type TransferToken = Token;
9849
+
9766
9850
  /**
9767
9851
  * Immutable X API
9768
9852
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -9801,10 +9885,10 @@ interface Transfer {
9801
9885
  'timestamp': string | null;
9802
9886
  /**
9803
9887
  *
9804
- * @type {Token}
9888
+ * @type {TransferToken}
9805
9889
  * @memberof Transfer
9806
9890
  */
9807
- 'token': Token;
9891
+ 'token': TransferToken;
9808
9892
  /**
9809
9893
  * Sequential transaction ID
9810
9894
  * @type {number}
@@ -9857,6 +9941,25 @@ interface ListTransfersResponse {
9857
9941
  'result': Array<Transfer>;
9858
9942
  }
9859
9943
 
9944
+ /**
9945
+ * Immutable X API
9946
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
9947
+ *
9948
+ * The version of the OpenAPI document: 3.0
9949
+ * Contact: support@immutable.com
9950
+ *
9951
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9952
+ * https://openapi-generator.tech
9953
+ * Do not edit the class manually.
9954
+ */
9955
+
9956
+ /**
9957
+ * @type WithdrawalToken
9958
+ * Details of the asset this user is withdrawing
9959
+ * @export
9960
+ */
9961
+ declare type WithdrawalToken = Token;
9962
+
9860
9963
  /**
9861
9964
  * Immutable X API
9862
9965
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -9901,10 +10004,10 @@ interface Withdrawal {
9901
10004
  'timestamp': string;
9902
10005
  /**
9903
10006
  *
9904
- * @type {Token}
10007
+ * @type {WithdrawalToken}
9905
10008
  * @memberof Withdrawal
9906
10009
  */
9907
- 'token': Token;
10010
+ 'token': WithdrawalToken;
9908
10011
  /**
9909
10012
  * Sequential ID of this transaction
9910
10013
  * @type {number}
@@ -10613,6 +10716,43 @@ interface NftprimarytransactionListTransactionsResponse {
10613
10716
  'result'?: Array<NftprimarytransactionTransactionData>;
10614
10717
  }
10615
10718
 
10719
+ /**
10720
+ * Immutable X API
10721
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
10722
+ *
10723
+ * The version of the OpenAPI document: 3.0
10724
+ * Contact: support@immutable.com
10725
+ *
10726
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
10727
+ * https://openapi-generator.tech
10728
+ * Do not edit the class manually.
10729
+ */
10730
+ /**
10731
+ *
10732
+ * @export
10733
+ * @interface RegisterPassportUserResult
10734
+ */
10735
+ interface RegisterPassportUserResult {
10736
+ /**
10737
+ * The ether key of the user
10738
+ * @type {string}
10739
+ * @memberof RegisterPassportUserResult
10740
+ */
10741
+ 'ether_key'?: string;
10742
+ /**
10743
+ * The stark key of the user
10744
+ * @type {string}
10745
+ * @memberof RegisterPassportUserResult
10746
+ */
10747
+ 'stark_key'?: string;
10748
+ /**
10749
+ * The admin key of the user
10750
+ * @type {string}
10751
+ * @memberof RegisterPassportUserResult
10752
+ */
10753
+ 'user_admin_key'?: string;
10754
+ }
10755
+
10616
10756
  /**
10617
10757
  * Immutable X API
10618
10758
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -12350,422 +12490,129 @@ declare class NftCheckoutPrimaryApi extends BaseAPI {
12350
12490
  registerNftPrimarySalesContract(requestParameters: NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ContractCreateResponse, any>>;
12351
12491
  }
12352
12492
  /**
12353
- * Request parameters for cancelOrder operation in OrdersApi.
12493
+ * Request parameters for cancelOrderV3 operation in OrdersApi.
12354
12494
  * @export
12355
- * @interface OrdersApiCancelOrderRequest
12495
+ * @interface OrdersApiCancelOrderV3Request
12356
12496
  */
12357
- interface OrdersApiCancelOrderRequest {
12358
- /**
12359
- * Order ID to cancel
12360
- * @type {string}
12361
- * @memberof OrdersApiCancelOrder
12362
- */
12363
- readonly id: string;
12364
- /**
12365
- * cancel an order
12366
- * @type {CancelOrderRequest}
12367
- * @memberof OrdersApiCancelOrder
12368
- */
12369
- readonly cancelOrderRequest: CancelOrderRequest;
12370
- /**
12371
- * eth address
12372
- * @type {string}
12373
- * @memberof OrdersApiCancelOrder
12374
- */
12375
- readonly xImxEthAddress?: string;
12376
- /**
12377
- * eth signature
12378
- * @type {string}
12379
- * @memberof OrdersApiCancelOrder
12380
- */
12381
- readonly xImxEthSignature?: string;
12497
+ interface OrdersApiCancelOrderV3Request {
12382
12498
  /**
12383
- * Authorization header
12384
- * @type {string}
12385
- * @memberof OrdersApiCancelOrder
12386
- */
12387
- readonly authorization?: string;
12388
- }
12389
- /**
12390
- * Request parameters for cancelOrderV3 operation in OrdersApi.
12391
- * @export
12392
- * @interface OrdersApiCancelOrderV3Request
12393
- */
12394
- interface OrdersApiCancelOrderV3Request {
12395
- /**
12396
- * Order ID to cancel
12397
- * @type {string}
12398
- * @memberof OrdersApiCancelOrderV3
12399
- */
12400
- readonly id: string;
12401
- /**
12402
- * cancel an order
12403
- * @type {CancelOrderRequest}
12404
- * @memberof OrdersApiCancelOrderV3
12405
- */
12406
- readonly cancelOrderRequest: CancelOrderRequest;
12407
- /**
12408
- * eth address
12409
- * @type {string}
12410
- * @memberof OrdersApiCancelOrderV3
12411
- */
12412
- readonly xImxEthAddress?: string;
12413
- /**
12414
- * eth signature
12415
- * @type {string}
12416
- * @memberof OrdersApiCancelOrderV3
12417
- */
12418
- readonly xImxEthSignature?: string;
12419
- /**
12420
- * Authorization header
12421
- * @type {string}
12422
- * @memberof OrdersApiCancelOrderV3
12423
- */
12424
- readonly authorization?: string;
12425
- }
12426
- /**
12427
- * Request parameters for createOrder operation in OrdersApi.
12428
- * @export
12429
- * @interface OrdersApiCreateOrderRequest
12430
- */
12431
- interface OrdersApiCreateOrderRequest {
12432
- /**
12433
- * create an order
12434
- * @type {CreateOrderRequest}
12435
- * @memberof OrdersApiCreateOrder
12436
- */
12437
- readonly createOrderRequest: CreateOrderRequest;
12438
- /**
12439
- * eth address
12440
- * @type {string}
12441
- * @memberof OrdersApiCreateOrder
12442
- */
12443
- readonly xImxEthAddress?: string;
12444
- /**
12445
- * eth signature
12446
- * @type {string}
12447
- * @memberof OrdersApiCreateOrder
12448
- */
12449
- readonly xImxEthSignature?: string;
12450
- /**
12451
- * Authorization header
12452
- * @type {string}
12453
- * @memberof OrdersApiCreateOrder
12454
- */
12455
- readonly authorization?: string;
12456
- }
12457
- /**
12458
- * Request parameters for createOrderV3 operation in OrdersApi.
12459
- * @export
12460
- * @interface OrdersApiCreateOrderV3Request
12461
- */
12462
- interface OrdersApiCreateOrderV3Request {
12463
- /**
12464
- * create an order
12465
- * @type {CreateOrderRequestV3}
12466
- * @memberof OrdersApiCreateOrderV3
12467
- */
12468
- readonly createOrderRequest: CreateOrderRequestV3;
12469
- /**
12470
- * eth address
12471
- * @type {string}
12472
- * @memberof OrdersApiCreateOrderV3
12473
- */
12474
- readonly xImxEthAddress?: string;
12475
- /**
12476
- * eth signature
12477
- * @type {string}
12478
- * @memberof OrdersApiCreateOrderV3
12479
- */
12480
- readonly xImxEthSignature?: string;
12481
- /**
12482
- * Authorization header
12483
- * @type {string}
12484
- * @memberof OrdersApiCreateOrderV3
12485
- */
12486
- readonly authorization?: string;
12487
- }
12488
- /**
12489
- * Request parameters for getOrder operation in OrdersApi.
12490
- * @export
12491
- * @interface OrdersApiGetOrderRequest
12492
- */
12493
- interface OrdersApiGetOrderRequest {
12494
- /**
12495
- * Order ID
12496
- * @type {string}
12497
- * @memberof OrdersApiGetOrder
12498
- */
12499
- readonly id: string;
12500
- /**
12501
- * Set flag to true to include fee body for the order
12502
- * @type {boolean}
12503
- * @memberof OrdersApiGetOrder
12504
- */
12505
- readonly includeFees?: boolean;
12506
- /**
12507
- * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
12508
- * @type {string}
12509
- * @memberof OrdersApiGetOrder
12510
- */
12511
- readonly auxiliaryFeePercentages?: string;
12512
- /**
12513
- * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
12514
- * @type {string}
12515
- * @memberof OrdersApiGetOrder
12516
- */
12517
- readonly auxiliaryFeeRecipients?: string;
12518
- }
12519
- /**
12520
- * Request parameters for getOrderV3 operation in OrdersApi.
12521
- * @export
12522
- * @interface OrdersApiGetOrderV3Request
12523
- */
12524
- interface OrdersApiGetOrderV3Request {
12525
- /**
12526
- * Order ID
12527
- * @type {string}
12528
- * @memberof OrdersApiGetOrderV3
12529
- */
12530
- readonly id: string;
12531
- /**
12532
- * Set flag to true to include fee body for the order
12533
- * @type {boolean}
12534
- * @memberof OrdersApiGetOrderV3
12535
- */
12536
- readonly includeFees?: boolean;
12537
- /**
12538
- * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
12539
- * @type {string}
12540
- * @memberof OrdersApiGetOrderV3
12541
- */
12542
- readonly auxiliaryFeePercentages?: string;
12543
- /**
12544
- * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
12545
- * @type {string}
12546
- * @memberof OrdersApiGetOrderV3
12547
- */
12548
- readonly auxiliaryFeeRecipients?: string;
12549
- }
12550
- /**
12551
- * Request parameters for getSignableCancelOrder operation in OrdersApi.
12552
- * @export
12553
- * @interface OrdersApiGetSignableCancelOrderRequest
12554
- */
12555
- interface OrdersApiGetSignableCancelOrderRequest {
12556
- /**
12557
- * get a signable cancel order
12558
- * @type {GetSignableCancelOrderRequest}
12559
- * @memberof OrdersApiGetSignableCancelOrder
12560
- */
12561
- readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
12562
- }
12563
- /**
12564
- * Request parameters for getSignableCancelOrderV3 operation in OrdersApi.
12565
- * @export
12566
- * @interface OrdersApiGetSignableCancelOrderV3Request
12567
- */
12568
- interface OrdersApiGetSignableCancelOrderV3Request {
12569
- /**
12570
- * get a signable cancel order
12571
- * @type {GetSignableCancelOrderRequest}
12572
- * @memberof OrdersApiGetSignableCancelOrderV3
12573
- */
12574
- readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
12575
- }
12576
- /**
12577
- * Request parameters for getSignableOrder operation in OrdersApi.
12578
- * @export
12579
- * @interface OrdersApiGetSignableOrderRequest
12580
- */
12581
- interface OrdersApiGetSignableOrderRequest {
12582
- /**
12583
- * get a signable order v3
12584
- * @type {GetSignableOrderRequestV3}
12585
- * @memberof OrdersApiGetSignableOrder
12586
- */
12587
- readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
12588
- }
12589
- /**
12590
- * Request parameters for listOrders operation in OrdersApi.
12591
- * @export
12592
- * @interface OrdersApiListOrdersRequest
12593
- */
12594
- interface OrdersApiListOrdersRequest {
12595
- /**
12596
- * Page size of the result
12597
- * @type {number}
12598
- * @memberof OrdersApiListOrders
12599
- */
12600
- readonly pageSize?: number;
12601
- /**
12602
- * Cursor
12603
- * @type {string}
12604
- * @memberof OrdersApiListOrders
12605
- */
12606
- readonly cursor?: string;
12607
- /**
12608
- * Property to sort by
12609
- * @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
12610
- * @memberof OrdersApiListOrders
12611
- */
12612
- readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
12613
- /**
12614
- * Direction to sort (asc/desc)
12615
- * @type {string}
12616
- * @memberof OrdersApiListOrders
12617
- */
12618
- readonly direction?: string;
12619
- /**
12620
- * Ethereum address of the user who submitted this order
12621
- * @type {string}
12622
- * @memberof OrdersApiListOrders
12623
- */
12624
- readonly user?: string;
12625
- /**
12626
- * Status of this order
12627
- * @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
12628
- * @memberof OrdersApiListOrders
12629
- */
12630
- readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
12631
- /**
12632
- * Filter orders to include those with created_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
12633
- * @type {string}
12634
- * @memberof OrdersApiListOrders
12635
- */
12636
- readonly minTimestamp?: string;
12637
- /**
12638
- * Filter orders to include those with created_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
12639
- * @type {string}
12640
- * @memberof OrdersApiListOrders
12641
- */
12642
- readonly maxTimestamp?: string;
12643
- /**
12644
- * Filter orders to include those with updated_at timestamps after this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
12645
- * @type {string}
12646
- * @memberof OrdersApiListOrders
12647
- */
12648
- readonly updatedMinTimestamp?: string;
12649
- /**
12650
- * Filter orders to include those with updated_at timestamps before this time, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
12651
- * @type {string}
12652
- * @memberof OrdersApiListOrders
12653
- */
12654
- readonly updatedMaxTimestamp?: string;
12655
- /**
12656
- * Token type of the asset this order buys
12657
- * @type {string}
12658
- * @memberof OrdersApiListOrders
12659
- */
12660
- readonly buyTokenType?: string;
12661
- /**
12662
- * ERC721 Token ID of the asset this order buys
12663
- * @type {string}
12664
- * @memberof OrdersApiListOrders
12665
- */
12666
- readonly buyTokenId?: string;
12667
- /**
12668
- * Internal IMX ID of the asset this order buys
12669
- * @type {string}
12670
- * @memberof OrdersApiListOrders
12671
- */
12672
- readonly buyAssetId?: string;
12673
- /**
12674
- * Token address of the asset this order buys
12675
- * @type {string}
12676
- * @memberof OrdersApiListOrders
12677
- */
12678
- readonly buyTokenAddress?: string;
12679
- /**
12680
- * Token name of the asset this order buys
12681
- * @type {string}
12682
- * @memberof OrdersApiListOrders
12683
- */
12684
- readonly buyTokenName?: string;
12685
- /**
12686
- * Min quantity for the asset this order buys
12499
+ * Order ID to cancel
12687
12500
  * @type {string}
12688
- * @memberof OrdersApiListOrders
12501
+ * @memberof OrdersApiCancelOrderV3
12689
12502
  */
12690
- readonly buyMinQuantity?: string;
12503
+ readonly id: string;
12691
12504
  /**
12692
- * Max quantity for the asset this order buys
12693
- * @type {string}
12694
- * @memberof OrdersApiListOrders
12505
+ * cancel an order
12506
+ * @type {CancelOrderRequest}
12507
+ * @memberof OrdersApiCancelOrderV3
12695
12508
  */
12696
- readonly buyMaxQuantity?: string;
12509
+ readonly cancelOrderRequest: CancelOrderRequest;
12697
12510
  /**
12698
- * JSON-encoded metadata filters for the asset this order buys
12511
+ * eth address
12699
12512
  * @type {string}
12700
- * @memberof OrdersApiListOrders
12513
+ * @memberof OrdersApiCancelOrderV3
12701
12514
  */
12702
- readonly buyMetadata?: string;
12515
+ readonly xImxEthAddress?: string;
12703
12516
  /**
12704
- * Token type of the asset this order sells
12517
+ * eth signature
12705
12518
  * @type {string}
12706
- * @memberof OrdersApiListOrders
12519
+ * @memberof OrdersApiCancelOrderV3
12707
12520
  */
12708
- readonly sellTokenType?: string;
12521
+ readonly xImxEthSignature?: string;
12709
12522
  /**
12710
- * ERC721 Token ID of the asset this order sells
12523
+ * Authorization header
12711
12524
  * @type {string}
12712
- * @memberof OrdersApiListOrders
12525
+ * @memberof OrdersApiCancelOrderV3
12713
12526
  */
12714
- readonly sellTokenId?: string;
12527
+ readonly authorization?: string;
12528
+ }
12529
+ /**
12530
+ * Request parameters for createOrderV3 operation in OrdersApi.
12531
+ * @export
12532
+ * @interface OrdersApiCreateOrderV3Request
12533
+ */
12534
+ interface OrdersApiCreateOrderV3Request {
12715
12535
  /**
12716
- * Internal IMX ID of the asset this order sells
12717
- * @type {string}
12718
- * @memberof OrdersApiListOrders
12536
+ * create an order
12537
+ * @type {CreateOrderRequestV3}
12538
+ * @memberof OrdersApiCreateOrderV3
12719
12539
  */
12720
- readonly sellAssetId?: string;
12540
+ readonly createOrderRequest: CreateOrderRequestV3;
12721
12541
  /**
12722
- * Token address of the asset this order sells
12542
+ * eth address
12723
12543
  * @type {string}
12724
- * @memberof OrdersApiListOrders
12544
+ * @memberof OrdersApiCreateOrderV3
12725
12545
  */
12726
- readonly sellTokenAddress?: string;
12546
+ readonly xImxEthAddress?: string;
12727
12547
  /**
12728
- * Token name of the asset this order sells
12548
+ * eth signature
12729
12549
  * @type {string}
12730
- * @memberof OrdersApiListOrders
12550
+ * @memberof OrdersApiCreateOrderV3
12731
12551
  */
12732
- readonly sellTokenName?: string;
12552
+ readonly xImxEthSignature?: string;
12733
12553
  /**
12734
- * Min quantity for the asset this order sells
12554
+ * Authorization header
12735
12555
  * @type {string}
12736
- * @memberof OrdersApiListOrders
12556
+ * @memberof OrdersApiCreateOrderV3
12737
12557
  */
12738
- readonly sellMinQuantity?: string;
12558
+ readonly authorization?: string;
12559
+ }
12560
+ /**
12561
+ * Request parameters for getOrderV3 operation in OrdersApi.
12562
+ * @export
12563
+ * @interface OrdersApiGetOrderV3Request
12564
+ */
12565
+ interface OrdersApiGetOrderV3Request {
12739
12566
  /**
12740
- * Max quantity for the asset this order sells
12567
+ * Order ID
12741
12568
  * @type {string}
12742
- * @memberof OrdersApiListOrders
12569
+ * @memberof OrdersApiGetOrderV3
12743
12570
  */
12744
- readonly sellMaxQuantity?: string;
12571
+ readonly id: string;
12745
12572
  /**
12746
- * JSON-encoded metadata filters for the asset this order sells
12747
- * @type {string}
12748
- * @memberof OrdersApiListOrders
12573
+ * Set flag to true to include fee body for the order
12574
+ * @type {boolean}
12575
+ * @memberof OrdersApiGetOrderV3
12749
12576
  */
12750
- readonly sellMetadata?: string;
12577
+ readonly includeFees?: boolean;
12751
12578
  /**
12752
12579
  * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
12753
12580
  * @type {string}
12754
- * @memberof OrdersApiListOrders
12581
+ * @memberof OrdersApiGetOrderV3
12755
12582
  */
12756
12583
  readonly auxiliaryFeePercentages?: string;
12757
12584
  /**
12758
12585
  * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
12759
12586
  * @type {string}
12760
- * @memberof OrdersApiListOrders
12587
+ * @memberof OrdersApiGetOrderV3
12761
12588
  */
12762
12589
  readonly auxiliaryFeeRecipients?: string;
12590
+ }
12591
+ /**
12592
+ * Request parameters for getSignableCancelOrderV3 operation in OrdersApi.
12593
+ * @export
12594
+ * @interface OrdersApiGetSignableCancelOrderV3Request
12595
+ */
12596
+ interface OrdersApiGetSignableCancelOrderV3Request {
12763
12597
  /**
12764
- * Set flag to true to include fee object for orders
12765
- * @type {boolean}
12766
- * @memberof OrdersApiListOrders
12598
+ * get a signable cancel order
12599
+ * @type {GetSignableCancelOrderRequest}
12600
+ * @memberof OrdersApiGetSignableCancelOrderV3
12767
12601
  */
12768
- readonly includeFees?: boolean;
12602
+ readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
12603
+ }
12604
+ /**
12605
+ * Request parameters for getSignableOrder operation in OrdersApi.
12606
+ * @export
12607
+ * @interface OrdersApiGetSignableOrderRequest
12608
+ */
12609
+ interface OrdersApiGetSignableOrderRequest {
12610
+ /**
12611
+ * get a signable order v3
12612
+ * @type {GetSignableOrderRequestV3}
12613
+ * @memberof OrdersApiGetSignableOrder
12614
+ */
12615
+ readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
12769
12616
  }
12770
12617
  /**
12771
12618
  * Request parameters for listOrdersV3 operation in OrdersApi.
@@ -12955,16 +12802,6 @@ interface OrdersApiListOrdersV3Request {
12955
12802
  * @extends {BaseAPI}
12956
12803
  */
12957
12804
  declare class OrdersApi extends BaseAPI {
12958
- /**
12959
- * 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
12960
- * @summary Cancel an order
12961
- * @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
12962
- * @param {*} [options] Override http request option.
12963
- * @deprecated
12964
- * @throws {RequiredError}
12965
- * @memberof OrdersApi
12966
- */
12967
- cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
12968
12805
  /**
12969
12806
  * Cancel an order (V3)
12970
12807
  * @summary Cancel an order (V3)
@@ -12975,17 +12812,7 @@ declare class OrdersApi extends BaseAPI {
12975
12812
  */
12976
12813
  cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
12977
12814
  /**
12978
- * Create an order. Use https://docs.x.immutable.com/reference#/operations/getSignableOrder to get request body params. This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/createOrderV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
12979
- * @summary Create an order
12980
- * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
12981
- * @param {*} [options] Override http request option.
12982
- * @deprecated
12983
- * @throws {RequiredError}
12984
- * @memberof OrdersApi
12985
- */
12986
- createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
12987
- /**
12988
- * Create an order using the v3 orderbook. Currently only buy NFT orders are supported.
12815
+ * Create an order using the v3 orderbook.
12989
12816
  * @summary Create an order (V3)
12990
12817
  * @param {OrdersApiCreateOrderV3Request} requestParameters Request parameters.
12991
12818
  * @param {*} [options] Override http request option.
@@ -12993,16 +12820,6 @@ declare class OrdersApi extends BaseAPI {
12993
12820
  * @memberof OrdersApi
12994
12821
  */
12995
12822
  createOrderV3(requestParameters: OrdersApiCreateOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
12996
- /**
12997
- * 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
12998
- * @summary Get an order
12999
- * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
13000
- * @param {*} [options] Override http request option.
13001
- * @deprecated
13002
- * @throws {RequiredError}
13003
- * @memberof OrdersApi
13004
- */
13005
- getOrder(requestParameters: OrdersApiGetOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Order$2, any>>;
13006
12823
  /**
13007
12824
  * Get an order (V3)
13008
12825
  * @summary Get an order (V3)
@@ -13012,16 +12829,6 @@ declare class OrdersApi extends BaseAPI {
13012
12829
  * @memberof OrdersApi
13013
12830
  */
13014
12831
  getOrderV3(requestParameters: OrdersApiGetOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<OrderV3, any>>;
13015
- /**
13016
- * 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
13017
- * @summary Sign cancel order message
13018
- * @param {OrdersApiGetSignableCancelOrderRequest} requestParameters Request parameters.
13019
- * @param {*} [options] Override http request option.
13020
- * @deprecated
13021
- * @throws {RequiredError}
13022
- * @memberof OrdersApi
13023
- */
13024
- getSignableCancelOrder(requestParameters: OrdersApiGetSignableCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
13025
12832
  /**
13026
12833
  * Generate a signable cancel order message (V3)
13027
12834
  * @summary Generate a signable cancel order message (V3)
@@ -13040,16 +12847,6 @@ declare class OrdersApi extends BaseAPI {
13040
12847
  * @memberof OrdersApi
13041
12848
  */
13042
12849
  getSignableOrder(requestParameters: OrdersApiGetSignableOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableOrderResponse, any>>;
13043
- /**
13044
- * 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
13045
- * @summary Get a list of orders.
13046
- * @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
13047
- * @param {*} [options] Override http request option.
13048
- * @deprecated
13049
- * @throws {RequiredError}
13050
- * @memberof OrdersApi
13051
- */
13052
- listOrders(requestParameters?: OrdersApiListOrdersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponse, any>>;
13053
12850
  /**
13054
12851
  * Get a list of orders (V3)
13055
12852
  * @summary Get a list of orders (V3)
@@ -13153,6 +12950,31 @@ interface ProjectsApiGetProjectsRequest {
13153
12950
  */
13154
12951
  readonly direction?: string;
13155
12952
  }
12953
+ /**
12954
+ * Request parameters for getSdkVersion operation in ProjectsApi.
12955
+ * @export
12956
+ * @interface ProjectsApiGetSdkVersionRequest
12957
+ */
12958
+ interface ProjectsApiGetSdkVersionRequest {
12959
+ /**
12960
+ * Runtime Details
12961
+ * @type {string}
12962
+ * @memberof ProjectsApiGetSdkVersion
12963
+ */
12964
+ readonly details: string;
12965
+ /**
12966
+ * SDK Version
12967
+ * @type {string}
12968
+ * @memberof ProjectsApiGetSdkVersion
12969
+ */
12970
+ readonly version?: string;
12971
+ /**
12972
+ * Runtime ID
12973
+ * @type {string}
12974
+ * @memberof ProjectsApiGetSdkVersion
12975
+ */
12976
+ readonly id?: string;
12977
+ }
13156
12978
  /**
13157
12979
  * ProjectsApi - object-oriented interface
13158
12980
  * @export
@@ -13165,6 +12987,7 @@ declare class ProjectsApi extends BaseAPI {
13165
12987
  * @summary Create a project
13166
12988
  * @param {ProjectsApiCreateProjectRequest} requestParameters Request parameters.
13167
12989
  * @param {*} [options] Override http request option.
12990
+ * @deprecated
13168
12991
  * @throws {RequiredError}
13169
12992
  * @memberof ProjectsApi
13170
12993
  */
@@ -13187,6 +13010,15 @@ declare class ProjectsApi extends BaseAPI {
13187
13010
  * @memberof ProjectsApi
13188
13011
  */
13189
13012
  getProjects(requestParameters: ProjectsApiGetProjectsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetProjectsResponse, any>>;
13013
+ /**
13014
+ * Checks the SDK Version of caller against the current SDK Version and returns a message.
13015
+ * @summary Checks the SDK Version of caller against the current SDK Version
13016
+ * @param {ProjectsApiGetSdkVersionRequest} requestParameters Request parameters.
13017
+ * @param {*} [options] Override http request option.
13018
+ * @throws {RequiredError}
13019
+ * @memberof ProjectsApi
13020
+ */
13021
+ getSdkVersion(requestParameters: ProjectsApiGetSdkVersionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ApiSDKVersionCheckResponse, any>>;
13190
13022
  }
13191
13023
  /**
13192
13024
  * Request parameters for getToken operation in TokensApi.
@@ -13270,37 +13102,6 @@ declare class TokensApi extends BaseAPI {
13270
13102
  */
13271
13103
  listTokens(requestParameters?: TokensApiListTokensRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTokensResponse, any>>;
13272
13104
  }
13273
- /**
13274
- * Request parameters for createTrade operation in TradesApi.
13275
- * @export
13276
- * @interface TradesApiCreateTradeRequest
13277
- */
13278
- interface TradesApiCreateTradeRequest {
13279
- /**
13280
- * create a trade
13281
- * @type {CreateTradeRequestV1}
13282
- * @memberof TradesApiCreateTrade
13283
- */
13284
- readonly createTradeRequest: CreateTradeRequestV1;
13285
- /**
13286
- * eth address
13287
- * @type {string}
13288
- * @memberof TradesApiCreateTrade
13289
- */
13290
- readonly xImxEthAddress?: string;
13291
- /**
13292
- * eth signature
13293
- * @type {string}
13294
- * @memberof TradesApiCreateTrade
13295
- */
13296
- readonly xImxEthSignature?: string;
13297
- /**
13298
- * Authorization header
13299
- * @type {string}
13300
- * @memberof TradesApiCreateTrade
13301
- */
13302
- readonly authorization?: string;
13303
- }
13304
13105
  /**
13305
13106
  * Request parameters for createTradeV3 operation in TradesApi.
13306
13107
  * @export
@@ -13346,91 +13147,18 @@ interface TradesApiGetSignableTradeRequest {
13346
13147
  readonly getSignableTradeRequest: GetSignableTradeRequest;
13347
13148
  }
13348
13149
  /**
13349
- * Request parameters for getTrade operation in TradesApi.
13150
+ * Request parameters for getTradeV3 operation in TradesApi.
13350
13151
  * @export
13351
- * @interface TradesApiGetTradeRequest
13152
+ * @interface TradesApiGetTradeV3Request
13352
13153
  */
13353
- interface TradesApiGetTradeRequest {
13154
+ interface TradesApiGetTradeV3Request {
13354
13155
  /**
13355
13156
  * Trade ID
13356
13157
  * @type {string}
13357
- * @memberof TradesApiGetTrade
13158
+ * @memberof TradesApiGetTradeV3
13358
13159
  */
13359
13160
  readonly id: string;
13360
13161
  }
13361
- /**
13362
- * Request parameters for listTrades operation in TradesApi.
13363
- * @export
13364
- * @interface TradesApiListTradesRequest
13365
- */
13366
- interface TradesApiListTradesRequest {
13367
- /**
13368
- * Party A\&#39;s (buy order) token type of currency used to buy
13369
- * @type {string}
13370
- * @memberof TradesApiListTrades
13371
- */
13372
- readonly partyATokenType?: string;
13373
- /**
13374
- * Party A\&#39;s (buy order) token address of currency used to buy
13375
- * @type {string}
13376
- * @memberof TradesApiListTrades
13377
- */
13378
- readonly partyATokenAddress?: string;
13379
- /**
13380
- * Party B\&#39;s (sell order) token type of NFT sold - always ERC721
13381
- * @type {string}
13382
- * @memberof TradesApiListTrades
13383
- */
13384
- readonly partyBTokenType?: string;
13385
- /**
13386
- * Party B\&#39;s (sell order) collection address of NFT sold
13387
- * @type {string}
13388
- * @memberof TradesApiListTrades
13389
- */
13390
- readonly partyBTokenAddress?: string;
13391
- /**
13392
- * Party B\&#39;s (sell order) token id of NFT sold
13393
- * @type {string}
13394
- * @memberof TradesApiListTrades
13395
- */
13396
- readonly partyBTokenId?: string;
13397
- /**
13398
- * Page size of the result
13399
- * @type {number}
13400
- * @memberof TradesApiListTrades
13401
- */
13402
- readonly pageSize?: number;
13403
- /**
13404
- * Cursor
13405
- * @type {string}
13406
- * @memberof TradesApiListTrades
13407
- */
13408
- readonly cursor?: string;
13409
- /**
13410
- * Property to sort by
13411
- * @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
13412
- * @memberof TradesApiListTrades
13413
- */
13414
- readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
13415
- /**
13416
- * Direction to sort (asc/desc)
13417
- * @type {string}
13418
- * @memberof TradesApiListTrades
13419
- */
13420
- readonly direction?: string;
13421
- /**
13422
- * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
13423
- * @type {string}
13424
- * @memberof TradesApiListTrades
13425
- */
13426
- readonly minTimestamp?: string;
13427
- /**
13428
- * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
13429
- * @type {string}
13430
- * @memberof TradesApiListTrades
13431
- */
13432
- readonly maxTimestamp?: string;
13433
- }
13434
13162
  /**
13435
13163
  * Request parameters for listTradesV3 operation in TradesApi.
13436
13164
  * @export
@@ -13492,13 +13220,13 @@ interface TradesApiListTradesV3Request {
13492
13220
  */
13493
13221
  readonly direction?: string;
13494
13222
  /**
13495
- * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
13223
+ * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-06-27T00:10:22Z\&#39;
13496
13224
  * @type {string}
13497
13225
  * @memberof TradesApiListTradesV3
13498
13226
  */
13499
13227
  readonly minTimestamp?: string;
13500
13228
  /**
13501
- * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
13229
+ * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-06-27T00:10:22Z\&#39;
13502
13230
  * @type {string}
13503
13231
  * @memberof TradesApiListTradesV3
13504
13232
  */
@@ -13512,17 +13240,7 @@ interface TradesApiListTradesV3Request {
13512
13240
  */
13513
13241
  declare class TradesApi extends BaseAPI {
13514
13242
  /**
13515
- * Create a trade. Use https://docs.x.immutable.com/reference#/operations/getSignableTrade to get request body params. This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/createTradeV3. Deprecation date - Mon, 01 May 2023 Sunset date - Fri, 01 Sept 2023
13516
- * @summary Create a Trade between two parties
13517
- * @param {TradesApiCreateTradeRequest} requestParameters Request parameters.
13518
- * @param {*} [options] Override http request option.
13519
- * @deprecated
13520
- * @throws {RequiredError}
13521
- * @memberof TradesApi
13522
- */
13523
- createTrade(requestParameters: TradesApiCreateTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
13524
- /**
13525
- * Create a Trade. Currently only buy order is supported.
13243
+ * Create a Trade.
13526
13244
  * @summary Create a Trade (V3)
13527
13245
  * @param {TradesApiCreateTradeV3Request} requestParameters Request parameters.
13528
13246
  * @param {*} [options] Override http request option.
@@ -13542,22 +13260,12 @@ declare class TradesApi extends BaseAPI {
13542
13260
  /**
13543
13261
  * Get details of a trade with the given ID
13544
13262
  * @summary Get details of a trade with the given ID
13545
- * @param {TradesApiGetTradeRequest} requestParameters Request parameters.
13546
- * @param {*} [options] Override http request option.
13547
- * @throws {RequiredError}
13548
- * @memberof TradesApi
13549
- */
13550
- getTrade(requestParameters: TradesApiGetTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade$2, any>>;
13551
- /**
13552
- * 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
13553
- * @summary Get a list of trades
13554
- * @param {TradesApiListTradesRequest} requestParameters Request parameters.
13263
+ * @param {TradesApiGetTradeV3Request} requestParameters Request parameters.
13555
13264
  * @param {*} [options] Override http request option.
13556
- * @deprecated
13557
13265
  * @throws {RequiredError}
13558
13266
  * @memberof TradesApi
13559
13267
  */
13560
- listTrades(requestParameters?: TradesApiListTradesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTradesResponse, any>>;
13268
+ getTradeV3(requestParameters: TradesApiGetTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade$2, any>>;
13561
13269
  /**
13562
13270
  * Get a list of trades (V3)
13563
13271
  * @summary Get a list of trades (V3)
@@ -13638,10 +13346,10 @@ interface TransfersApiCreateTransferV1Request {
13638
13346
  interface TransfersApiGetSignableTransferRequest {
13639
13347
  /**
13640
13348
  * get details of signable transfer
13641
- * @type {GetSignableTransferRequest}
13349
+ * @type {GetSignableTransferRequestV2}
13642
13350
  * @memberof TransfersApiGetSignableTransfer
13643
13351
  */
13644
- readonly getSignableTransferRequestV2: GetSignableTransferRequest;
13352
+ readonly getSignableTransferRequestV2: GetSignableTransferRequestV2;
13645
13353
  }
13646
13354
  /**
13647
13355
  * Request parameters for getSignableTransferV1 operation in TransfersApi.
@@ -13651,10 +13359,10 @@ interface TransfersApiGetSignableTransferRequest {
13651
13359
  interface TransfersApiGetSignableTransferV1Request {
13652
13360
  /**
13653
13361
  * get details of signable transfer
13654
- * @type {GetSignableTransferRequestV1}
13362
+ * @type {GetSignableTransferRequest}
13655
13363
  * @memberof TransfersApiGetSignableTransferV1
13656
13364
  */
13657
- readonly getSignableTransferRequest: GetSignableTransferRequestV1;
13365
+ readonly getSignableTransferRequest: GetSignableTransferRequest;
13658
13366
  }
13659
13367
  /**
13660
13368
  * Request parameters for getTransfer operation in TransfersApi.
@@ -13689,10 +13397,10 @@ interface TransfersApiListTransfersRequest {
13689
13397
  readonly cursor?: string;
13690
13398
  /**
13691
13399
  * Property to sort by
13692
- * @type {'transaction_id' | 'updated_at' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key'}
13400
+ * @type {'transaction_id' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key'}
13693
13401
  * @memberof TransfersApiListTransfers
13694
13402
  */
13695
- readonly orderBy?: 'transaction_id' | 'updated_at' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key';
13403
+ readonly orderBy?: 'transaction_id' | 'created_at' | 'sender_ether_key' | 'receiver_ether_key';
13696
13404
  /**
13697
13405
  * Direction to sort (asc/desc)
13698
13406
  * @type {string}
@@ -13793,7 +13501,7 @@ declare class TransfersApi extends BaseAPI {
13793
13501
  * @throws {RequiredError}
13794
13502
  * @memberof TransfersApi
13795
13503
  */
13796
- createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
13504
+ createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponseV2, any>>;
13797
13505
  /**
13798
13506
  * Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransferV1 to get request body params.
13799
13507
  * @summary Creates a transfer of tokens between two parties
@@ -13811,7 +13519,7 @@ declare class TransfersApi extends BaseAPI {
13811
13519
  * @throws {RequiredError}
13812
13520
  * @memberof TransfersApi
13813
13521
  */
13814
- getSignableTransfer(requestParameters: TransfersApiGetSignableTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTransferResponse, any>>;
13522
+ getSignableTransfer(requestParameters: TransfersApiGetSignableTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableTransferResponseV2, any>>;
13815
13523
  /**
13816
13524
  * Gets details of a signable transfer
13817
13525
  * @summary Gets details of a signable transfer
@@ -13953,7 +13661,7 @@ declare class UsersApi extends BaseAPI {
13953
13661
  * @throws {RequiredError}
13954
13662
  * @memberof UsersApi
13955
13663
  */
13956
- registerPassportUser(requestParameters: UsersApiRegisterPassportUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<object, any>>;
13664
+ registerPassportUser(requestParameters: UsersApiRegisterPassportUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<RegisterPassportUserResult, any>>;
13957
13665
  /**
13958
13666
  * Registers a user
13959
13667
  * @summary Registers a user
@@ -14138,7 +13846,7 @@ interface WithdrawalsApiListWithdrawalsRequest {
14138
13846
  */
14139
13847
  declare class WithdrawalsApi extends BaseAPI {
14140
13848
  /**
14141
- * Creates a withdrawal.
13849
+ * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
14142
13850
  * @summary Creates a withdrawal of a token
14143
13851
  * @param {WithdrawalsApiCreateWithdrawalRequest} requestParameters Request parameters.
14144
13852
  * @param {*} [options] Override http request option.
@@ -14525,28 +14233,28 @@ declare class ImmutableXClient {
14525
14233
  * @returns a promise that resolves with the requested Order
14526
14234
  * @throws {@link index.IMXError}
14527
14235
  */
14528
- getOrder(request: OrdersApiGetOrderRequest): Promise<OrderV3>;
14236
+ getOrder(request: OrdersApiGetOrderV3Request): Promise<OrderV3>;
14529
14237
  /**
14530
14238
  * Get a list of Orders
14531
14239
  * @param request - optional object containing the parameters to be provided in the API request
14532
14240
  * @returns a promise that resolves with the requested list of Orders
14533
14241
  * @throws {@link index.IMXError}
14534
14242
  */
14535
- listOrders(request?: OrdersApiListOrdersRequest): Promise<ListOrdersResponseV3>;
14243
+ listOrders(request?: OrdersApiListOrdersV3Request): Promise<ListOrdersResponseV3>;
14536
14244
  /**
14537
14245
  * Get details of a Trade with the given ID
14538
14246
  * @param request - the request object containing the parameters to be provided in the API request
14539
14247
  * @returns a promise that resolves with the requested Trade
14540
14248
  * @throws {@link index.IMXError}
14541
14249
  */
14542
- getTrade(request: TradesApiGetTradeRequest): Promise<Trade$2>;
14250
+ getTrade(request: TradesApiGetTradeV3Request): Promise<Trade$2>;
14543
14251
  /**
14544
14252
  * Get a list of Trades
14545
14253
  * @param request - optional object containing the parameters to be provided in the API request
14546
14254
  * @returns a promise that resolves with the requested list of Trades
14547
14255
  * @throws {@link index.IMXError}
14548
14256
  */
14549
- listTrades(request?: TradesApiListTradesRequest): Promise<ListTradesResponse>;
14257
+ listTrades(request?: TradesApiListTradesV3Request): Promise<ListTradesResponse>;
14550
14258
  /**
14551
14259
  * Get details of a Token
14552
14260
  * @param request - the request object containing the parameters to be provided in the API request
@@ -14961,17 +14669,12 @@ declare class Passport {
14961
14669
  private readonly passportImxProviderFactory;
14962
14670
  private readonly passportEventEmitter;
14963
14671
  constructor(passportModuleConfiguration: PassportModuleConfiguration);
14964
- signIn(options?: {
14965
- useCachedSession: boolean;
14966
- }): Promise<UserProfile | null>;
14967
14672
  /**
14968
- * @deprecated The method connectImx(useCachedSession) should be used instead
14673
+ * @deprecated The method `login` with an argument of `{ useCachedSession: true }` should be used in conjunction with
14674
+ * `connectImx` instead.
14969
14675
  */
14970
14676
  connectImxSilent(): Promise<IMXProvider | null>;
14971
- connectImx(options?: {
14972
- useCachedSession: boolean;
14973
- }): Promise<IMXProvider | null>;
14974
- loginWithDeviceFlow(): Promise<DeviceConnectResponse>;
14677
+ connectImx(): Promise<IMXProvider>;
14975
14678
  connectImxDeviceFlow(deviceCode: string, interval: number, timeoutMs?: number): Promise<IMXProvider | null>;
14976
14679
  getPKCEAuthorizationUrl(): string;
14977
14680
  connectImxPKCEFlow(authorizationCode: string, state: string): Promise<IMXProvider | null>;
@@ -14981,6 +14684,18 @@ declare class Passport {
14981
14684
  checkStoredDeviceFlowCredentials(): DeviceTokenResponse | null;
14982
14685
  connectImxWithCredentials(tokenResponse: DeviceTokenResponse): Promise<IMXProvider | null>;
14983
14686
  connectEvm(): Provider;
14687
+ /**
14688
+ *
14689
+ * Initiates the authorisation flow.
14690
+ *
14691
+ * @param options.useCachedSession = false - If true, and no active session exists, then the user will not be
14692
+ * prompted to log in and the Promise will resolve with a null value.
14693
+ * @returns {Promise<UserProfile | null>} the user profile if the user is logged in, otherwise null
14694
+ */
14695
+ login(options?: {
14696
+ useCachedSession: boolean;
14697
+ }): Promise<UserProfile | null>;
14698
+ loginWithDeviceFlow(): Promise<DeviceConnectResponse>;
14984
14699
  loginCallback(): Promise<void>;
14985
14700
  logout(): Promise<void>;
14986
14701
  /**