@imtbl/sdk 0.0.1-alpha.2 → 0.0.1-alpha.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/starkex.d.ts CHANGED
@@ -197,7 +197,7 @@ interface ConfigurationParameters {
197
197
  baseOptions?: any;
198
198
  formDataCtor?: new () => any;
199
199
  }
200
- declare class Configuration$1 {
200
+ declare class Configuration {
201
201
  /**
202
202
  * parameter for apiKey security
203
203
  * @param name security name
@@ -268,8 +268,8 @@ declare class Configuration$1 {
268
268
  declare class BaseAPI {
269
269
  protected basePath: string;
270
270
  protected axios: AxiosInstance;
271
- protected configuration: Configuration$1 | undefined;
272
- constructor(configuration?: Configuration$1, basePath?: string, axios?: AxiosInstance);
271
+ protected configuration: Configuration | undefined;
272
+ constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
273
273
  }
274
274
 
275
275
  /**
@@ -380,49 +380,6 @@ interface AggregateLimit {
380
380
  'min_amount'?: number;
381
381
  }
382
382
 
383
- /**
384
- * Immutable X API
385
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
386
- *
387
- * The version of the OpenAPI document: 3.0
388
- * Contact: support@immutable.com
389
- *
390
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
391
- * https://openapi-generator.tech
392
- * Do not edit the class manually.
393
- */
394
- /**
395
- *
396
- * @export
397
- * @interface ApiRegisterPassportUserRequest
398
- */
399
- interface ApiRegisterPassportUserRequest {
400
- /**
401
- * Eth signature
402
- * @type {string}
403
- * @memberof ApiRegisterPassportUserRequest
404
- */
405
- 'eth_signature': string;
406
- /**
407
- * The ether key of the user
408
- * @type {string}
409
- * @memberof ApiRegisterPassportUserRequest
410
- */
411
- 'ether_key': string;
412
- /**
413
- * Public stark key of the user
414
- * @type {string}
415
- * @memberof ApiRegisterPassportUserRequest
416
- */
417
- 'stark_key': string;
418
- /**
419
- * Payload signature
420
- * @type {string}
421
- * @memberof ApiRegisterPassportUserRequest
422
- */
423
- 'stark_signature': string;
424
- }
425
-
426
383
  /**
427
384
  * Immutable X API
428
385
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -465,30 +422,31 @@ interface CollectionDetails {
465
422
  * https://openapi-generator.tech
466
423
  * Do not edit the class manually.
467
424
  */
425
+
468
426
  /**
469
427
  *
470
428
  * @export
471
- * @interface Fee
429
+ * @interface AssetProperties
472
430
  */
473
- interface Fee {
431
+ interface AssetProperties {
474
432
  /**
475
- * Wallet address
476
- * @type {string}
477
- * @memberof Fee
433
+ *
434
+ * @type {CollectionDetails}
435
+ * @memberof AssetProperties
478
436
  */
479
- 'address': string;
437
+ 'collection'?: CollectionDetails;
480
438
  /**
481
- * The percentage of fee
482
- * @type {number}
483
- * @memberof Fee
439
+ * Image URL of this asset
440
+ * @type {string}
441
+ * @memberof AssetProperties
484
442
  */
485
- 'percentage': number;
443
+ 'image_url'?: string;
486
444
  /**
487
- * Type of fee. Examples: `royalty`, `maker`, `taker` or `protocol`
445
+ * Name of this asset
488
446
  * @type {string}
489
- * @memberof Fee
447
+ * @memberof AssetProperties
490
448
  */
491
- 'type': string;
449
+ 'name'?: string;
492
450
  }
493
451
 
494
452
  /**
@@ -502,25 +460,13 @@ interface Fee {
502
460
  * https://openapi-generator.tech
503
461
  * Do not edit the class manually.
504
462
  */
463
+
505
464
  /**
506
- *
465
+ * @type TokenDataProperties
466
+ * Properties of this asset
507
467
  * @export
508
- * @interface OrderDetails
509
468
  */
510
- interface OrderDetails {
511
- /**
512
- * Buy orders for this asset
513
- * @type {Array<object>}
514
- * @memberof OrderDetails
515
- */
516
- 'buy_orders'?: Array<object>;
517
- /**
518
- * Sell orders for this asset
519
- * @type {Array<object>}
520
- * @memberof OrderDetails
521
- */
522
- 'sell_orders'?: Array<object>;
523
- }
469
+ declare type TokenDataProperties = AssetProperties;
524
470
 
525
471
  /**
526
472
  * Immutable X API
@@ -537,101 +483,78 @@ interface OrderDetails {
537
483
  /**
538
484
  *
539
485
  * @export
540
- * @interface Asset
486
+ * @interface TokenData
541
487
  */
542
- interface Asset {
543
- /**
544
- *
545
- * @type {CollectionDetails}
546
- * @memberof Asset
547
- */
548
- 'collection': CollectionDetails;
549
- /**
550
- * Timestamp of when the asset was created
551
- * @type {string}
552
- * @memberof Asset
553
- */
554
- 'created_at': string | null;
555
- /**
556
- * Description of this asset
557
- * @type {string}
558
- * @memberof Asset
559
- */
560
- 'description': string | null;
488
+ interface TokenData {
561
489
  /**
562
- * Royalties to pay on this asset operations
563
- * @type {Array<Fee>}
564
- * @memberof Asset
490
+ * Number of decimals supported by this asset
491
+ * @type {number}
492
+ * @memberof TokenData
565
493
  */
566
- 'fees'?: Array<Fee>;
494
+ 'decimals'?: number;
567
495
  /**
568
496
  * [DEPRECATED] Internal Immutable X Token ID
569
497
  * @type {string}
570
- * @memberof Asset
498
+ * @memberof TokenData
571
499
  */
572
500
  'id'?: string;
573
- /**
574
- * URL of the image which should be used for this asset
575
- * @type {string}
576
- * @memberof Asset
577
- */
578
- 'image_url': string | null;
579
- /**
580
- * Metadata of this asset
581
- * @type {object}
582
- * @memberof Asset
583
- */
584
- 'metadata': object | null;
585
- /**
586
- * Name of this asset
587
- * @type {string}
588
- * @memberof Asset
589
- */
590
- 'name': string | null;
591
501
  /**
592
502
  *
593
- * @type {OrderDetails}
594
- * @memberof Asset
595
- */
596
- 'orders'?: OrderDetails;
597
- /**
598
- * Status of this asset (where it is in the system)
599
- * @type {string}
600
- * @memberof Asset
503
+ * @type {TokenDataProperties}
504
+ * @memberof TokenData
601
505
  */
602
- 'status': string;
506
+ 'properties'?: TokenDataProperties;
603
507
  /**
604
- * Address of the ERC721 contract
508
+ * Quantity of this asset - inclusive of fees for buy order in v1 API and exclusive of fees in v3 API
605
509
  * @type {string}
606
- * @memberof Asset
510
+ * @memberof TokenData
607
511
  */
608
- 'token_address': string;
512
+ 'quantity': string;
609
513
  /**
610
- * ERC721 Token ID of this asset
514
+ * Quantity of this asset with the sum of all fees applied to the asset
611
515
  * @type {string}
612
- * @memberof Asset
516
+ * @memberof TokenData
613
517
  */
614
- 'token_id': string;
518
+ 'quantity_with_fees': string;
615
519
  /**
616
- * Timestamp of when the asset was updated
520
+ * Symbol of a token
617
521
  * @type {string}
618
- * @memberof Asset
522
+ * @memberof TokenData
619
523
  */
620
- 'updated_at': string | null;
524
+ 'symbol'?: string;
621
525
  /**
622
- * URI to access this asset externally to Immutable X
526
+ * Address of ERC721/ERC20 contract
623
527
  * @type {string}
624
- * @memberof Asset
528
+ * @memberof TokenData
625
529
  */
626
- 'uri': string | null;
530
+ 'token_address'?: string;
627
531
  /**
628
- * Ethereum address of the user who owns this asset
532
+ * ERC721 Token ID
629
533
  * @type {string}
630
- * @memberof Asset
534
+ * @memberof TokenData
631
535
  */
632
- 'user': string;
536
+ 'token_id'?: string;
633
537
  }
634
538
 
539
+ /**
540
+ * Immutable X API
541
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
542
+ *
543
+ * The version of the OpenAPI document: 3.0
544
+ * Contact: support@immutable.com
545
+ *
546
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
547
+ * https://openapi-generator.tech
548
+ * Do not edit the class manually.
549
+ */
550
+
551
+ /**
552
+ * @type TokenDataOAIGen
553
+ * Token details of this asset
554
+ * @export
555
+ */
556
+ declare type TokenDataOAIGen = TokenData;
557
+
635
558
  /**
636
559
  * Immutable X API
637
560
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -647,27 +570,52 @@ interface Asset {
647
570
  /**
648
571
  *
649
572
  * @export
650
- * @interface AssetProperties
573
+ * @interface Token
651
574
  */
652
- interface AssetProperties {
575
+ interface Token {
653
576
  /**
654
577
  *
655
- * @type {CollectionDetails}
656
- * @memberof AssetProperties
578
+ * @type {TokenDataOAIGen}
579
+ * @memberof Token
657
580
  */
658
- 'collection'?: CollectionDetails;
581
+ 'data': TokenDataOAIGen;
659
582
  /**
660
- * Image URL of this asset
583
+ * Type of this asset (ETH/ERC20/ERC721)
661
584
  * @type {string}
662
- * @memberof AssetProperties
585
+ * @memberof Token
663
586
  */
664
- 'image_url'?: string;
587
+ 'type': string;
588
+ }
589
+
590
+ /**
591
+ * Immutable X API
592
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
593
+ *
594
+ * The version of the OpenAPI document: 3.0
595
+ * Contact: support@immutable.com
596
+ *
597
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
598
+ * https://openapi-generator.tech
599
+ * Do not edit the class manually.
600
+ */
601
+ /**
602
+ *
603
+ * @export
604
+ * @interface FeeData
605
+ */
606
+ interface FeeData {
665
607
  /**
666
- * Name of this asset
608
+ * Address of ERC721/ERC20 contract
667
609
  * @type {string}
668
- * @memberof AssetProperties
610
+ * @memberof FeeData
669
611
  */
670
- 'name'?: string;
612
+ 'contract_address'?: string;
613
+ /**
614
+ * Number of decimals supported by this asset
615
+ * @type {number}
616
+ * @memberof FeeData
617
+ */
618
+ 'decimals'?: number;
671
619
  }
672
620
 
673
621
  /**
@@ -685,99 +633,89 @@ interface AssetProperties {
685
633
  /**
686
634
  *
687
635
  * @export
688
- * @interface AssetWithOrders
636
+ * @interface FeeToken
689
637
  */
690
- interface AssetWithOrders {
638
+ interface FeeToken {
691
639
  /**
692
640
  *
693
- * @type {CollectionDetails}
694
- * @memberof AssetWithOrders
641
+ * @type {FeeData}
642
+ * @memberof FeeToken
695
643
  */
696
- 'collection': CollectionDetails;
644
+ 'data'?: FeeData;
697
645
  /**
698
- * Timestamp of when the asset was created
646
+ * Fee token type. One of ETH/ERC20
699
647
  * @type {string}
700
- * @memberof AssetWithOrders
648
+ * @memberof FeeToken
701
649
  */
702
- 'created_at': string | null;
703
- /**
704
- * Description of this asset
705
- * @type {string}
706
- * @memberof AssetWithOrders
707
- */
708
- 'description': string | null;
709
- /**
710
- * Royalties to pay on this asset operations
711
- * @type {Array<Fee>}
712
- * @memberof AssetWithOrders
713
- */
714
- 'fees'?: Array<Fee>;
715
- /**
716
- * [DEPRECATED] Internal Immutable X Token ID
717
- * @type {string}
718
- * @memberof AssetWithOrders
719
- */
720
- 'id'?: string;
650
+ 'type'?: FeeTokenTypeEnum;
651
+ }
652
+ declare const FeeTokenTypeEnum: {
653
+ readonly Eth: "ETH";
654
+ readonly Erc20: "ERC20";
655
+ };
656
+ declare type FeeTokenTypeEnum = typeof FeeTokenTypeEnum[keyof typeof FeeTokenTypeEnum];
657
+
658
+ /**
659
+ * Immutable X API
660
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
661
+ *
662
+ * The version of the OpenAPI document: 3.0
663
+ * Contact: support@immutable.com
664
+ *
665
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
666
+ * https://openapi-generator.tech
667
+ * Do not edit the class manually.
668
+ */
669
+
670
+ /**
671
+ * @type OrderFeeInfoToken
672
+ * Details of the fee currency
673
+ * @export
674
+ */
675
+ declare type OrderFeeInfoToken = FeeToken;
676
+
677
+ /**
678
+ * Immutable X API
679
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
680
+ *
681
+ * The version of the OpenAPI document: 3.0
682
+ * Contact: support@immutable.com
683
+ *
684
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
685
+ * https://openapi-generator.tech
686
+ * Do not edit the class manually.
687
+ */
688
+
689
+ /**
690
+ *
691
+ * @export
692
+ * @interface OrderFeeInfo
693
+ */
694
+ interface OrderFeeInfo {
721
695
  /**
722
- * URL of the image which should be used for this asset
696
+ * Address of the fee recipient
723
697
  * @type {string}
724
- * @memberof AssetWithOrders
725
- */
726
- 'image_url': string | null;
727
- /**
728
- * Metadata of this asset
729
- * @type {object}
730
- * @memberof AssetWithOrders
698
+ * @memberof OrderFeeInfo
731
699
  */
732
- 'metadata': object | null;
700
+ 'address'?: string;
733
701
  /**
734
- * Name of this asset
702
+ * Fee amount
735
703
  * @type {string}
736
- * @memberof AssetWithOrders
704
+ * @memberof OrderFeeInfo
737
705
  */
738
- 'name': string | null;
706
+ 'amount'?: string;
739
707
  /**
740
708
  *
741
- * @type {OrderDetails}
742
- * @memberof AssetWithOrders
743
- */
744
- 'orders'?: OrderDetails;
745
- /**
746
- * Status of this asset (where it is in the system)
747
- * @type {string}
748
- * @memberof AssetWithOrders
749
- */
750
- 'status': string;
751
- /**
752
- * Address of the ERC721 contract
753
- * @type {string}
754
- * @memberof AssetWithOrders
755
- */
756
- 'token_address': string;
757
- /**
758
- * ERC721 Token ID of this asset
759
- * @type {string}
760
- * @memberof AssetWithOrders
761
- */
762
- 'token_id': string;
763
- /**
764
- * Timestamp of when the asset was updated
765
- * @type {string}
766
- * @memberof AssetWithOrders
767
- */
768
- 'updated_at': string | null;
769
- /**
770
- * URI to access this asset externally to Immutable X
771
- * @type {string}
772
- * @memberof AssetWithOrders
709
+ * @type {OrderFeeInfoToken}
710
+ * @memberof OrderFeeInfo
773
711
  */
774
- 'uri': string | null;
712
+ 'token'?: OrderFeeInfoToken;
775
713
  /**
776
- * Ethereum address of the user who owns this asset
714
+ * Fee type
777
715
  * @type {string}
778
- * @memberof AssetWithOrders
716
+ * @memberof OrderFeeInfo
779
717
  */
780
- 'user': string;
718
+ 'type'?: string;
781
719
  }
782
720
 
783
721
  /**
@@ -794,39 +732,33 @@ interface AssetWithOrders {
794
732
  /**
795
733
  *
796
734
  * @export
797
- * @interface Balance
735
+ * @interface ApiRegisterPassportUserRequest
798
736
  */
799
- interface Balance {
800
- /**
801
- * Amount which is currently inside the exchange
802
- * @type {string}
803
- * @memberof Balance
804
- */
805
- 'balance': string;
737
+ interface ApiRegisterPassportUserRequest {
806
738
  /**
807
- * Amount which is currently preparing withdrawal from the exchange
739
+ * Eth signature
808
740
  * @type {string}
809
- * @memberof Balance
741
+ * @memberof ApiRegisterPassportUserRequest
810
742
  */
811
- 'preparing_withdrawal': string;
743
+ 'eth_signature': string;
812
744
  /**
813
- * Symbol of the token (e.g. ETH, IMX)
745
+ * The ether key of the user
814
746
  * @type {string}
815
- * @memberof Balance
747
+ * @memberof ApiRegisterPassportUserRequest
816
748
  */
817
- 'symbol': string;
749
+ 'ether_key': string;
818
750
  /**
819
- * Address of the contract that represents this ERC20 token or empty for ETH
751
+ * Public stark key of the user
820
752
  * @type {string}
821
- * @memberof Balance
753
+ * @memberof ApiRegisterPassportUserRequest
822
754
  */
823
- 'token_address': string;
755
+ 'stark_key': string;
824
756
  /**
825
- * Amount which is currently withdrawable from the exchange
757
+ * Payload signature
826
758
  * @type {string}
827
- * @memberof Balance
759
+ * @memberof ApiRegisterPassportUserRequest
828
760
  */
829
- 'withdrawable': string;
761
+ 'stark_signature': string;
830
762
  }
831
763
 
832
764
  /**
@@ -843,21 +775,27 @@ interface Balance {
843
775
  /**
844
776
  *
845
777
  * @export
846
- * @interface CancelOrderRequest
778
+ * @interface Fee
847
779
  */
848
- interface CancelOrderRequest {
780
+ interface Fee {
849
781
  /**
850
- * ID of the order
782
+ * Wallet address
783
+ * @type {string}
784
+ * @memberof Fee
785
+ */
786
+ 'address': string;
787
+ /**
788
+ * The percentage of fee
851
789
  * @type {number}
852
- * @memberof CancelOrderRequest
790
+ * @memberof Fee
853
791
  */
854
- 'order_id': number;
792
+ 'percentage': number;
855
793
  /**
856
- * Payload signature
794
+ * Type of fee. Examples: `royalty`, `maker`, `taker` or `protocol`
857
795
  * @type {string}
858
- * @memberof CancelOrderRequest
796
+ * @memberof Fee
859
797
  */
860
- 'stark_signature': string;
798
+ 'type': string;
861
799
  }
862
800
 
863
801
  /**
@@ -874,21 +812,21 @@ interface CancelOrderRequest {
874
812
  /**
875
813
  *
876
814
  * @export
877
- * @interface CancelOrderResponse
815
+ * @interface OrderDetails
878
816
  */
879
- interface CancelOrderResponse {
817
+ interface OrderDetails {
880
818
  /**
881
- * ID of the cancelled order
882
- * @type {number}
883
- * @memberof CancelOrderResponse
819
+ * Buy orders for this asset
820
+ * @type {Array<object>}
821
+ * @memberof OrderDetails
884
822
  */
885
- 'order_id': number;
823
+ 'buy_orders'?: Array<object>;
886
824
  /**
887
- * New status of the order
888
- * @type {string}
889
- * @memberof CancelOrderResponse
825
+ * Sell orders for this asset
826
+ * @type {Array<object>}
827
+ * @memberof OrderDetails
890
828
  */
891
- 'status': string;
829
+ 'sell_orders'?: Array<object>;
892
830
  }
893
831
 
894
832
  /**
@@ -902,72 +840,103 @@ interface CancelOrderResponse {
902
840
  * https://openapi-generator.tech
903
841
  * Do not edit the class manually.
904
842
  */
843
+
905
844
  /**
906
845
  *
907
846
  * @export
908
- * @interface Collection
847
+ * @interface Asset
909
848
  */
910
- interface Collection {
911
- /**
912
- * Ethereum address of the ERC721 contract
913
- * @type {string}
914
- * @memberof Collection
915
- */
916
- 'address': string;
849
+ interface Asset {
917
850
  /**
918
- * URL of the tile image for this collection
919
- * @type {string}
920
- * @memberof Collection
851
+ *
852
+ * @type {CollectionDetails}
853
+ * @memberof Asset
921
854
  */
922
- 'collection_image_url': string | null;
855
+ 'collection': CollectionDetails;
923
856
  /**
924
- * Timestamp of when the collection was created
857
+ * Timestamp of when the asset was created
925
858
  * @type {string}
926
- * @memberof Collection
859
+ * @memberof Asset
927
860
  */
928
861
  'created_at': string | null;
929
862
  /**
930
- * Description of the collection
863
+ * Description of this asset
931
864
  * @type {string}
932
- * @memberof Collection
865
+ * @memberof Asset
933
866
  */
934
867
  'description': string | null;
935
868
  /**
936
- * URL of the icon for this collection
937
- * @type {string}
938
- * @memberof Collection
869
+ * Royalties to pay on this asset operations
870
+ * @type {Array<Fee>}
871
+ * @memberof Asset
939
872
  */
940
- 'icon_url': string | null;
873
+ 'fees'?: Array<Fee>;
941
874
  /**
942
- * URL of the metadata for this collection
875
+ * [DEPRECATED] Internal Immutable X Token ID
943
876
  * @type {string}
944
- * @memberof Collection
877
+ * @memberof Asset
945
878
  */
946
- 'metadata_api_url': string | null;
879
+ 'id'?: string;
947
880
  /**
948
- * Name of the collection
881
+ * URL of the image which should be used for this asset
949
882
  * @type {string}
950
- * @memberof Collection
883
+ * @memberof Asset
951
884
  */
952
- 'name': string;
885
+ 'image_url': string | null;
953
886
  /**
954
- * The collection\'s project ID
955
- * @type {number}
956
- * @memberof Collection
887
+ * Metadata of this asset
888
+ * @type {object}
889
+ * @memberof Asset
957
890
  */
958
- 'project_id': number;
891
+ 'metadata': object | null;
959
892
  /**
960
- * Project owner address
893
+ * Name of this asset
961
894
  * @type {string}
962
- * @memberof Collection
895
+ * @memberof Asset
963
896
  */
964
- 'project_owner_address': string;
897
+ 'name': string | null;
965
898
  /**
966
- * Timestamp of when the collection was updated
967
- * @type {string}
968
- * @memberof Collection
899
+ *
900
+ * @type {OrderDetails}
901
+ * @memberof Asset
902
+ */
903
+ 'orders'?: OrderDetails;
904
+ /**
905
+ * Status of this asset (where it is in the system)
906
+ * @type {string}
907
+ * @memberof Asset
908
+ */
909
+ 'status': string;
910
+ /**
911
+ * Address of the ERC721 contract
912
+ * @type {string}
913
+ * @memberof Asset
914
+ */
915
+ 'token_address': string;
916
+ /**
917
+ * ERC721 Token ID of this asset
918
+ * @type {string}
919
+ * @memberof Asset
920
+ */
921
+ 'token_id': string;
922
+ /**
923
+ * Timestamp of when the asset was updated
924
+ * @type {string}
925
+ * @memberof Asset
969
926
  */
970
927
  'updated_at': string | null;
928
+ /**
929
+ * URI to access this asset externally to Immutable X
930
+ * @type {string}
931
+ * @memberof Asset
932
+ */
933
+ 'uri': string | null;
934
+ /**
935
+ * Ethereum address of the user who owns this asset
936
+ * @type {string}
937
+ * @memberof Asset
938
+ */
939
+ 'user': string;
971
940
  }
972
941
 
973
942
  /**
@@ -981,24 +950,103 @@ interface Collection {
981
950
  * https://openapi-generator.tech
982
951
  * Do not edit the class manually.
983
952
  */
953
+
984
954
  /**
985
955
  *
986
956
  * @export
987
- * @interface Range
957
+ * @interface AssetWithOrders
988
958
  */
989
- interface Range {
959
+ interface AssetWithOrders {
990
960
  /**
991
- * Maximum value
992
- * @type {number}
993
- * @memberof Range
961
+ *
962
+ * @type {CollectionDetails}
963
+ * @memberof AssetWithOrders
994
964
  */
995
- 'max'?: number;
965
+ 'collection': CollectionDetails;
996
966
  /**
997
- * Minimum value
998
- * @type {number}
999
- * @memberof Range
967
+ * Timestamp of when the asset was created
968
+ * @type {string}
969
+ * @memberof AssetWithOrders
1000
970
  */
1001
- 'min'?: number;
971
+ 'created_at': string | null;
972
+ /**
973
+ * Description of this asset
974
+ * @type {string}
975
+ * @memberof AssetWithOrders
976
+ */
977
+ 'description': string | null;
978
+ /**
979
+ * Royalties to pay on this asset operations
980
+ * @type {Array<Fee>}
981
+ * @memberof AssetWithOrders
982
+ */
983
+ 'fees'?: Array<Fee>;
984
+ /**
985
+ * [DEPRECATED] Internal Immutable X Token ID
986
+ * @type {string}
987
+ * @memberof AssetWithOrders
988
+ */
989
+ 'id'?: string;
990
+ /**
991
+ * URL of the image which should be used for this asset
992
+ * @type {string}
993
+ * @memberof AssetWithOrders
994
+ */
995
+ 'image_url': string | null;
996
+ /**
997
+ * Metadata of this asset
998
+ * @type {object}
999
+ * @memberof AssetWithOrders
1000
+ */
1001
+ 'metadata': object | null;
1002
+ /**
1003
+ * Name of this asset
1004
+ * @type {string}
1005
+ * @memberof AssetWithOrders
1006
+ */
1007
+ 'name': string | null;
1008
+ /**
1009
+ *
1010
+ * @type {OrderDetails}
1011
+ * @memberof AssetWithOrders
1012
+ */
1013
+ 'orders'?: OrderDetails;
1014
+ /**
1015
+ * Status of this asset (where it is in the system)
1016
+ * @type {string}
1017
+ * @memberof AssetWithOrders
1018
+ */
1019
+ 'status': string;
1020
+ /**
1021
+ * Address of the ERC721 contract
1022
+ * @type {string}
1023
+ * @memberof AssetWithOrders
1024
+ */
1025
+ 'token_address': string;
1026
+ /**
1027
+ * ERC721 Token ID of this asset
1028
+ * @type {string}
1029
+ * @memberof AssetWithOrders
1030
+ */
1031
+ 'token_id': string;
1032
+ /**
1033
+ * Timestamp of when the asset was updated
1034
+ * @type {string}
1035
+ * @memberof AssetWithOrders
1036
+ */
1037
+ 'updated_at': string | null;
1038
+ /**
1039
+ * URI to access this asset externally to Immutable X
1040
+ * @type {string}
1041
+ * @memberof AssetWithOrders
1042
+ */
1043
+ 'uri': string | null;
1044
+ /**
1045
+ * Ethereum address of the user who owns this asset
1046
+ * @type {string}
1047
+ * @memberof AssetWithOrders
1048
+ */
1049
+ 'user': string;
1002
1050
  }
1003
1051
 
1004
1052
  /**
@@ -1012,37 +1060,42 @@ interface Range {
1012
1060
  * https://openapi-generator.tech
1013
1061
  * Do not edit the class manually.
1014
1062
  */
1015
-
1016
1063
  /**
1017
1064
  *
1018
1065
  * @export
1019
- * @interface CollectionFilter
1066
+ * @interface Balance
1020
1067
  */
1021
- interface CollectionFilter {
1068
+ interface Balance {
1022
1069
  /**
1023
- * Key of this property
1070
+ * Amount which is currently inside the exchange
1024
1071
  * @type {string}
1025
- * @memberof CollectionFilter
1072
+ * @memberof Balance
1026
1073
  */
1027
- 'key'?: string;
1074
+ 'balance': string;
1028
1075
  /**
1029
- *
1030
- * @type {Range}
1031
- * @memberof CollectionFilter
1076
+ * Amount which is currently preparing withdrawal from the exchange
1077
+ * @type {string}
1078
+ * @memberof Balance
1032
1079
  */
1033
- 'range'?: Range;
1080
+ 'preparing_withdrawal': string;
1034
1081
  /**
1035
- * Type of this filter
1082
+ * Symbol of the token (e.g. ETH, IMX)
1036
1083
  * @type {string}
1037
- * @memberof CollectionFilter
1084
+ * @memberof Balance
1038
1085
  */
1039
- 'type'?: string;
1086
+ 'symbol': string;
1040
1087
  /**
1041
- * List of possible values for this property
1042
- * @type {Array<string>}
1043
- * @memberof CollectionFilter
1088
+ * Address of the contract that represents this ERC20 token or empty for ETH
1089
+ * @type {string}
1090
+ * @memberof Balance
1044
1091
  */
1045
- 'value'?: Array<string>;
1092
+ 'token_address': string;
1093
+ /**
1094
+ * Amount which is currently withdrawable from the exchange
1095
+ * @type {string}
1096
+ * @memberof Balance
1097
+ */
1098
+ 'withdrawable': string;
1046
1099
  }
1047
1100
 
1048
1101
  /**
@@ -1059,27 +1112,21 @@ interface CollectionFilter {
1059
1112
  /**
1060
1113
  *
1061
1114
  * @export
1062
- * @interface ContractCreateAPIRequest
1115
+ * @interface CancelOrderRequest
1063
1116
  */
1064
- interface ContractCreateAPIRequest {
1065
- /**
1066
- *
1067
- * @type {string}
1068
- * @memberof ContractCreateAPIRequest
1069
- */
1070
- 'contract_address'?: string;
1117
+ interface CancelOrderRequest {
1071
1118
  /**
1072
- *
1073
- * @type {string}
1074
- * @memberof ContractCreateAPIRequest
1119
+ * ID of the order
1120
+ * @type {number}
1121
+ * @memberof CancelOrderRequest
1075
1122
  */
1076
- 'data_url'?: string;
1123
+ 'order_id': number;
1077
1124
  /**
1078
- *
1125
+ * Payload signature
1079
1126
  * @type {string}
1080
- * @memberof ContractCreateAPIRequest
1127
+ * @memberof CancelOrderRequest
1081
1128
  */
1082
- 'mint_url'?: string;
1129
+ 'stark_signature': string;
1083
1130
  }
1084
1131
 
1085
1132
  /**
@@ -1096,15 +1143,21 @@ interface ContractCreateAPIRequest {
1096
1143
  /**
1097
1144
  *
1098
1145
  * @export
1099
- * @interface ContractCreateResponse
1146
+ * @interface CancelOrderResponse
1100
1147
  */
1101
- interface ContractCreateResponse {
1148
+ interface CancelOrderResponse {
1102
1149
  /**
1103
- *
1150
+ * ID of the cancelled order
1151
+ * @type {number}
1152
+ * @memberof CancelOrderResponse
1153
+ */
1154
+ 'order_id': number;
1155
+ /**
1156
+ * New status of the order
1104
1157
  * @type {string}
1105
- * @memberof ContractCreateResponse
1158
+ * @memberof CancelOrderResponse
1106
1159
  */
1107
- 'webhook_hash'?: string;
1160
+ 'status': string;
1108
1161
  }
1109
1162
 
1110
1163
  /**
@@ -1121,51 +1174,267 @@ interface ContractCreateResponse {
1121
1174
  /**
1122
1175
  *
1123
1176
  * @export
1124
- * @interface CreateCollectionRequest
1177
+ * @interface Collection
1125
1178
  */
1126
- interface CreateCollectionRequest {
1179
+ interface Collection {
1180
+ /**
1181
+ * Ethereum address of the ERC721 contract
1182
+ * @type {string}
1183
+ * @memberof Collection
1184
+ */
1185
+ 'address': string;
1127
1186
  /**
1128
1187
  * URL of the tile image for this collection
1129
1188
  * @type {string}
1130
- * @memberof CreateCollectionRequest
1189
+ * @memberof Collection
1131
1190
  */
1132
- 'collection_image_url'?: string;
1191
+ 'collection_image_url': string | null;
1133
1192
  /**
1134
- * Ethereum address of the ERC721 contract
1193
+ * Timestamp of when the collection was created
1135
1194
  * @type {string}
1136
- * @memberof CreateCollectionRequest
1195
+ * @memberof Collection
1137
1196
  */
1138
- 'contract_address': string;
1197
+ 'created_at': string | null;
1139
1198
  /**
1140
1199
  * Description of the collection
1141
1200
  * @type {string}
1142
- * @memberof CreateCollectionRequest
1201
+ * @memberof Collection
1143
1202
  */
1144
- 'description'?: string;
1203
+ 'description': string | null;
1145
1204
  /**
1146
1205
  * URL of the icon for this collection
1147
1206
  * @type {string}
1148
- * @memberof CreateCollectionRequest
1207
+ * @memberof Collection
1149
1208
  */
1150
- 'icon_url'?: string;
1209
+ 'icon_url': string | null;
1151
1210
  /**
1152
1211
  * URL of the metadata for this collection
1153
1212
  * @type {string}
1154
- * @memberof CreateCollectionRequest
1213
+ * @memberof Collection
1155
1214
  */
1156
- 'metadata_api_url'?: string;
1215
+ 'metadata_api_url': string | null;
1157
1216
  /**
1158
1217
  * Name of the collection
1159
1218
  * @type {string}
1160
- * @memberof CreateCollectionRequest
1219
+ * @memberof Collection
1161
1220
  */
1162
1221
  'name': string;
1163
1222
  /**
1164
- * Owner Public Key: The uncompressed public key of the owner of the contract
1165
- * @type {string}
1166
- * @memberof CreateCollectionRequest
1167
- */
1168
- 'owner_public_key': string;
1223
+ * The collection\'s project ID
1224
+ * @type {number}
1225
+ * @memberof Collection
1226
+ */
1227
+ 'project_id': number;
1228
+ /**
1229
+ * Project owner address
1230
+ * @type {string}
1231
+ * @memberof Collection
1232
+ */
1233
+ 'project_owner_address': string;
1234
+ /**
1235
+ * Timestamp of when the collection was updated
1236
+ * @type {string}
1237
+ * @memberof Collection
1238
+ */
1239
+ 'updated_at': string | null;
1240
+ }
1241
+
1242
+ /**
1243
+ * Immutable X API
1244
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1245
+ *
1246
+ * The version of the OpenAPI document: 3.0
1247
+ * Contact: support@immutable.com
1248
+ *
1249
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1250
+ * https://openapi-generator.tech
1251
+ * Do not edit the class manually.
1252
+ */
1253
+ /**
1254
+ *
1255
+ * @export
1256
+ * @interface Range
1257
+ */
1258
+ interface Range {
1259
+ /**
1260
+ * Maximum value
1261
+ * @type {number}
1262
+ * @memberof Range
1263
+ */
1264
+ 'max'?: number;
1265
+ /**
1266
+ * Minimum value
1267
+ * @type {number}
1268
+ * @memberof Range
1269
+ */
1270
+ 'min'?: number;
1271
+ }
1272
+
1273
+ /**
1274
+ * Immutable X API
1275
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1276
+ *
1277
+ * The version of the OpenAPI document: 3.0
1278
+ * Contact: support@immutable.com
1279
+ *
1280
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1281
+ * https://openapi-generator.tech
1282
+ * Do not edit the class manually.
1283
+ */
1284
+
1285
+ /**
1286
+ *
1287
+ * @export
1288
+ * @interface CollectionFilter
1289
+ */
1290
+ interface CollectionFilter {
1291
+ /**
1292
+ * Key of this property
1293
+ * @type {string}
1294
+ * @memberof CollectionFilter
1295
+ */
1296
+ 'key'?: string;
1297
+ /**
1298
+ *
1299
+ * @type {Range}
1300
+ * @memberof CollectionFilter
1301
+ */
1302
+ 'range'?: Range;
1303
+ /**
1304
+ * Type of this filter
1305
+ * @type {string}
1306
+ * @memberof CollectionFilter
1307
+ */
1308
+ 'type'?: string;
1309
+ /**
1310
+ * List of possible values for this property
1311
+ * @type {Array<string>}
1312
+ * @memberof CollectionFilter
1313
+ */
1314
+ 'value'?: Array<string>;
1315
+ }
1316
+
1317
+ /**
1318
+ * Immutable X API
1319
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1320
+ *
1321
+ * The version of the OpenAPI document: 3.0
1322
+ * Contact: support@immutable.com
1323
+ *
1324
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1325
+ * https://openapi-generator.tech
1326
+ * Do not edit the class manually.
1327
+ */
1328
+ /**
1329
+ *
1330
+ * @export
1331
+ * @interface ContractCreateAPIRequest
1332
+ */
1333
+ interface ContractCreateAPIRequest {
1334
+ /**
1335
+ *
1336
+ * @type {string}
1337
+ * @memberof ContractCreateAPIRequest
1338
+ */
1339
+ 'contract_address'?: string;
1340
+ /**
1341
+ *
1342
+ * @type {string}
1343
+ * @memberof ContractCreateAPIRequest
1344
+ */
1345
+ 'data_url'?: string;
1346
+ /**
1347
+ *
1348
+ * @type {string}
1349
+ * @memberof ContractCreateAPIRequest
1350
+ */
1351
+ 'mint_url'?: string;
1352
+ }
1353
+
1354
+ /**
1355
+ * Immutable X API
1356
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1357
+ *
1358
+ * The version of the OpenAPI document: 3.0
1359
+ * Contact: support@immutable.com
1360
+ *
1361
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1362
+ * https://openapi-generator.tech
1363
+ * Do not edit the class manually.
1364
+ */
1365
+ /**
1366
+ *
1367
+ * @export
1368
+ * @interface ContractCreateResponse
1369
+ */
1370
+ interface ContractCreateResponse {
1371
+ /**
1372
+ *
1373
+ * @type {string}
1374
+ * @memberof ContractCreateResponse
1375
+ */
1376
+ 'webhook_hash'?: string;
1377
+ }
1378
+
1379
+ /**
1380
+ * Immutable X API
1381
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1382
+ *
1383
+ * The version of the OpenAPI document: 3.0
1384
+ * Contact: support@immutable.com
1385
+ *
1386
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1387
+ * https://openapi-generator.tech
1388
+ * Do not edit the class manually.
1389
+ */
1390
+ /**
1391
+ *
1392
+ * @export
1393
+ * @interface CreateCollectionRequest
1394
+ */
1395
+ interface CreateCollectionRequest {
1396
+ /**
1397
+ * URL of the tile image for this collection
1398
+ * @type {string}
1399
+ * @memberof CreateCollectionRequest
1400
+ */
1401
+ 'collection_image_url'?: string;
1402
+ /**
1403
+ * Ethereum address of the ERC721 contract
1404
+ * @type {string}
1405
+ * @memberof CreateCollectionRequest
1406
+ */
1407
+ 'contract_address': string;
1408
+ /**
1409
+ * Description of the collection
1410
+ * @type {string}
1411
+ * @memberof CreateCollectionRequest
1412
+ */
1413
+ 'description'?: string;
1414
+ /**
1415
+ * URL of the icon for this collection
1416
+ * @type {string}
1417
+ * @memberof CreateCollectionRequest
1418
+ */
1419
+ 'icon_url'?: string;
1420
+ /**
1421
+ * URL of the metadata for this collection
1422
+ * @type {string}
1423
+ * @memberof CreateCollectionRequest
1424
+ */
1425
+ 'metadata_api_url'?: string;
1426
+ /**
1427
+ * Name of the collection
1428
+ * @type {string}
1429
+ * @memberof CreateCollectionRequest
1430
+ */
1431
+ 'name': string;
1432
+ /**
1433
+ * Owner Public Key: The uncompressed public key of the owner of the contract
1434
+ * @type {string}
1435
+ * @memberof CreateCollectionRequest
1436
+ */
1437
+ 'owner_public_key': string;
1169
1438
  /**
1170
1439
  * The collection\'s project ID
1171
1440
  * @type {number}
@@ -1455,48 +1724,140 @@ interface CreateOrderRequest {
1455
1724
  * https://openapi-generator.tech
1456
1725
  * Do not edit the class manually.
1457
1726
  */
1727
+
1458
1728
  /**
1459
1729
  *
1460
1730
  * @export
1461
- * @interface CreateOrderResponse
1731
+ * @interface CreateOrderRequestV3
1462
1732
  */
1463
- interface CreateOrderResponse {
1733
+ interface CreateOrderRequestV3 {
1464
1734
  /**
1465
- * ID of the created order
1466
- * @type {number}
1467
- * @memberof CreateOrderResponse
1735
+ * Amount to buy
1736
+ * @type {string}
1737
+ * @memberof CreateOrderRequestV3
1468
1738
  */
1469
- 'order_id': number;
1739
+ 'amount_buy': string;
1470
1740
  /**
1471
- * Request ID as a reference for an asynchronous order creation request
1741
+ * Amount to sell
1472
1742
  * @type {string}
1473
- * @memberof CreateOrderResponse
1743
+ * @memberof CreateOrderRequestV3
1474
1744
  */
1475
- 'request_id'?: string;
1745
+ 'amount_sell': string;
1476
1746
  /**
1477
- * Status of the created order
1747
+ * ID of the asset to buy
1478
1748
  * @type {string}
1479
- * @memberof CreateOrderResponse
1749
+ * @memberof CreateOrderRequestV3
1480
1750
  */
1481
- 'status': string;
1751
+ 'asset_id_buy': string;
1482
1752
  /**
1483
- * Timestamp of the created order
1753
+ * ID of the asset to sell
1754
+ * @type {string}
1755
+ * @memberof CreateOrderRequestV3
1756
+ */
1757
+ 'asset_id_sell': string;
1758
+ /**
1759
+ * Expiration timestamp for this order
1484
1760
  * @type {number}
1485
- * @memberof CreateOrderResponse
1761
+ * @memberof CreateOrderRequestV3
1486
1762
  */
1487
- 'time': number;
1488
- }
1489
-
1490
- /**
1491
- * Immutable X API
1492
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1493
- *
1494
- * The version of the OpenAPI document: 3.0
1495
- * Contact: support@immutable.com
1496
- *
1497
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1498
- * https://openapi-generator.tech
1499
- * Do not edit the class manually.
1763
+ 'expiration_timestamp': number;
1764
+ /**
1765
+ * Fee information
1766
+ * @type {Array<FeeEntry>}
1767
+ * @memberof CreateOrderRequestV3
1768
+ */
1769
+ 'fees'?: Array<FeeEntry>;
1770
+ /**
1771
+ * [DEPRECATED] Whether to include fees in order
1772
+ * @type {boolean}
1773
+ * @memberof CreateOrderRequestV3
1774
+ */
1775
+ 'include_fees'?: boolean;
1776
+ /**
1777
+ * Nonce of the order
1778
+ * @type {number}
1779
+ * @memberof CreateOrderRequestV3
1780
+ */
1781
+ 'nonce': number;
1782
+ /**
1783
+ * Public stark key of the user creating order
1784
+ * @type {string}
1785
+ * @memberof CreateOrderRequestV3
1786
+ */
1787
+ 'stark_key': string;
1788
+ /**
1789
+ * Payload signature
1790
+ * @type {string}
1791
+ * @memberof CreateOrderRequestV3
1792
+ */
1793
+ 'stark_signature': string;
1794
+ /**
1795
+ * ID of the vault into which the bought asset will be placed
1796
+ * @type {number}
1797
+ * @memberof CreateOrderRequestV3
1798
+ */
1799
+ 'vault_id_buy': number;
1800
+ /**
1801
+ * ID of the vault to sell from
1802
+ * @type {number}
1803
+ * @memberof CreateOrderRequestV3
1804
+ */
1805
+ 'vault_id_sell': number;
1806
+ }
1807
+
1808
+ /**
1809
+ * Immutable X API
1810
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1811
+ *
1812
+ * The version of the OpenAPI document: 3.0
1813
+ * Contact: support@immutable.com
1814
+ *
1815
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1816
+ * https://openapi-generator.tech
1817
+ * Do not edit the class manually.
1818
+ */
1819
+ /**
1820
+ *
1821
+ * @export
1822
+ * @interface CreateOrderResponse
1823
+ */
1824
+ interface CreateOrderResponse {
1825
+ /**
1826
+ * ID of the created order
1827
+ * @type {number}
1828
+ * @memberof CreateOrderResponse
1829
+ */
1830
+ 'order_id': number;
1831
+ /**
1832
+ * Request ID as a reference for an asynchronous order creation request
1833
+ * @type {string}
1834
+ * @memberof CreateOrderResponse
1835
+ */
1836
+ 'request_id'?: string;
1837
+ /**
1838
+ * Status of the created order
1839
+ * @type {string}
1840
+ * @memberof CreateOrderResponse
1841
+ */
1842
+ 'status': string;
1843
+ /**
1844
+ * Timestamp of the created order
1845
+ * @type {number}
1846
+ * @memberof CreateOrderResponse
1847
+ */
1848
+ 'time': number;
1849
+ }
1850
+
1851
+ /**
1852
+ * Immutable X API
1853
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1854
+ *
1855
+ * The version of the OpenAPI document: 3.0
1856
+ * Contact: support@immutable.com
1857
+ *
1858
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1859
+ * https://openapi-generator.tech
1860
+ * Do not edit the class manually.
1500
1861
  */
1501
1862
  /**
1502
1863
  *
@@ -1586,6 +1947,25 @@ interface FeeInfo {
1586
1947
  'source_vault_id': number;
1587
1948
  }
1588
1949
 
1950
+ /**
1951
+ * Immutable X API
1952
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1953
+ *
1954
+ * The version of the OpenAPI document: 3.0
1955
+ * Contact: support@immutable.com
1956
+ *
1957
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1958
+ * https://openapi-generator.tech
1959
+ * Do not edit the class manually.
1960
+ */
1961
+
1962
+ /**
1963
+ * @type CreateTradeRequestV1FeeInfo
1964
+ * Fee details
1965
+ * @export
1966
+ */
1967
+ declare type CreateTradeRequestV1FeeInfo = FeeInfo;
1968
+
1589
1969
  /**
1590
1970
  * Immutable X API
1591
1971
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1636,10 +2016,10 @@ interface CreateTradeRequestV1 {
1636
2016
  'expiration_timestamp': number;
1637
2017
  /**
1638
2018
  *
1639
- * @type {FeeInfo}
2019
+ * @type {CreateTradeRequestV1FeeInfo}
1640
2020
  * @memberof CreateTradeRequestV1
1641
2021
  */
1642
- 'fee_info'?: FeeInfo;
2022
+ 'fee_info'?: CreateTradeRequestV1FeeInfo;
1643
2023
  /**
1644
2024
  * Fee information
1645
2025
  * @type {Array<FeeEntry>}
@@ -2103,106 +2483,6 @@ interface CurrencyWithLimits {
2103
2483
  'symbol'?: string;
2104
2484
  }
2105
2485
 
2106
- /**
2107
- * Immutable X API
2108
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2109
- *
2110
- * The version of the OpenAPI document: 3.0
2111
- * Contact: support@immutable.com
2112
- *
2113
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2114
- * https://openapi-generator.tech
2115
- * Do not edit the class manually.
2116
- */
2117
-
2118
- /**
2119
- *
2120
- * @export
2121
- * @interface TokenData
2122
- */
2123
- interface TokenData {
2124
- /**
2125
- * Number of decimals supported by this asset
2126
- * @type {number}
2127
- * @memberof TokenData
2128
- */
2129
- 'decimals'?: number;
2130
- /**
2131
- * [DEPRECATED] Internal Immutable X Token ID
2132
- * @type {string}
2133
- * @memberof TokenData
2134
- */
2135
- 'id'?: string;
2136
- /**
2137
- *
2138
- * @type {AssetProperties}
2139
- * @memberof TokenData
2140
- */
2141
- 'properties'?: AssetProperties;
2142
- /**
2143
- * Quantity of this asset - inclusive of fees for buy order in v1 API and exclusive of fees in v3 API
2144
- * @type {string}
2145
- * @memberof TokenData
2146
- */
2147
- 'quantity': string;
2148
- /**
2149
- * Quantity of this asset with the sum of all fees applied to the asset
2150
- * @type {string}
2151
- * @memberof TokenData
2152
- */
2153
- 'quantity_with_fees': string;
2154
- /**
2155
- * Symbol of a token
2156
- * @type {string}
2157
- * @memberof TokenData
2158
- */
2159
- 'symbol'?: string;
2160
- /**
2161
- * Address of ERC721/ERC20 contract
2162
- * @type {string}
2163
- * @memberof TokenData
2164
- */
2165
- 'token_address'?: string;
2166
- /**
2167
- * ERC721 Token ID
2168
- * @type {string}
2169
- * @memberof TokenData
2170
- */
2171
- 'token_id'?: string;
2172
- }
2173
-
2174
- /**
2175
- * Immutable X API
2176
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2177
- *
2178
- * The version of the OpenAPI document: 3.0
2179
- * Contact: support@immutable.com
2180
- *
2181
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2182
- * https://openapi-generator.tech
2183
- * Do not edit the class manually.
2184
- */
2185
-
2186
- /**
2187
- *
2188
- * @export
2189
- * @interface Token
2190
- */
2191
- interface Token {
2192
- /**
2193
- *
2194
- * @type {TokenData}
2195
- * @memberof Token
2196
- */
2197
- 'data': TokenData;
2198
- /**
2199
- * Type of this asset (ETH/ERC20/ERC721)
2200
- * @type {string}
2201
- * @memberof Token
2202
- */
2203
- 'type': string;
2204
- }
2205
-
2206
2486
  /**
2207
2487
  * Immutable X API
2208
2488
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -2451,21 +2731,51 @@ interface ExchangeCreateExchangeAndURLResponse {
2451
2731
  /**
2452
2732
  *
2453
2733
  * @export
2454
- * @interface FeeData
2734
+ * @interface MetadataRefreshErrors
2455
2735
  */
2456
- interface FeeData {
2736
+ interface MetadataRefreshErrors {
2457
2737
  /**
2458
- * Address of ERC721/ERC20 contract
2738
+ * Metadata API response for the token
2459
2739
  * @type {string}
2460
- * @memberof FeeData
2740
+ * @memberof MetadataRefreshErrors
2461
2741
  */
2462
- 'contract_address'?: string;
2742
+ 'client_response_body': string | null;
2463
2743
  /**
2464
- * Number of decimals supported by this asset
2465
- * @type {number}
2466
- * @memberof FeeData
2744
+ * Metadata API response code for the token
2745
+ * @type {string}
2746
+ * @memberof MetadataRefreshErrors
2467
2747
  */
2468
- 'decimals'?: number;
2748
+ 'client_response_status_code': string | null;
2749
+ /**
2750
+ * Requested metadata url for the token
2751
+ * @type {string}
2752
+ * @memberof MetadataRefreshErrors
2753
+ */
2754
+ 'client_token_metadata_url': string;
2755
+ /**
2756
+ * The collection contract address
2757
+ * @type {string}
2758
+ * @memberof MetadataRefreshErrors
2759
+ */
2760
+ 'collection_address': string;
2761
+ /**
2762
+ * When the error was created
2763
+ * @type {string}
2764
+ * @memberof MetadataRefreshErrors
2765
+ */
2766
+ 'created_at': string;
2767
+ /**
2768
+ * Metadata refresh error code
2769
+ * @type {string}
2770
+ * @memberof MetadataRefreshErrors
2771
+ */
2772
+ 'error_code': string;
2773
+ /**
2774
+ * The token ID
2775
+ * @type {string}
2776
+ * @memberof MetadataRefreshErrors
2777
+ */
2778
+ 'token_id': string;
2469
2779
  }
2470
2780
 
2471
2781
  /**
@@ -2483,107 +2793,9 @@ interface FeeData {
2483
2793
  /**
2484
2794
  *
2485
2795
  * @export
2486
- * @interface FeeToken
2796
+ * @interface GetMetadataRefreshErrorsResponse
2487
2797
  */
2488
- interface FeeToken {
2489
- /**
2490
- *
2491
- * @type {FeeData}
2492
- * @memberof FeeToken
2493
- */
2494
- 'data'?: FeeData;
2495
- /**
2496
- * Fee token type. One of ETH/ERC20
2497
- * @type {string}
2498
- * @memberof FeeToken
2499
- */
2500
- 'type'?: FeeTokenTypeEnum;
2501
- }
2502
- declare const FeeTokenTypeEnum: {
2503
- readonly Eth: "ETH";
2504
- readonly Erc20: "ERC20";
2505
- };
2506
- declare type FeeTokenTypeEnum = typeof FeeTokenTypeEnum[keyof typeof FeeTokenTypeEnum];
2507
-
2508
- /**
2509
- * Immutable X API
2510
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2511
- *
2512
- * The version of the OpenAPI document: 3.0
2513
- * Contact: support@immutable.com
2514
- *
2515
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2516
- * https://openapi-generator.tech
2517
- * Do not edit the class manually.
2518
- */
2519
- /**
2520
- *
2521
- * @export
2522
- * @interface MetadataRefreshErrors
2523
- */
2524
- interface MetadataRefreshErrors {
2525
- /**
2526
- * Metadata API response for the token
2527
- * @type {string}
2528
- * @memberof MetadataRefreshErrors
2529
- */
2530
- 'client_response_body': string | null;
2531
- /**
2532
- * Metadata API response code for the token
2533
- * @type {string}
2534
- * @memberof MetadataRefreshErrors
2535
- */
2536
- 'client_response_status_code': string | null;
2537
- /**
2538
- * Requested metadata url for the token
2539
- * @type {string}
2540
- * @memberof MetadataRefreshErrors
2541
- */
2542
- 'client_token_metadata_url': string;
2543
- /**
2544
- * The collection contract address
2545
- * @type {string}
2546
- * @memberof MetadataRefreshErrors
2547
- */
2548
- 'collection_address': string;
2549
- /**
2550
- * When the error was created
2551
- * @type {string}
2552
- * @memberof MetadataRefreshErrors
2553
- */
2554
- 'created_at': string;
2555
- /**
2556
- * Metadata refresh error code
2557
- * @type {string}
2558
- * @memberof MetadataRefreshErrors
2559
- */
2560
- 'error_code': string;
2561
- /**
2562
- * The token ID
2563
- * @type {string}
2564
- * @memberof MetadataRefreshErrors
2565
- */
2566
- 'token_id': string;
2567
- }
2568
-
2569
- /**
2570
- * Immutable X API
2571
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2572
- *
2573
- * The version of the OpenAPI document: 3.0
2574
- * Contact: support@immutable.com
2575
- *
2576
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2577
- * https://openapi-generator.tech
2578
- * Do not edit the class manually.
2579
- */
2580
-
2581
- /**
2582
- *
2583
- * @export
2584
- * @interface GetMetadataRefreshErrorsResponse
2585
- */
2586
- interface GetMetadataRefreshErrorsResponse {
2798
+ interface GetMetadataRefreshErrorsResponse {
2587
2799
  /**
2588
2800
  * Generated cursor returned by previous query
2589
2801
  * @type {string}
@@ -3093,6 +3305,44 @@ interface GetSignableDepositResponse {
3093
3305
  'vault_id': number;
3094
3306
  }
3095
3307
 
3308
+ /**
3309
+ * Immutable X API
3310
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3311
+ *
3312
+ * The version of the OpenAPI document: 3.0
3313
+ * Contact: support@immutable.com
3314
+ *
3315
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3316
+ * https://openapi-generator.tech
3317
+ * Do not edit the class manually.
3318
+ */
3319
+
3320
+ /**
3321
+ * @type GetSignableOrderRequestV3TokenBuy
3322
+ * Token to buy
3323
+ * @export
3324
+ */
3325
+ declare type GetSignableOrderRequestV3TokenBuy = SignableToken;
3326
+
3327
+ /**
3328
+ * Immutable X API
3329
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3330
+ *
3331
+ * The version of the OpenAPI document: 3.0
3332
+ * Contact: support@immutable.com
3333
+ *
3334
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3335
+ * https://openapi-generator.tech
3336
+ * Do not edit the class manually.
3337
+ */
3338
+
3339
+ /**
3340
+ * @type GetSignableOrderRequestV3TokenSell
3341
+ * Token to sell
3342
+ * @export
3343
+ */
3344
+ declare type GetSignableOrderRequestV3TokenSell = SignableToken;
3345
+
3096
3346
  /**
3097
3347
  * Immutable X API
3098
3348
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3108,53 +3358,78 @@ interface GetSignableDepositResponse {
3108
3358
  /**
3109
3359
  *
3110
3360
  * @export
3111
- * @interface GetSignableOrderRequest
3361
+ * @interface GetSignableOrderRequestV3
3112
3362
  */
3113
- interface GetSignableOrderRequest {
3363
+ interface GetSignableOrderRequestV3 {
3114
3364
  /**
3115
3365
  * Fee-exclusive amount to buy the asset
3116
3366
  * @type {string}
3117
- * @memberof GetSignableOrderRequest
3367
+ * @memberof GetSignableOrderRequestV3
3118
3368
  */
3119
3369
  'amount_buy': string;
3120
3370
  /**
3121
3371
  * Amount to sell (quantity)
3122
3372
  * @type {string}
3123
- * @memberof GetSignableOrderRequest
3373
+ * @memberof GetSignableOrderRequestV3
3124
3374
  */
3125
3375
  'amount_sell': string;
3126
3376
  /**
3127
3377
  * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
3128
3378
  * @type {number}
3129
- * @memberof GetSignableOrderRequest
3379
+ * @memberof GetSignableOrderRequestV3
3130
3380
  */
3131
3381
  'expiration_timestamp'?: number;
3132
3382
  /**
3133
3383
  * Inclusion of either maker or taker fees
3134
3384
  * @type {Array<FeeEntry>}
3135
- * @memberof GetSignableOrderRequest
3385
+ * @memberof GetSignableOrderRequestV3
3136
3386
  */
3137
3387
  'fees'?: Array<FeeEntry>;
3388
+ /**
3389
+ * 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
3390
+ * @type {boolean}
3391
+ * @memberof GetSignableOrderRequestV3
3392
+ */
3393
+ 'split_fees'?: boolean;
3138
3394
  /**
3139
3395
  *
3140
- * @type {SignableToken}
3141
- * @memberof GetSignableOrderRequest
3396
+ * @type {GetSignableOrderRequestV3TokenBuy}
3397
+ * @memberof GetSignableOrderRequestV3
3142
3398
  */
3143
- 'token_buy': SignableToken;
3399
+ 'token_buy': GetSignableOrderRequestV3TokenBuy;
3144
3400
  /**
3145
3401
  *
3146
- * @type {SignableToken}
3147
- * @memberof GetSignableOrderRequest
3402
+ * @type {GetSignableOrderRequestV3TokenSell}
3403
+ * @memberof GetSignableOrderRequestV3
3148
3404
  */
3149
- 'token_sell': SignableToken;
3405
+ 'token_sell': GetSignableOrderRequestV3TokenSell;
3150
3406
  /**
3151
3407
  * Ethereum address of the submitting user
3152
3408
  * @type {string}
3153
- * @memberof GetSignableOrderRequest
3409
+ * @memberof GetSignableOrderRequestV3
3154
3410
  */
3155
3411
  'user': string;
3156
3412
  }
3157
3413
 
3414
+ /**
3415
+ * Immutable X API
3416
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3417
+ *
3418
+ * The version of the OpenAPI document: 3.0
3419
+ * Contact: support@immutable.com
3420
+ *
3421
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3422
+ * https://openapi-generator.tech
3423
+ * Do not edit the class manually.
3424
+ */
3425
+
3426
+ /**
3427
+ * @type GetSignableOrderResponseFeeInfo
3428
+ * Fee information
3429
+ * @export
3430
+ */
3431
+ declare type GetSignableOrderResponseFeeInfo = FeeInfo;
3432
+
3158
3433
  /**
3159
3434
  * Immutable X API
3160
3435
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3205,10 +3480,10 @@ interface GetSignableOrderResponse {
3205
3480
  'expiration_timestamp': number;
3206
3481
  /**
3207
3482
  *
3208
- * @type {FeeInfo}
3483
+ * @type {GetSignableOrderResponseFeeInfo}
3209
3484
  * @memberof GetSignableOrderResponse
3210
3485
  */
3211
- 'fee_info'?: FeeInfo;
3486
+ 'fee_info'?: GetSignableOrderResponseFeeInfo;
3212
3487
  /**
3213
3488
  * Nonce of the order
3214
3489
  * @type {number}
@@ -3384,6 +3659,25 @@ interface GetSignableTradeRequest {
3384
3659
  'user': string;
3385
3660
  }
3386
3661
 
3662
+ /**
3663
+ * Immutable X API
3664
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3665
+ *
3666
+ * The version of the OpenAPI document: 3.0
3667
+ * Contact: support@immutable.com
3668
+ *
3669
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3670
+ * https://openapi-generator.tech
3671
+ * Do not edit the class manually.
3672
+ */
3673
+
3674
+ /**
3675
+ * @type GetSignableTradeResponseFeeInfo
3676
+ * Fee information
3677
+ * @export
3678
+ */
3679
+ declare type GetSignableTradeResponseFeeInfo = FeeInfo;
3680
+
3387
3681
  /**
3388
3682
  * Immutable X API
3389
3683
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3434,10 +3728,10 @@ interface GetSignableTradeResponse {
3434
3728
  'expiration_timestamp': number;
3435
3729
  /**
3436
3730
  *
3437
- * @type {FeeInfo}
3731
+ * @type {GetSignableTradeResponseFeeInfo}
3438
3732
  * @memberof GetSignableTradeResponse
3439
3733
  */
3440
- 'fee_info'?: FeeInfo;
3734
+ 'fee_info'?: GetSignableTradeResponseFeeInfo;
3441
3735
  /**
3442
3736
  * Nonce of the order
3443
3737
  * @type {number}
@@ -4202,36 +4496,30 @@ interface ListMintsResponse {
4202
4496
  */
4203
4497
 
4204
4498
  /**
4499
+ * @type OrderBuy
4500
+ * Details of the asset being bought
4501
+ * @export
4502
+ */
4503
+ declare type OrderBuy = Token;
4504
+
4505
+ /**
4506
+ * Immutable X API
4507
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4508
+ *
4509
+ * The version of the OpenAPI document: 3.0
4510
+ * Contact: support@immutable.com
4205
4511
  *
4512
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4513
+ * https://openapi-generator.tech
4514
+ * Do not edit the class manually.
4515
+ */
4516
+
4517
+ /**
4518
+ * @type OrderSell
4519
+ * Details of the asset being sold
4206
4520
  * @export
4207
- * @interface OrderFeeInfo
4208
4521
  */
4209
- interface OrderFeeInfo {
4210
- /**
4211
- * Address of the fee recipient
4212
- * @type {string}
4213
- * @memberof OrderFeeInfo
4214
- */
4215
- 'address'?: string;
4216
- /**
4217
- * Fee amount
4218
- * @type {string}
4219
- * @memberof OrderFeeInfo
4220
- */
4221
- 'amount'?: string;
4222
- /**
4223
- *
4224
- * @type {FeeToken}
4225
- * @memberof OrderFeeInfo
4226
- */
4227
- 'token'?: FeeToken;
4228
- /**
4229
- * Fee type
4230
- * @type {string}
4231
- * @memberof OrderFeeInfo
4232
- */
4233
- 'type'?: string;
4234
- }
4522
+ declare type OrderSell = Token;
4235
4523
 
4236
4524
  /**
4237
4525
  * Immutable X API
@@ -4259,10 +4547,10 @@ interface Order {
4259
4547
  'amount_sold': string | null;
4260
4548
  /**
4261
4549
  *
4262
- * @type {Token}
4550
+ * @type {OrderBuy}
4263
4551
  * @memberof Order
4264
4552
  */
4265
- 'buy': Token;
4553
+ 'buy': OrderBuy;
4266
4554
  /**
4267
4555
  * Expiration timestamp of this order
4268
4556
  * @type {string}
@@ -4283,10 +4571,10 @@ interface Order {
4283
4571
  'order_id': number;
4284
4572
  /**
4285
4573
  *
4286
- * @type {Token}
4574
+ * @type {OrderSell}
4287
4575
  * @memberof Order
4288
4576
  */
4289
- 'sell': Token;
4577
+ 'sell': OrderSell;
4290
4578
  /**
4291
4579
  * Status of the order
4292
4580
  * @type {string}
@@ -4362,48 +4650,68 @@ interface ListOrdersResponse {
4362
4650
  * https://openapi-generator.tech
4363
4651
  * Do not edit the class manually.
4364
4652
  */
4653
+
4654
+ /**
4655
+ * @type OrderV3Buy
4656
+ * Details of the asset being bought
4657
+ * @export
4658
+ */
4659
+ declare type OrderV3Buy = Token;
4660
+
4661
+ /**
4662
+ * Immutable X API
4663
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4664
+ *
4665
+ * The version of the OpenAPI document: 3.0
4666
+ * Contact: support@immutable.com
4667
+ *
4668
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4669
+ * https://openapi-generator.tech
4670
+ * Do not edit the class manually.
4671
+ */
4672
+
4365
4673
  /**
4366
4674
  *
4367
4675
  * @export
4368
- * @interface TokenDetails
4676
+ * @interface OrdersMakerTakerFee
4369
4677
  */
4370
- interface TokenDetails {
4678
+ interface OrdersMakerTakerFee {
4371
4679
  /**
4372
- * Number of decimals for token
4373
- * @type {string}
4374
- * @memberof TokenDetails
4680
+ * Number of Decimals supported the fee token
4681
+ * @type {number}
4682
+ * @memberof OrdersMakerTakerFee
4375
4683
  */
4376
- 'decimals': string;
4684
+ 'decimals'?: number;
4377
4685
  /**
4378
- * Url for the icon of the token
4379
- * @type {string}
4380
- * @memberof TokenDetails
4686
+ * Fees
4687
+ * @type {Array<OrderFeeInfo>}
4688
+ * @memberof OrdersMakerTakerFee
4381
4689
  */
4382
- 'image_url': string;
4690
+ 'fees'?: Array<OrderFeeInfo>;
4383
4691
  /**
4384
- * Full name of the token (e.g. Ether)
4692
+ * Quantity of this asset with the sum of all fees applied to the asset
4385
4693
  * @type {string}
4386
- * @memberof TokenDetails
4694
+ * @memberof OrdersMakerTakerFee
4387
4695
  */
4388
- 'name': string;
4696
+ 'quantity_with_fees': string;
4389
4697
  /**
4390
- * Quantum for token
4698
+ * Symbol of the fee token
4391
4699
  * @type {string}
4392
- * @memberof TokenDetails
4700
+ * @memberof OrdersMakerTakerFee
4393
4701
  */
4394
- 'quantum': string;
4702
+ 'symbol'?: string;
4395
4703
  /**
4396
- * Ticker symbol for token (e.g. ETH/USDC/IMX)
4704
+ * Address of the ERC20 contract for the fee token
4397
4705
  * @type {string}
4398
- * @memberof TokenDetails
4706
+ * @memberof OrdersMakerTakerFee
4399
4707
  */
4400
- 'symbol': string;
4708
+ 'token_address'?: string;
4401
4709
  /**
4402
- * Address of the ERC721 contract
4710
+ * Type of the fee token (ETH/ERC20)
4403
4711
  * @type {string}
4404
- * @memberof TokenDetails
4712
+ * @memberof OrdersMakerTakerFee
4405
4713
  */
4406
- 'token_address': string;
4714
+ 'token_type'?: string;
4407
4715
  }
4408
4716
 
4409
4717
  /**
@@ -4419,9 +4727,257 @@ interface TokenDetails {
4419
4727
  */
4420
4728
 
4421
4729
  /**
4422
- *
4730
+ * @type OrderV3MakerFees
4731
+ * MakerFees is the information about the fees that needs to be paid by the maker (liquidity)
4423
4732
  * @export
4424
- * @interface ListTokensResponse
4733
+ */
4734
+ declare type OrderV3MakerFees = OrdersMakerTakerFee;
4735
+
4736
+ /**
4737
+ * Immutable X API
4738
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4739
+ *
4740
+ * The version of the OpenAPI document: 3.0
4741
+ * Contact: support@immutable.com
4742
+ *
4743
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4744
+ * https://openapi-generator.tech
4745
+ * Do not edit the class manually.
4746
+ */
4747
+
4748
+ /**
4749
+ * @type OrderV3Sell
4750
+ * Details of the asset being sold
4751
+ * @export
4752
+ */
4753
+ declare type OrderV3Sell = Token;
4754
+
4755
+ /**
4756
+ * Immutable X API
4757
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4758
+ *
4759
+ * The version of the OpenAPI document: 3.0
4760
+ * Contact: support@immutable.com
4761
+ *
4762
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4763
+ * https://openapi-generator.tech
4764
+ * Do not edit the class manually.
4765
+ */
4766
+
4767
+ /**
4768
+ * @type OrderV3TakerFees
4769
+ * TakerFees is the information about the fees that needs to be paid by the taker (liquidity)
4770
+ * @export
4771
+ */
4772
+ declare type OrderV3TakerFees = OrdersMakerTakerFee;
4773
+
4774
+ /**
4775
+ * Immutable X API
4776
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4777
+ *
4778
+ * The version of the OpenAPI document: 3.0
4779
+ * Contact: support@immutable.com
4780
+ *
4781
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4782
+ * https://openapi-generator.tech
4783
+ * Do not edit the class manually.
4784
+ */
4785
+
4786
+ /**
4787
+ *
4788
+ * @export
4789
+ * @interface OrderV3
4790
+ */
4791
+ interface OrderV3 {
4792
+ /**
4793
+ * Amount of the asset already sold by this order
4794
+ * @type {string}
4795
+ * @memberof OrderV3
4796
+ */
4797
+ 'amount_sold': string | null;
4798
+ /**
4799
+ *
4800
+ * @type {OrderV3Buy}
4801
+ * @memberof OrderV3
4802
+ */
4803
+ 'buy': OrderV3Buy;
4804
+ /**
4805
+ * Expiration timestamp of this order
4806
+ * @type {string}
4807
+ * @memberof OrderV3
4808
+ */
4809
+ 'expiration_timestamp': string | null;
4810
+ /**
4811
+ * Fee information for the order
4812
+ * @type {Array<OrderFeeInfo>}
4813
+ * @memberof OrderV3
4814
+ */
4815
+ 'fees'?: Array<OrderFeeInfo>;
4816
+ /**
4817
+ *
4818
+ * @type {OrderV3MakerFees}
4819
+ * @memberof OrderV3
4820
+ */
4821
+ 'maker_fees'?: OrderV3MakerFees;
4822
+ /**
4823
+ * MakerTakerType
4824
+ * @type {string}
4825
+ * @memberof OrderV3
4826
+ */
4827
+ 'maker_taker_type'?: string;
4828
+ /**
4829
+ * ID of the order
4830
+ * @type {number}
4831
+ * @memberof OrderV3
4832
+ */
4833
+ 'order_id': number;
4834
+ /**
4835
+ *
4836
+ * @type {OrderV3Sell}
4837
+ * @memberof OrderV3
4838
+ */
4839
+ 'sell': OrderV3Sell;
4840
+ /**
4841
+ * Status of the order
4842
+ * @type {string}
4843
+ * @memberof OrderV3
4844
+ */
4845
+ 'status': string;
4846
+ /**
4847
+ *
4848
+ * @type {OrderV3TakerFees}
4849
+ * @memberof OrderV3
4850
+ */
4851
+ 'taker_fees'?: OrderV3TakerFees;
4852
+ /**
4853
+ * Timestamp this order was created
4854
+ * @type {string}
4855
+ * @memberof OrderV3
4856
+ */
4857
+ 'timestamp': string | null;
4858
+ /**
4859
+ * Updated timestamp of this order
4860
+ * @type {string}
4861
+ * @memberof OrderV3
4862
+ */
4863
+ 'updated_timestamp': string | null;
4864
+ /**
4865
+ * Ethereum address of the user who submitted the order
4866
+ * @type {string}
4867
+ * @memberof OrderV3
4868
+ */
4869
+ 'user': string;
4870
+ }
4871
+
4872
+ /**
4873
+ * Immutable X API
4874
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4875
+ *
4876
+ * The version of the OpenAPI document: 3.0
4877
+ * Contact: support@immutable.com
4878
+ *
4879
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4880
+ * https://openapi-generator.tech
4881
+ * Do not edit the class manually.
4882
+ */
4883
+
4884
+ /**
4885
+ *
4886
+ * @export
4887
+ * @interface ListOrdersResponseV3
4888
+ */
4889
+ interface ListOrdersResponseV3 {
4890
+ /**
4891
+ * Generated cursor returned by previous query
4892
+ * @type {string}
4893
+ * @memberof ListOrdersResponseV3
4894
+ */
4895
+ 'cursor': string;
4896
+ /**
4897
+ * Remaining results flag. 1: there are remaining results matching this query, 0: no remaining results
4898
+ * @type {number}
4899
+ * @memberof ListOrdersResponseV3
4900
+ */
4901
+ 'remaining': number;
4902
+ /**
4903
+ * Orders matching query parameters
4904
+ * @type {Array<OrderV3>}
4905
+ * @memberof ListOrdersResponseV3
4906
+ */
4907
+ 'result': Array<OrderV3>;
4908
+ }
4909
+
4910
+ /**
4911
+ * Immutable X API
4912
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4913
+ *
4914
+ * The version of the OpenAPI document: 3.0
4915
+ * Contact: support@immutable.com
4916
+ *
4917
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4918
+ * https://openapi-generator.tech
4919
+ * Do not edit the class manually.
4920
+ */
4921
+ /**
4922
+ *
4923
+ * @export
4924
+ * @interface TokenDetails
4925
+ */
4926
+ interface TokenDetails {
4927
+ /**
4928
+ * Number of decimals for token
4929
+ * @type {string}
4930
+ * @memberof TokenDetails
4931
+ */
4932
+ 'decimals': string;
4933
+ /**
4934
+ * Url for the icon of the token
4935
+ * @type {string}
4936
+ * @memberof TokenDetails
4937
+ */
4938
+ 'image_url': string;
4939
+ /**
4940
+ * Full name of the token (e.g. Ether)
4941
+ * @type {string}
4942
+ * @memberof TokenDetails
4943
+ */
4944
+ 'name': string;
4945
+ /**
4946
+ * Quantum for token
4947
+ * @type {string}
4948
+ * @memberof TokenDetails
4949
+ */
4950
+ 'quantum': string;
4951
+ /**
4952
+ * Ticker symbol for token (e.g. ETH/USDC/IMX)
4953
+ * @type {string}
4954
+ * @memberof TokenDetails
4955
+ */
4956
+ 'symbol': string;
4957
+ /**
4958
+ * Address of the ERC721 contract
4959
+ * @type {string}
4960
+ * @memberof TokenDetails
4961
+ */
4962
+ 'token_address': string;
4963
+ }
4964
+
4965
+ /**
4966
+ * Immutable X API
4967
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4968
+ *
4969
+ * The version of the OpenAPI document: 3.0
4970
+ * Contact: support@immutable.com
4971
+ *
4972
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4973
+ * https://openapi-generator.tech
4974
+ * Do not edit the class manually.
4975
+ */
4976
+
4977
+ /**
4978
+ *
4979
+ * @export
4980
+ * @interface ListTokensResponse
4425
4981
  */
4426
4982
  interface ListTokensResponse {
4427
4983
  /**
@@ -4487,6 +5043,44 @@ interface TradeSide {
4487
5043
  'token_type': string;
4488
5044
  }
4489
5045
 
5046
+ /**
5047
+ * Immutable X API
5048
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5049
+ *
5050
+ * The version of the OpenAPI document: 3.0
5051
+ * Contact: support@immutable.com
5052
+ *
5053
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5054
+ * https://openapi-generator.tech
5055
+ * Do not edit the class manually.
5056
+ */
5057
+
5058
+ /**
5059
+ * @type TradeA
5060
+ * Side A of this trade (the buy order)
5061
+ * @export
5062
+ */
5063
+ declare type TradeA = TradeSide;
5064
+
5065
+ /**
5066
+ * Immutable X API
5067
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5068
+ *
5069
+ * The version of the OpenAPI document: 3.0
5070
+ * Contact: support@immutable.com
5071
+ *
5072
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5073
+ * https://openapi-generator.tech
5074
+ * Do not edit the class manually.
5075
+ */
5076
+
5077
+ /**
5078
+ * @type TradeB
5079
+ * Side B of this trade (the sell order)
5080
+ * @export
5081
+ */
5082
+ declare type TradeB = TradeSide;
5083
+
4490
5084
  /**
4491
5085
  * Immutable X API
4492
5086
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4507,16 +5101,16 @@ interface TradeSide {
4507
5101
  interface Trade {
4508
5102
  /**
4509
5103
  *
4510
- * @type {TradeSide}
5104
+ * @type {TradeA}
4511
5105
  * @memberof Trade
4512
5106
  */
4513
- 'a': TradeSide;
5107
+ 'a': TradeA;
4514
5108
  /**
4515
5109
  *
4516
- * @type {TradeSide}
5110
+ * @type {TradeB}
4517
5111
  * @memberof Trade
4518
5112
  */
4519
- 'b': TradeSide;
5113
+ 'b': TradeB;
4520
5114
  /**
4521
5115
  * Status of this trade
4522
5116
  * @type {string}
@@ -5535,23 +6129,146 @@ interface SuccessResponse {
5535
6129
  * https://openapi-generator.tech
5536
6130
  * Do not edit the class manually.
5537
6131
  */
6132
+
5538
6133
  /**
5539
- *
6134
+ * @type TradesCreateTradeRequestFeeInfo
6135
+ * Fee details
5540
6136
  * @export
5541
- * @interface UpdateCollectionRequest
5542
6137
  */
5543
- interface UpdateCollectionRequest {
5544
- /**
5545
- * URL of the tile image for this collection
5546
- * @type {string}
5547
- * @memberof UpdateCollectionRequest
5548
- */
5549
- 'collection_image_url'?: string;
5550
- /**
5551
- * Description of the collection
5552
- * @type {string}
5553
- * @memberof UpdateCollectionRequest
5554
- */
6138
+ declare type TradesCreateTradeRequestFeeInfo = FeeInfo;
6139
+
6140
+ /**
6141
+ * Immutable X API
6142
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6143
+ *
6144
+ * The version of the OpenAPI document: 3.0
6145
+ * Contact: support@immutable.com
6146
+ *
6147
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6148
+ * https://openapi-generator.tech
6149
+ * Do not edit the class manually.
6150
+ */
6151
+
6152
+ /**
6153
+ *
6154
+ * @export
6155
+ * @interface TradesCreateTradeRequest
6156
+ */
6157
+ interface TradesCreateTradeRequest {
6158
+ /**
6159
+ * Amount to buy
6160
+ * @type {string}
6161
+ * @memberof TradesCreateTradeRequest
6162
+ */
6163
+ 'amount_buy': string;
6164
+ /**
6165
+ * Amount to sell
6166
+ * @type {string}
6167
+ * @memberof TradesCreateTradeRequest
6168
+ */
6169
+ 'amount_sell': string;
6170
+ /**
6171
+ * ID of the asset to buy
6172
+ * @type {string}
6173
+ * @memberof TradesCreateTradeRequest
6174
+ */
6175
+ 'asset_id_buy': string;
6176
+ /**
6177
+ * ID of the asset to sell
6178
+ * @type {string}
6179
+ * @memberof TradesCreateTradeRequest
6180
+ */
6181
+ 'asset_id_sell': string;
6182
+ /**
6183
+ * Expiration timestamp for this trade
6184
+ * @type {number}
6185
+ * @memberof TradesCreateTradeRequest
6186
+ */
6187
+ 'expiration_timestamp': number;
6188
+ /**
6189
+ *
6190
+ * @type {TradesCreateTradeRequestFeeInfo}
6191
+ * @memberof TradesCreateTradeRequest
6192
+ */
6193
+ 'fee_info'?: TradesCreateTradeRequestFeeInfo;
6194
+ /**
6195
+ * Fee information
6196
+ * @type {Array<FeeEntry>}
6197
+ * @memberof TradesCreateTradeRequest
6198
+ */
6199
+ 'fees'?: Array<FeeEntry>;
6200
+ /**
6201
+ * [deprecated] All orders include fees since the introduction of protocol fees
6202
+ * @type {boolean}
6203
+ * @memberof TradesCreateTradeRequest
6204
+ */
6205
+ 'include_fees'?: boolean;
6206
+ /**
6207
+ * Nonce of the trade
6208
+ * @type {number}
6209
+ * @memberof TradesCreateTradeRequest
6210
+ */
6211
+ 'nonce': number;
6212
+ /**
6213
+ * ID of the order
6214
+ * @type {number}
6215
+ * @memberof TradesCreateTradeRequest
6216
+ */
6217
+ 'order_id': number;
6218
+ /**
6219
+ * Public stark key of the user creating trade
6220
+ * @type {string}
6221
+ * @memberof TradesCreateTradeRequest
6222
+ */
6223
+ 'stark_key': string;
6224
+ /**
6225
+ * Payload signature
6226
+ * @type {string}
6227
+ * @memberof TradesCreateTradeRequest
6228
+ */
6229
+ 'stark_signature': string;
6230
+ /**
6231
+ * ID of the vault into which the traded asset will be placed
6232
+ * @type {number}
6233
+ * @memberof TradesCreateTradeRequest
6234
+ */
6235
+ 'vault_id_buy': number;
6236
+ /**
6237
+ * ID of the vault to sell from
6238
+ * @type {number}
6239
+ * @memberof TradesCreateTradeRequest
6240
+ */
6241
+ 'vault_id_sell': number;
6242
+ }
6243
+
6244
+ /**
6245
+ * Immutable X API
6246
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6247
+ *
6248
+ * The version of the OpenAPI document: 3.0
6249
+ * Contact: support@immutable.com
6250
+ *
6251
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6252
+ * https://openapi-generator.tech
6253
+ * Do not edit the class manually.
6254
+ */
6255
+ /**
6256
+ *
6257
+ * @export
6258
+ * @interface UpdateCollectionRequest
6259
+ */
6260
+ interface UpdateCollectionRequest {
6261
+ /**
6262
+ * URL of the tile image for this collection
6263
+ * @type {string}
6264
+ * @memberof UpdateCollectionRequest
6265
+ */
6266
+ 'collection_image_url'?: string;
6267
+ /**
6268
+ * Description of the collection
6269
+ * @type {string}
6270
+ * @memberof UpdateCollectionRequest
6271
+ */
5555
6272
  'description'?: string;
5556
6273
  /**
5557
6274
  * URL of the icon for this collection
@@ -5739,7 +6456,7 @@ interface BalancesApiGetBalanceRequest {
5739
6456
  */
5740
6457
  readonly owner: string;
5741
6458
  /**
5742
- * Token address
6459
+ * Token address or \&#39;eth\&#39;
5743
6460
  * @type {string}
5744
6461
  * @memberof BalancesApiGetBalance
5745
6462
  */
@@ -7057,290 +7774,583 @@ interface OrdersApiCancelOrderRequest {
7057
7774
  */
7058
7775
  readonly cancelOrderRequest: CancelOrderRequest;
7059
7776
  /**
7060
- * eth address
7777
+ * eth address
7778
+ * @type {string}
7779
+ * @memberof OrdersApiCancelOrder
7780
+ */
7781
+ readonly xImxEthAddress?: string;
7782
+ /**
7783
+ * eth signature
7784
+ * @type {string}
7785
+ * @memberof OrdersApiCancelOrder
7786
+ */
7787
+ readonly xImxEthSignature?: string;
7788
+ /**
7789
+ * Authorization header
7790
+ * @type {string}
7791
+ * @memberof OrdersApiCancelOrder
7792
+ */
7793
+ readonly authorization?: string;
7794
+ }
7795
+ /**
7796
+ * Request parameters for cancelOrderV3 operation in OrdersApi.
7797
+ * @export
7798
+ * @interface OrdersApiCancelOrderV3Request
7799
+ */
7800
+ interface OrdersApiCancelOrderV3Request {
7801
+ /**
7802
+ * Order ID to cancel
7803
+ * @type {string}
7804
+ * @memberof OrdersApiCancelOrderV3
7805
+ */
7806
+ readonly id: string;
7807
+ /**
7808
+ * cancel an order
7809
+ * @type {CancelOrderRequest}
7810
+ * @memberof OrdersApiCancelOrderV3
7811
+ */
7812
+ readonly cancelOrderRequest: CancelOrderRequest;
7813
+ /**
7814
+ * eth address
7815
+ * @type {string}
7816
+ * @memberof OrdersApiCancelOrderV3
7817
+ */
7818
+ readonly xImxEthAddress?: string;
7819
+ /**
7820
+ * eth signature
7821
+ * @type {string}
7822
+ * @memberof OrdersApiCancelOrderV3
7823
+ */
7824
+ readonly xImxEthSignature?: string;
7825
+ /**
7826
+ * Authorization header
7827
+ * @type {string}
7828
+ * @memberof OrdersApiCancelOrderV3
7829
+ */
7830
+ readonly authorization?: string;
7831
+ }
7832
+ /**
7833
+ * Request parameters for createOrder operation in OrdersApi.
7834
+ * @export
7835
+ * @interface OrdersApiCreateOrderRequest
7836
+ */
7837
+ interface OrdersApiCreateOrderRequest {
7838
+ /**
7839
+ * create an order
7840
+ * @type {CreateOrderRequest}
7841
+ * @memberof OrdersApiCreateOrder
7842
+ */
7843
+ readonly createOrderRequest: CreateOrderRequest;
7844
+ /**
7845
+ * eth address
7846
+ * @type {string}
7847
+ * @memberof OrdersApiCreateOrder
7848
+ */
7849
+ readonly xImxEthAddress?: string;
7850
+ /**
7851
+ * eth signature
7852
+ * @type {string}
7853
+ * @memberof OrdersApiCreateOrder
7854
+ */
7855
+ readonly xImxEthSignature?: string;
7856
+ /**
7857
+ * Authorization header
7858
+ * @type {string}
7859
+ * @memberof OrdersApiCreateOrder
7860
+ */
7861
+ readonly authorization?: string;
7862
+ }
7863
+ /**
7864
+ * Request parameters for createOrderV3 operation in OrdersApi.
7865
+ * @export
7866
+ * @interface OrdersApiCreateOrderV3Request
7867
+ */
7868
+ interface OrdersApiCreateOrderV3Request {
7869
+ /**
7870
+ * create an order
7871
+ * @type {CreateOrderRequestV3}
7872
+ * @memberof OrdersApiCreateOrderV3
7873
+ */
7874
+ readonly createOrderRequest: CreateOrderRequestV3;
7875
+ /**
7876
+ * eth address
7877
+ * @type {string}
7878
+ * @memberof OrdersApiCreateOrderV3
7879
+ */
7880
+ readonly xImxEthAddress?: string;
7881
+ /**
7882
+ * eth signature
7883
+ * @type {string}
7884
+ * @memberof OrdersApiCreateOrderV3
7885
+ */
7886
+ readonly xImxEthSignature?: string;
7887
+ /**
7888
+ * Authorization header
7889
+ * @type {string}
7890
+ * @memberof OrdersApiCreateOrderV3
7891
+ */
7892
+ readonly authorization?: string;
7893
+ }
7894
+ /**
7895
+ * Request parameters for getOrder operation in OrdersApi.
7896
+ * @export
7897
+ * @interface OrdersApiGetOrderRequest
7898
+ */
7899
+ interface OrdersApiGetOrderRequest {
7900
+ /**
7901
+ * Order ID
7902
+ * @type {string}
7903
+ * @memberof OrdersApiGetOrder
7904
+ */
7905
+ readonly id: string;
7906
+ /**
7907
+ * Set flag to true to include fee body for the order
7908
+ * @type {boolean}
7909
+ * @memberof OrdersApiGetOrder
7910
+ */
7911
+ readonly includeFees?: boolean;
7912
+ /**
7913
+ * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
7914
+ * @type {string}
7915
+ * @memberof OrdersApiGetOrder
7916
+ */
7917
+ readonly auxiliaryFeePercentages?: string;
7918
+ /**
7919
+ * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
7920
+ * @type {string}
7921
+ * @memberof OrdersApiGetOrder
7922
+ */
7923
+ readonly auxiliaryFeeRecipients?: string;
7924
+ }
7925
+ /**
7926
+ * Request parameters for getOrderV3 operation in OrdersApi.
7927
+ * @export
7928
+ * @interface OrdersApiGetOrderV3Request
7929
+ */
7930
+ interface OrdersApiGetOrderV3Request {
7931
+ /**
7932
+ * Order ID
7933
+ * @type {string}
7934
+ * @memberof OrdersApiGetOrderV3
7935
+ */
7936
+ readonly id: string;
7937
+ /**
7938
+ * Set flag to true to include fee body for the order
7939
+ * @type {boolean}
7940
+ * @memberof OrdersApiGetOrderV3
7941
+ */
7942
+ readonly includeFees?: boolean;
7943
+ /**
7944
+ * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
7945
+ * @type {string}
7946
+ * @memberof OrdersApiGetOrderV3
7947
+ */
7948
+ readonly auxiliaryFeePercentages?: string;
7949
+ /**
7950
+ * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
7951
+ * @type {string}
7952
+ * @memberof OrdersApiGetOrderV3
7953
+ */
7954
+ readonly auxiliaryFeeRecipients?: string;
7955
+ }
7956
+ /**
7957
+ * Request parameters for getSignableCancelOrder operation in OrdersApi.
7958
+ * @export
7959
+ * @interface OrdersApiGetSignableCancelOrderRequest
7960
+ */
7961
+ interface OrdersApiGetSignableCancelOrderRequest {
7962
+ /**
7963
+ * get a signable cancel order
7964
+ * @type {GetSignableCancelOrderRequest}
7965
+ * @memberof OrdersApiGetSignableCancelOrder
7966
+ */
7967
+ readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
7968
+ }
7969
+ /**
7970
+ * Request parameters for getSignableCancelOrderV3 operation in OrdersApi.
7971
+ * @export
7972
+ * @interface OrdersApiGetSignableCancelOrderV3Request
7973
+ */
7974
+ interface OrdersApiGetSignableCancelOrderV3Request {
7975
+ /**
7976
+ * get a signable cancel order
7977
+ * @type {GetSignableCancelOrderRequest}
7978
+ * @memberof OrdersApiGetSignableCancelOrderV3
7979
+ */
7980
+ readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
7981
+ }
7982
+ /**
7983
+ * Request parameters for getSignableOrder operation in OrdersApi.
7984
+ * @export
7985
+ * @interface OrdersApiGetSignableOrderRequest
7986
+ */
7987
+ interface OrdersApiGetSignableOrderRequest {
7988
+ /**
7989
+ * get a signable order v3
7990
+ * @type {GetSignableOrderRequestV3}
7991
+ * @memberof OrdersApiGetSignableOrder
7992
+ */
7993
+ readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
7994
+ }
7995
+ /**
7996
+ * Request parameters for listOrders operation in OrdersApi.
7997
+ * @export
7998
+ * @interface OrdersApiListOrdersRequest
7999
+ */
8000
+ interface OrdersApiListOrdersRequest {
8001
+ /**
8002
+ * Page size of the result
8003
+ * @type {number}
8004
+ * @memberof OrdersApiListOrders
8005
+ */
8006
+ readonly pageSize?: number;
8007
+ /**
8008
+ * Cursor
8009
+ * @type {string}
8010
+ * @memberof OrdersApiListOrders
8011
+ */
8012
+ readonly cursor?: string;
8013
+ /**
8014
+ * Property to sort by
8015
+ * @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
8016
+ * @memberof OrdersApiListOrders
8017
+ */
8018
+ readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
8019
+ /**
8020
+ * Direction to sort (asc/desc)
8021
+ * @type {string}
8022
+ * @memberof OrdersApiListOrders
8023
+ */
8024
+ readonly direction?: string;
8025
+ /**
8026
+ * Ethereum address of the user who submitted this order
8027
+ * @type {string}
8028
+ * @memberof OrdersApiListOrders
8029
+ */
8030
+ readonly user?: string;
8031
+ /**
8032
+ * Status of this order
8033
+ * @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
8034
+ * @memberof OrdersApiListOrders
8035
+ */
8036
+ readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
8037
+ /**
8038
+ * 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;
8039
+ * @type {string}
8040
+ * @memberof OrdersApiListOrders
8041
+ */
8042
+ readonly minTimestamp?: string;
8043
+ /**
8044
+ * 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;
8045
+ * @type {string}
8046
+ * @memberof OrdersApiListOrders
8047
+ */
8048
+ readonly maxTimestamp?: string;
8049
+ /**
8050
+ * 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;
8051
+ * @type {string}
8052
+ * @memberof OrdersApiListOrders
8053
+ */
8054
+ readonly updatedMinTimestamp?: string;
8055
+ /**
8056
+ * 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;
8057
+ * @type {string}
8058
+ * @memberof OrdersApiListOrders
8059
+ */
8060
+ readonly updatedMaxTimestamp?: string;
8061
+ /**
8062
+ * Token type of the asset this order buys
8063
+ * @type {string}
8064
+ * @memberof OrdersApiListOrders
8065
+ */
8066
+ readonly buyTokenType?: string;
8067
+ /**
8068
+ * ERC721 Token ID of the asset this order buys
8069
+ * @type {string}
8070
+ * @memberof OrdersApiListOrders
8071
+ */
8072
+ readonly buyTokenId?: string;
8073
+ /**
8074
+ * Internal IMX ID of the asset this order buys
8075
+ * @type {string}
8076
+ * @memberof OrdersApiListOrders
8077
+ */
8078
+ readonly buyAssetId?: string;
8079
+ /**
8080
+ * Token address of the asset this order buys
8081
+ * @type {string}
8082
+ * @memberof OrdersApiListOrders
8083
+ */
8084
+ readonly buyTokenAddress?: string;
8085
+ /**
8086
+ * Token name of the asset this order buys
8087
+ * @type {string}
8088
+ * @memberof OrdersApiListOrders
8089
+ */
8090
+ readonly buyTokenName?: string;
8091
+ /**
8092
+ * Min quantity for the asset this order buys
8093
+ * @type {string}
8094
+ * @memberof OrdersApiListOrders
8095
+ */
8096
+ readonly buyMinQuantity?: string;
8097
+ /**
8098
+ * Max quantity for the asset this order buys
8099
+ * @type {string}
8100
+ * @memberof OrdersApiListOrders
8101
+ */
8102
+ readonly buyMaxQuantity?: string;
8103
+ /**
8104
+ * JSON-encoded metadata filters for the asset this order buys
7061
8105
  * @type {string}
7062
- * @memberof OrdersApiCancelOrder
8106
+ * @memberof OrdersApiListOrders
7063
8107
  */
7064
- readonly xImxEthAddress?: string;
8108
+ readonly buyMetadata?: string;
7065
8109
  /**
7066
- * eth signature
8110
+ * Token type of the asset this order sells
7067
8111
  * @type {string}
7068
- * @memberof OrdersApiCancelOrder
8112
+ * @memberof OrdersApiListOrders
7069
8113
  */
7070
- readonly xImxEthSignature?: string;
8114
+ readonly sellTokenType?: string;
7071
8115
  /**
7072
- * Authorization header
8116
+ * ERC721 Token ID of the asset this order sells
7073
8117
  * @type {string}
7074
- * @memberof OrdersApiCancelOrder
8118
+ * @memberof OrdersApiListOrders
7075
8119
  */
7076
- readonly authorization?: string;
7077
- }
7078
- /**
7079
- * Request parameters for createOrder operation in OrdersApi.
7080
- * @export
7081
- * @interface OrdersApiCreateOrderRequest
7082
- */
7083
- interface OrdersApiCreateOrderRequest {
8120
+ readonly sellTokenId?: string;
7084
8121
  /**
7085
- * create an order
7086
- * @type {CreateOrderRequest}
7087
- * @memberof OrdersApiCreateOrder
8122
+ * Internal IMX ID of the asset this order sells
8123
+ * @type {string}
8124
+ * @memberof OrdersApiListOrders
7088
8125
  */
7089
- readonly createOrderRequest: CreateOrderRequest;
8126
+ readonly sellAssetId?: string;
7090
8127
  /**
7091
- * eth address
8128
+ * Token address of the asset this order sells
7092
8129
  * @type {string}
7093
- * @memberof OrdersApiCreateOrder
8130
+ * @memberof OrdersApiListOrders
7094
8131
  */
7095
- readonly xImxEthAddress?: string;
8132
+ readonly sellTokenAddress?: string;
7096
8133
  /**
7097
- * eth signature
8134
+ * Token name of the asset this order sells
7098
8135
  * @type {string}
7099
- * @memberof OrdersApiCreateOrder
8136
+ * @memberof OrdersApiListOrders
7100
8137
  */
7101
- readonly xImxEthSignature?: string;
8138
+ readonly sellTokenName?: string;
7102
8139
  /**
7103
- * Authorization header
8140
+ * Min quantity for the asset this order sells
7104
8141
  * @type {string}
7105
- * @memberof OrdersApiCreateOrder
8142
+ * @memberof OrdersApiListOrders
7106
8143
  */
7107
- readonly authorization?: string;
7108
- }
7109
- /**
7110
- * Request parameters for getOrder operation in OrdersApi.
7111
- * @export
7112
- * @interface OrdersApiGetOrderRequest
7113
- */
7114
- interface OrdersApiGetOrderRequest {
8144
+ readonly sellMinQuantity?: string;
7115
8145
  /**
7116
- * Order ID
8146
+ * Max quantity for the asset this order sells
7117
8147
  * @type {string}
7118
- * @memberof OrdersApiGetOrder
8148
+ * @memberof OrdersApiListOrders
7119
8149
  */
7120
- readonly id: string;
8150
+ readonly sellMaxQuantity?: string;
7121
8151
  /**
7122
- * Set flag to true to include fee body for the order
7123
- * @type {boolean}
7124
- * @memberof OrdersApiGetOrder
8152
+ * JSON-encoded metadata filters for the asset this order sells
8153
+ * @type {string}
8154
+ * @memberof OrdersApiListOrders
7125
8155
  */
7126
- readonly includeFees?: boolean;
8156
+ readonly sellMetadata?: string;
7127
8157
  /**
7128
8158
  * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
7129
8159
  * @type {string}
7130
- * @memberof OrdersApiGetOrder
8160
+ * @memberof OrdersApiListOrders
7131
8161
  */
7132
8162
  readonly auxiliaryFeePercentages?: string;
7133
8163
  /**
7134
8164
  * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
7135
8165
  * @type {string}
7136
- * @memberof OrdersApiGetOrder
8166
+ * @memberof OrdersApiListOrders
7137
8167
  */
7138
8168
  readonly auxiliaryFeeRecipients?: string;
7139
- }
7140
- /**
7141
- * Request parameters for getSignableCancelOrder operation in OrdersApi.
7142
- * @export
7143
- * @interface OrdersApiGetSignableCancelOrderRequest
7144
- */
7145
- interface OrdersApiGetSignableCancelOrderRequest {
7146
- /**
7147
- * get a signable cancel order
7148
- * @type {GetSignableCancelOrderRequest}
7149
- * @memberof OrdersApiGetSignableCancelOrder
7150
- */
7151
- readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
7152
- }
7153
- /**
7154
- * Request parameters for getSignableOrder operation in OrdersApi.
7155
- * @export
7156
- * @interface OrdersApiGetSignableOrderRequest
7157
- */
7158
- interface OrdersApiGetSignableOrderRequest {
7159
8169
  /**
7160
- * get a signable order
7161
- * @type {GetSignableOrderRequest}
7162
- * @memberof OrdersApiGetSignableOrder
8170
+ * Set flag to true to include fee object for orders
8171
+ * @type {boolean}
8172
+ * @memberof OrdersApiListOrders
7163
8173
  */
7164
- readonly getSignableOrderRequestV3: GetSignableOrderRequest;
8174
+ readonly includeFees?: boolean;
7165
8175
  }
7166
8176
  /**
7167
- * Request parameters for listOrders operation in OrdersApi.
8177
+ * Request parameters for listOrdersV3 operation in OrdersApi.
7168
8178
  * @export
7169
- * @interface OrdersApiListOrdersRequest
8179
+ * @interface OrdersApiListOrdersV3Request
7170
8180
  */
7171
- interface OrdersApiListOrdersRequest {
8181
+ interface OrdersApiListOrdersV3Request {
7172
8182
  /**
7173
8183
  * Page size of the result
7174
8184
  * @type {number}
7175
- * @memberof OrdersApiListOrders
8185
+ * @memberof OrdersApiListOrdersV3
7176
8186
  */
7177
8187
  readonly pageSize?: number;
7178
8188
  /**
7179
8189
  * Cursor
7180
8190
  * @type {string}
7181
- * @memberof OrdersApiListOrders
8191
+ * @memberof OrdersApiListOrdersV3
7182
8192
  */
7183
8193
  readonly cursor?: string;
7184
8194
  /**
7185
8195
  * Property to sort by
7186
8196
  * @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
7187
- * @memberof OrdersApiListOrders
8197
+ * @memberof OrdersApiListOrdersV3
7188
8198
  */
7189
8199
  readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
7190
8200
  /**
7191
8201
  * Direction to sort (asc/desc)
7192
8202
  * @type {string}
7193
- * @memberof OrdersApiListOrders
8203
+ * @memberof OrdersApiListOrdersV3
7194
8204
  */
7195
8205
  readonly direction?: string;
7196
8206
  /**
7197
8207
  * Ethereum address of the user who submitted this order
7198
8208
  * @type {string}
7199
- * @memberof OrdersApiListOrders
8209
+ * @memberof OrdersApiListOrdersV3
7200
8210
  */
7201
8211
  readonly user?: string;
7202
8212
  /**
7203
8213
  * Status of this order
7204
8214
  * @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
7205
- * @memberof OrdersApiListOrders
8215
+ * @memberof OrdersApiListOrdersV3
7206
8216
  */
7207
8217
  readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
7208
8218
  /**
7209
- * Minimum created at timestamp for this order, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
8219
+ * 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;
7210
8220
  * @type {string}
7211
- * @memberof OrdersApiListOrders
8221
+ * @memberof OrdersApiListOrdersV3
7212
8222
  */
7213
8223
  readonly minTimestamp?: string;
7214
8224
  /**
7215
- * Maximum created at timestamp for this order, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
8225
+ * 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;
7216
8226
  * @type {string}
7217
- * @memberof OrdersApiListOrders
8227
+ * @memberof OrdersApiListOrdersV3
7218
8228
  */
7219
8229
  readonly maxTimestamp?: string;
7220
8230
  /**
7221
- * Minimum updated at timestamp for this order, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
8231
+ * 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;
7222
8232
  * @type {string}
7223
- * @memberof OrdersApiListOrders
8233
+ * @memberof OrdersApiListOrdersV3
7224
8234
  */
7225
8235
  readonly updatedMinTimestamp?: string;
7226
8236
  /**
7227
- * Maximum updated at timestamp for this order, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
8237
+ * 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;
7228
8238
  * @type {string}
7229
- * @memberof OrdersApiListOrders
8239
+ * @memberof OrdersApiListOrdersV3
7230
8240
  */
7231
8241
  readonly updatedMaxTimestamp?: string;
7232
8242
  /**
7233
8243
  * Token type of the asset this order buys
7234
8244
  * @type {string}
7235
- * @memberof OrdersApiListOrders
8245
+ * @memberof OrdersApiListOrdersV3
7236
8246
  */
7237
8247
  readonly buyTokenType?: string;
7238
8248
  /**
7239
8249
  * ERC721 Token ID of the asset this order buys
7240
8250
  * @type {string}
7241
- * @memberof OrdersApiListOrders
8251
+ * @memberof OrdersApiListOrdersV3
7242
8252
  */
7243
8253
  readonly buyTokenId?: string;
7244
8254
  /**
7245
8255
  * Internal IMX ID of the asset this order buys
7246
8256
  * @type {string}
7247
- * @memberof OrdersApiListOrders
8257
+ * @memberof OrdersApiListOrdersV3
7248
8258
  */
7249
8259
  readonly buyAssetId?: string;
7250
8260
  /**
7251
8261
  * Token address of the asset this order buys
7252
8262
  * @type {string}
7253
- * @memberof OrdersApiListOrders
8263
+ * @memberof OrdersApiListOrdersV3
7254
8264
  */
7255
8265
  readonly buyTokenAddress?: string;
7256
8266
  /**
7257
8267
  * Token name of the asset this order buys
7258
8268
  * @type {string}
7259
- * @memberof OrdersApiListOrders
8269
+ * @memberof OrdersApiListOrdersV3
7260
8270
  */
7261
8271
  readonly buyTokenName?: string;
7262
8272
  /**
7263
8273
  * Min quantity for the asset this order buys
7264
8274
  * @type {string}
7265
- * @memberof OrdersApiListOrders
8275
+ * @memberof OrdersApiListOrdersV3
7266
8276
  */
7267
8277
  readonly buyMinQuantity?: string;
7268
8278
  /**
7269
8279
  * Max quantity for the asset this order buys
7270
8280
  * @type {string}
7271
- * @memberof OrdersApiListOrders
8281
+ * @memberof OrdersApiListOrdersV3
7272
8282
  */
7273
8283
  readonly buyMaxQuantity?: string;
7274
8284
  /**
7275
8285
  * JSON-encoded metadata filters for the asset this order buys
7276
8286
  * @type {string}
7277
- * @memberof OrdersApiListOrders
8287
+ * @memberof OrdersApiListOrdersV3
7278
8288
  */
7279
8289
  readonly buyMetadata?: string;
7280
8290
  /**
7281
8291
  * Token type of the asset this order sells
7282
8292
  * @type {string}
7283
- * @memberof OrdersApiListOrders
8293
+ * @memberof OrdersApiListOrdersV3
7284
8294
  */
7285
8295
  readonly sellTokenType?: string;
7286
8296
  /**
7287
8297
  * ERC721 Token ID of the asset this order sells
7288
8298
  * @type {string}
7289
- * @memberof OrdersApiListOrders
8299
+ * @memberof OrdersApiListOrdersV3
7290
8300
  */
7291
8301
  readonly sellTokenId?: string;
7292
8302
  /**
7293
8303
  * Internal IMX ID of the asset this order sells
7294
8304
  * @type {string}
7295
- * @memberof OrdersApiListOrders
8305
+ * @memberof OrdersApiListOrdersV3
7296
8306
  */
7297
8307
  readonly sellAssetId?: string;
7298
8308
  /**
7299
8309
  * Token address of the asset this order sells
7300
8310
  * @type {string}
7301
- * @memberof OrdersApiListOrders
8311
+ * @memberof OrdersApiListOrdersV3
7302
8312
  */
7303
8313
  readonly sellTokenAddress?: string;
7304
8314
  /**
7305
8315
  * Token name of the asset this order sells
7306
8316
  * @type {string}
7307
- * @memberof OrdersApiListOrders
8317
+ * @memberof OrdersApiListOrdersV3
7308
8318
  */
7309
8319
  readonly sellTokenName?: string;
7310
8320
  /**
7311
8321
  * Min quantity for the asset this order sells
7312
8322
  * @type {string}
7313
- * @memberof OrdersApiListOrders
8323
+ * @memberof OrdersApiListOrdersV3
7314
8324
  */
7315
8325
  readonly sellMinQuantity?: string;
7316
8326
  /**
7317
8327
  * Max quantity for the asset this order sells
7318
8328
  * @type {string}
7319
- * @memberof OrdersApiListOrders
8329
+ * @memberof OrdersApiListOrdersV3
7320
8330
  */
7321
8331
  readonly sellMaxQuantity?: string;
7322
8332
  /**
7323
8333
  * JSON-encoded metadata filters for the asset this order sells
7324
8334
  * @type {string}
7325
- * @memberof OrdersApiListOrders
8335
+ * @memberof OrdersApiListOrdersV3
7326
8336
  */
7327
8337
  readonly sellMetadata?: string;
7328
8338
  /**
7329
8339
  * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
7330
8340
  * @type {string}
7331
- * @memberof OrdersApiListOrders
8341
+ * @memberof OrdersApiListOrdersV3
7332
8342
  */
7333
8343
  readonly auxiliaryFeePercentages?: string;
7334
8344
  /**
7335
8345
  * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
7336
8346
  * @type {string}
7337
- * @memberof OrdersApiListOrders
8347
+ * @memberof OrdersApiListOrdersV3
7338
8348
  */
7339
8349
  readonly auxiliaryFeeRecipients?: string;
7340
8350
  /**
7341
8351
  * Set flag to true to include fee object for orders
7342
8352
  * @type {boolean}
7343
- * @memberof OrdersApiListOrders
8353
+ * @memberof OrdersApiListOrdersV3
7344
8354
  */
7345
8355
  readonly includeFees?: boolean;
7346
8356
  }
@@ -7352,7 +8362,7 @@ interface OrdersApiListOrdersRequest {
7352
8362
  */
7353
8363
  declare class OrdersApi extends BaseAPI {
7354
8364
  /**
7355
- * Cancel an order
8365
+ * Cancel an order. Use https://docs.x.immutable.com/reference#/operations/getSignableCancelOrder to get request body params.
7356
8366
  * @summary Cancel an order
7357
8367
  * @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
7358
8368
  * @param {*} [options] Override http request option.
@@ -7361,7 +8371,16 @@ declare class OrdersApi extends BaseAPI {
7361
8371
  */
7362
8372
  cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
7363
8373
  /**
7364
- * Create an order
8374
+ * Cancel an order (V3)
8375
+ * @summary Cancel an order (V3)
8376
+ * @param {OrdersApiCancelOrderV3Request} requestParameters Request parameters.
8377
+ * @param {*} [options] Override http request option.
8378
+ * @throws {RequiredError}
8379
+ * @memberof OrdersApi
8380
+ */
8381
+ cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
8382
+ /**
8383
+ * Create an order. Use https://docs.x.immutable.com/reference#/operations/getSignableOrder to get request body params.
7365
8384
  * @summary Create an order
7366
8385
  * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
7367
8386
  * @param {*} [options] Override http request option.
@@ -7370,14 +8389,32 @@ declare class OrdersApi extends BaseAPI {
7370
8389
  */
7371
8390
  createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
7372
8391
  /**
7373
- * Get details of an order with the given ID
7374
- * @summary Get details of an order with the given ID
8392
+ * Create an order using the v3 orderbook. Currently only buy NFT orders are supported.
8393
+ * @summary Create an order (V3)
8394
+ * @param {OrdersApiCreateOrderV3Request} requestParameters Request parameters.
8395
+ * @param {*} [options] Override http request option.
8396
+ * @throws {RequiredError}
8397
+ * @memberof OrdersApi
8398
+ */
8399
+ createOrderV3(requestParameters: OrdersApiCreateOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
8400
+ /**
8401
+ * Get an order
8402
+ * @summary Get an order
7375
8403
  * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
7376
8404
  * @param {*} [options] Override http request option.
7377
8405
  * @throws {RequiredError}
7378
8406
  * @memberof OrdersApi
7379
8407
  */
7380
8408
  getOrder(requestParameters: OrdersApiGetOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Order, any>>;
8409
+ /**
8410
+ * Get an order (V3)
8411
+ * @summary Get an order (V3)
8412
+ * @param {OrdersApiGetOrderV3Request} requestParameters Request parameters.
8413
+ * @param {*} [options] Override http request option.
8414
+ * @throws {RequiredError}
8415
+ * @memberof OrdersApi
8416
+ */
8417
+ getOrderV3(requestParameters: OrdersApiGetOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<OrderV3, any>>;
7381
8418
  /**
7382
8419
  * Get a signable cancel order message
7383
8420
  * @summary Get a signable cancel order message
@@ -7387,6 +8424,15 @@ declare class OrdersApi extends BaseAPI {
7387
8424
  * @memberof OrdersApi
7388
8425
  */
7389
8426
  getSignableCancelOrder(requestParameters: OrdersApiGetSignableCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
8427
+ /**
8428
+ * Get a signable cancel order message (V3)
8429
+ * @summary Get a signable cancel order message (V3)
8430
+ * @param {OrdersApiGetSignableCancelOrderV3Request} requestParameters Request parameters.
8431
+ * @param {*} [options] Override http request option.
8432
+ * @throws {RequiredError}
8433
+ * @memberof OrdersApi
8434
+ */
8435
+ getSignableCancelOrderV3(requestParameters: OrdersApiGetSignableCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
7390
8436
  /**
7391
8437
  * Get a signable order request (V3)
7392
8438
  * @summary Get a signable order request (V3)
@@ -7405,6 +8451,15 @@ declare class OrdersApi extends BaseAPI {
7405
8451
  * @memberof OrdersApi
7406
8452
  */
7407
8453
  listOrders(requestParameters?: OrdersApiListOrdersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponse, any>>;
8454
+ /**
8455
+ * Get a list of orders (V3)
8456
+ * @summary Get a list of orders (V3)
8457
+ * @param {OrdersApiListOrdersV3Request} requestParameters Request parameters.
8458
+ * @param {*} [options] Override http request option.
8459
+ * @throws {RequiredError}
8460
+ * @memberof OrdersApi
8461
+ */
8462
+ listOrdersV3(requestParameters?: OrdersApiListOrdersV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponseV3, any>>;
7408
8463
  }
7409
8464
  /**
7410
8465
  * Request parameters for createProject operation in ProjectsApi.
@@ -7647,6 +8702,37 @@ interface TradesApiCreateTradeRequest {
7647
8702
  */
7648
8703
  readonly authorization?: string;
7649
8704
  }
8705
+ /**
8706
+ * Request parameters for createTradeV3 operation in TradesApi.
8707
+ * @export
8708
+ * @interface TradesApiCreateTradeV3Request
8709
+ */
8710
+ interface TradesApiCreateTradeV3Request {
8711
+ /**
8712
+ * create a trade
8713
+ * @type {TradesCreateTradeRequest}
8714
+ * @memberof TradesApiCreateTradeV3
8715
+ */
8716
+ readonly createTradeRequest: TradesCreateTradeRequest;
8717
+ /**
8718
+ * eth address
8719
+ * @type {string}
8720
+ * @memberof TradesApiCreateTradeV3
8721
+ */
8722
+ readonly xImxEthAddress?: string;
8723
+ /**
8724
+ * eth signature
8725
+ * @type {string}
8726
+ * @memberof TradesApiCreateTradeV3
8727
+ */
8728
+ readonly xImxEthSignature?: string;
8729
+ /**
8730
+ * Authorization header
8731
+ * @type {string}
8732
+ * @memberof TradesApiCreateTradeV3
8733
+ */
8734
+ readonly authorization?: string;
8735
+ }
7650
8736
  /**
7651
8737
  * Request parameters for getSignableTrade operation in TradesApi.
7652
8738
  * @export
@@ -7723,10 +8809,10 @@ interface TradesApiListTradesRequest {
7723
8809
  readonly cursor?: string;
7724
8810
  /**
7725
8811
  * Property to sort by
7726
- * @type {string}
8812
+ * @type {'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
7727
8813
  * @memberof TradesApiListTrades
7728
8814
  */
7729
- readonly orderBy?: string;
8815
+ readonly orderBy?: 'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
7730
8816
  /**
7731
8817
  * Direction to sort (asc/desc)
7732
8818
  * @type {string}
@@ -7746,6 +8832,79 @@ interface TradesApiListTradesRequest {
7746
8832
  */
7747
8833
  readonly maxTimestamp?: string;
7748
8834
  }
8835
+ /**
8836
+ * Request parameters for listTradesV3 operation in TradesApi.
8837
+ * @export
8838
+ * @interface TradesApiListTradesV3Request
8839
+ */
8840
+ interface TradesApiListTradesV3Request {
8841
+ /**
8842
+ * Party A\&#39;s (buy order) token type of currency used to buy
8843
+ * @type {string}
8844
+ * @memberof TradesApiListTradesV3
8845
+ */
8846
+ readonly partyATokenType?: string;
8847
+ /**
8848
+ * Party A\&#39;s (buy order) token address of currency used to buy
8849
+ * @type {string}
8850
+ * @memberof TradesApiListTradesV3
8851
+ */
8852
+ readonly partyATokenAddress?: string;
8853
+ /**
8854
+ * Party B\&#39;s (sell order) token type of NFT sold - always ERC721
8855
+ * @type {string}
8856
+ * @memberof TradesApiListTradesV3
8857
+ */
8858
+ readonly partyBTokenType?: string;
8859
+ /**
8860
+ * Party B\&#39;s (sell order) collection address of NFT sold
8861
+ * @type {string}
8862
+ * @memberof TradesApiListTradesV3
8863
+ */
8864
+ readonly partyBTokenAddress?: string;
8865
+ /**
8866
+ * Party B\&#39;s (sell order) token id of NFT sold
8867
+ * @type {string}
8868
+ * @memberof TradesApiListTradesV3
8869
+ */
8870
+ readonly partyBTokenId?: string;
8871
+ /**
8872
+ * Page size of the result
8873
+ * @type {number}
8874
+ * @memberof TradesApiListTradesV3
8875
+ */
8876
+ readonly pageSize?: number;
8877
+ /**
8878
+ * Cursor
8879
+ * @type {string}
8880
+ * @memberof TradesApiListTradesV3
8881
+ */
8882
+ readonly cursor?: string;
8883
+ /**
8884
+ * Property to sort by
8885
+ * @type {'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp'}
8886
+ * @memberof TradesApiListTradesV3
8887
+ */
8888
+ readonly orderBy?: 'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp';
8889
+ /**
8890
+ * Direction to sort (asc/desc)
8891
+ * @type {string}
8892
+ * @memberof TradesApiListTradesV3
8893
+ */
8894
+ readonly direction?: string;
8895
+ /**
8896
+ * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
8897
+ * @type {string}
8898
+ * @memberof TradesApiListTradesV3
8899
+ */
8900
+ readonly minTimestamp?: string;
8901
+ /**
8902
+ * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
8903
+ * @type {string}
8904
+ * @memberof TradesApiListTradesV3
8905
+ */
8906
+ readonly maxTimestamp?: string;
8907
+ }
7749
8908
  /**
7750
8909
  * TradesApi - object-oriented interface
7751
8910
  * @export
@@ -7754,7 +8913,7 @@ interface TradesApiListTradesRequest {
7754
8913
  */
7755
8914
  declare class TradesApi extends BaseAPI {
7756
8915
  /**
7757
- * Create a Trade
8916
+ * Create a trade. Use https://docs.x.immutable.com/reference#/operations/getSignableTrade to get request body params.
7758
8917
  * @summary Create a Trade between two parties
7759
8918
  * @param {TradesApiCreateTradeRequest} requestParameters Request parameters.
7760
8919
  * @param {*} [options] Override http request option.
@@ -7762,6 +8921,15 @@ declare class TradesApi extends BaseAPI {
7762
8921
  * @memberof TradesApi
7763
8922
  */
7764
8923
  createTrade(requestParameters: TradesApiCreateTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
8924
+ /**
8925
+ * Create a Trade. Currently only buy order is supported.
8926
+ * @summary Create a Trade (V3)
8927
+ * @param {TradesApiCreateTradeV3Request} requestParameters Request parameters.
8928
+ * @param {*} [options] Override http request option.
8929
+ * @throws {RequiredError}
8930
+ * @memberof TradesApi
8931
+ */
8932
+ createTradeV3(requestParameters: TradesApiCreateTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
7765
8933
  /**
7766
8934
  * Get a signable trade V3 message
7767
8935
  * @summary Get a signable trade V3 message
@@ -7789,6 +8957,15 @@ declare class TradesApi extends BaseAPI {
7789
8957
  * @memberof TradesApi
7790
8958
  */
7791
8959
  listTrades(requestParameters?: TradesApiListTradesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTradesResponse, any>>;
8960
+ /**
8961
+ * Get a list of trades (V3)
8962
+ * @summary Get a list of trades (V3)
8963
+ * @param {TradesApiListTradesV3Request} requestParameters Request parameters.
8964
+ * @param {*} [options] Override http request option.
8965
+ * @throws {RequiredError}
8966
+ * @memberof TradesApi
8967
+ */
8968
+ listTradesV3(requestParameters?: TradesApiListTradesV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTradesResponse, any>>;
7792
8969
  }
7793
8970
  /**
7794
8971
  * Request parameters for createTransfer operation in TransfersApi.
@@ -8008,7 +9185,7 @@ interface TransfersApiListTransfersRequest {
8008
9185
  */
8009
9186
  declare class TransfersApi extends BaseAPI {
8010
9187
  /**
8011
- * Create a new transfer request
9188
+ * Create a new transfer request.
8012
9189
  * @summary Creates a transfer of multiple tokens between two parties
8013
9190
  * @param {TransfersApiCreateTransferRequest} requestParameters Request parameters.
8014
9191
  * @param {*} [options] Override http request option.
@@ -8017,7 +9194,7 @@ declare class TransfersApi extends BaseAPI {
8017
9194
  */
8018
9195
  createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
8019
9196
  /**
8020
- * Create a new transfer request
9197
+ * Create a new transfer request.
8021
9198
  * @summary Creates a transfer of tokens between two parties
8022
9199
  * @param {TransfersApiCreateTransferV1Request} requestParameters Request parameters.
8023
9200
  * @param {*} [options] Override http request option.
@@ -8360,7 +9537,7 @@ interface WithdrawalsApiListWithdrawalsRequest {
8360
9537
  */
8361
9538
  declare class WithdrawalsApi extends BaseAPI {
8362
9539
  /**
8363
- * Creates a withdrawal
9540
+ * Creates a withdrawal.
8364
9541
  * @summary Creates a withdrawal of a token
8365
9542
  * @param {WithdrawalsApiCreateWithdrawalRequest} requestParameters Request parameters.
8366
9543
  * @param {*} [options] Override http request option.
@@ -8412,7 +9589,7 @@ interface ImmutableXConfiguration {
8412
9589
  /**
8413
9590
  * The configuration for the API client
8414
9591
  */
8415
- apiConfiguration: Configuration$1;
9592
+ apiConfiguration: Configuration;
8416
9593
  /**
8417
9594
  * The configuration for the Ethereum network
8418
9595
  */
@@ -8420,20 +9597,34 @@ interface ImmutableXConfiguration {
8420
9597
  }
8421
9598
 
8422
9599
  declare enum Environment {
8423
- DEVELOPMENT = "development",
8424
- SANDBOX = "sandbox",
8425
- PRODUCTION = "production"
9600
+ PRODUCTION = "production",
9601
+ SANDBOX = "sandbox"
8426
9602
  }
8427
- type StarkExConfig = ImmutableXConfiguration & {
8428
- env: Environment;
8429
- };
8430
- declare class Configuration {
8431
- private readonly starkExConfig;
8432
- constructor(config: StarkExConfig);
8433
- getStarkExConfig(): StarkExConfig;
9603
+ declare class ImmutableConfiguration {
9604
+ readonly environment: Environment;
9605
+ readonly apiKey?: string;
9606
+ constructor(options: {
9607
+ environment: Environment;
9608
+ apiKey?: string;
9609
+ });
9610
+ }
9611
+ interface ModuleConfiguration<T> {
9612
+ baseConfig: ImmutableConfiguration;
9613
+ overrides?: T;
9614
+ }
9615
+
9616
+ interface StarkExOverrides {
9617
+ immutableXConfig: ImmutableXConfiguration;
9618
+ }
9619
+ interface StarkExModuleConfiguration extends ModuleConfiguration<StarkExOverrides> {
9620
+ }
9621
+ declare class StarkExConfiguration {
9622
+ readonly immutableXConfig: ImmutableXConfiguration;
9623
+ readonly baseConfig: ImmutableConfiguration;
9624
+ constructor({ baseConfig, overrides }: StarkExModuleConfiguration);
8434
9625
  }
8435
9626
 
8436
- declare const StarkExAPIFactory: (config: Configuration) => {
9627
+ declare const StarkExAPIFactory: (config: StarkExConfiguration) => {
8437
9628
  depositsApi: DepositsApi;
8438
9629
  mintsApi: MintsApi;
8439
9630
  ordersApi: OrdersApi;
@@ -8452,4 +9643,4 @@ declare const StarkExAPIFactory: (config: Configuration) => {
8452
9643
  projectsApi: ProjectsApi;
8453
9644
  };
8454
9645
 
8455
- export { StarkExAPIFactory };
9646
+ export { StarkExAPIFactory, StarkExConfiguration, StarkExOverrides };