@imtbl/sdk 0.0.1-alpha.2 → 0.1.0-alpha

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.
@@ -1,3 +1,244 @@
1
+ declare type Bytes = ArrayLike<number>;
2
+ declare type BytesLike = Bytes | string;
3
+ interface Hexable {
4
+ toHexString(): string;
5
+ }
6
+
7
+ declare type BigNumberish = BigNumber | Bytes | bigint | string | number;
8
+ declare class BigNumber implements Hexable {
9
+ readonly _hex: string;
10
+ readonly _isBigNumber: boolean;
11
+ constructor(constructorGuard: any, hex: string);
12
+ fromTwos(value: number): BigNumber;
13
+ toTwos(value: number): BigNumber;
14
+ abs(): BigNumber;
15
+ add(other: BigNumberish): BigNumber;
16
+ sub(other: BigNumberish): BigNumber;
17
+ div(other: BigNumberish): BigNumber;
18
+ mul(other: BigNumberish): BigNumber;
19
+ mod(other: BigNumberish): BigNumber;
20
+ pow(other: BigNumberish): BigNumber;
21
+ and(other: BigNumberish): BigNumber;
22
+ or(other: BigNumberish): BigNumber;
23
+ xor(other: BigNumberish): BigNumber;
24
+ mask(value: number): BigNumber;
25
+ shl(value: number): BigNumber;
26
+ shr(value: number): BigNumber;
27
+ eq(other: BigNumberish): boolean;
28
+ lt(other: BigNumberish): boolean;
29
+ lte(other: BigNumberish): boolean;
30
+ gt(other: BigNumberish): boolean;
31
+ gte(other: BigNumberish): boolean;
32
+ isNegative(): boolean;
33
+ isZero(): boolean;
34
+ toNumber(): number;
35
+ toBigInt(): bigint;
36
+ toString(): string;
37
+ toHexString(): string;
38
+ toJSON(key?: string): any;
39
+ static from(value: any): BigNumber;
40
+ static isBigNumber(value: any): value is BigNumber;
41
+ }
42
+
43
+ declare type Deferrable<T> = {
44
+ [K in keyof T]: T[K] | Promise<T[K]>;
45
+ };
46
+ declare class Description<T = any> {
47
+ constructor(info: {
48
+ [K in keyof T]: T[K];
49
+ });
50
+ }
51
+
52
+ declare type Network = {
53
+ name: string;
54
+ chainId: number;
55
+ ensAddress?: string;
56
+ _defaultProvider?: (providers: any, options?: any) => any;
57
+ };
58
+
59
+ declare type AccessList = Array<{
60
+ address: string;
61
+ storageKeys: Array<string>;
62
+ }>;
63
+ declare type AccessListish = AccessList | Array<[string, Array<string>]> | Record<string, Array<string>>;
64
+ interface Transaction {
65
+ hash?: string;
66
+ to?: string;
67
+ from?: string;
68
+ nonce: number;
69
+ gasLimit: BigNumber;
70
+ gasPrice?: BigNumber;
71
+ data: string;
72
+ value: BigNumber;
73
+ chainId: number;
74
+ r?: string;
75
+ s?: string;
76
+ v?: number;
77
+ type?: number | null;
78
+ accessList?: AccessList;
79
+ maxPriorityFeePerGas?: BigNumber;
80
+ maxFeePerGas?: BigNumber;
81
+ }
82
+
83
+ interface OnceBlockable {
84
+ once(eventName: "block", handler: () => void): void;
85
+ }
86
+
87
+ declare type TransactionRequest = {
88
+ to?: string;
89
+ from?: string;
90
+ nonce?: BigNumberish;
91
+ gasLimit?: BigNumberish;
92
+ gasPrice?: BigNumberish;
93
+ data?: BytesLike;
94
+ value?: BigNumberish;
95
+ chainId?: number;
96
+ type?: number;
97
+ accessList?: AccessListish;
98
+ maxPriorityFeePerGas?: BigNumberish;
99
+ maxFeePerGas?: BigNumberish;
100
+ customData?: Record<string, any>;
101
+ ccipReadEnabled?: boolean;
102
+ };
103
+ interface TransactionResponse extends Transaction {
104
+ hash: string;
105
+ blockNumber?: number;
106
+ blockHash?: string;
107
+ timestamp?: number;
108
+ confirmations: number;
109
+ from: string;
110
+ raw?: string;
111
+ wait: (confirmations?: number) => Promise<TransactionReceipt>;
112
+ }
113
+ declare type BlockTag = string | number;
114
+ interface _Block {
115
+ hash: string;
116
+ parentHash: string;
117
+ number: number;
118
+ timestamp: number;
119
+ nonce: string;
120
+ difficulty: number;
121
+ _difficulty: BigNumber;
122
+ gasLimit: BigNumber;
123
+ gasUsed: BigNumber;
124
+ miner: string;
125
+ extraData: string;
126
+ baseFeePerGas?: null | BigNumber;
127
+ }
128
+ interface Block extends _Block {
129
+ transactions: Array<string>;
130
+ }
131
+ interface BlockWithTransactions extends _Block {
132
+ transactions: Array<TransactionResponse>;
133
+ }
134
+ interface Log {
135
+ blockNumber: number;
136
+ blockHash: string;
137
+ transactionIndex: number;
138
+ removed: boolean;
139
+ address: string;
140
+ data: string;
141
+ topics: Array<string>;
142
+ transactionHash: string;
143
+ logIndex: number;
144
+ }
145
+ interface TransactionReceipt {
146
+ to: string;
147
+ from: string;
148
+ contractAddress: string;
149
+ transactionIndex: number;
150
+ root?: string;
151
+ gasUsed: BigNumber;
152
+ logsBloom: string;
153
+ blockHash: string;
154
+ transactionHash: string;
155
+ logs: Array<Log>;
156
+ blockNumber: number;
157
+ confirmations: number;
158
+ cumulativeGasUsed: BigNumber;
159
+ effectiveGasPrice: BigNumber;
160
+ byzantium: boolean;
161
+ type: number;
162
+ status?: number;
163
+ }
164
+ interface FeeData$1 {
165
+ lastBaseFeePerGas: null | BigNumber;
166
+ maxFeePerGas: null | BigNumber;
167
+ maxPriorityFeePerGas: null | BigNumber;
168
+ gasPrice: null | BigNumber;
169
+ }
170
+ interface EventFilter {
171
+ address?: string;
172
+ topics?: Array<string | Array<string> | null>;
173
+ }
174
+ interface Filter extends EventFilter {
175
+ fromBlock?: BlockTag;
176
+ toBlock?: BlockTag;
177
+ }
178
+ declare abstract class ForkEvent extends Description {
179
+ readonly expiry: number;
180
+ readonly _isForkEvent?: boolean;
181
+ static isForkEvent(value: any): value is ForkEvent;
182
+ }
183
+ declare type EventType = string | Array<string | Array<string>> | EventFilter | ForkEvent;
184
+ declare type Listener = (...args: Array<any>) => void;
185
+ declare abstract class Provider implements OnceBlockable {
186
+ abstract getNetwork(): Promise<Network>;
187
+ abstract getBlockNumber(): Promise<number>;
188
+ abstract getGasPrice(): Promise<BigNumber>;
189
+ getFeeData(): Promise<FeeData$1>;
190
+ abstract getBalance(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<BigNumber>;
191
+ abstract getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
192
+ abstract getCode(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>;
193
+ abstract getStorageAt(addressOrName: string | Promise<string>, position: BigNumberish | Promise<BigNumberish>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>;
194
+ abstract sendTransaction(signedTransaction: string | Promise<string>): Promise<TransactionResponse>;
195
+ abstract call(transaction: Deferrable<TransactionRequest>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>;
196
+ abstract estimateGas(transaction: Deferrable<TransactionRequest>): Promise<BigNumber>;
197
+ abstract getBlock(blockHashOrBlockTag: BlockTag | string | Promise<BlockTag | string>): Promise<Block>;
198
+ abstract getBlockWithTransactions(blockHashOrBlockTag: BlockTag | string | Promise<BlockTag | string>): Promise<BlockWithTransactions>;
199
+ abstract getTransaction(transactionHash: string): Promise<TransactionResponse>;
200
+ abstract getTransactionReceipt(transactionHash: string): Promise<TransactionReceipt>;
201
+ abstract getLogs(filter: Filter): Promise<Array<Log>>;
202
+ abstract resolveName(name: string | Promise<string>): Promise<null | string>;
203
+ abstract lookupAddress(address: string | Promise<string>): Promise<null | string>;
204
+ abstract on(eventName: EventType, listener: Listener): Provider;
205
+ abstract once(eventName: EventType, listener: Listener): Provider;
206
+ abstract emit(eventName: EventType, ...args: Array<any>): boolean;
207
+ abstract listenerCount(eventName?: EventType): number;
208
+ abstract listeners(eventName?: EventType): Array<Listener>;
209
+ abstract off(eventName: EventType, listener?: Listener): Provider;
210
+ abstract removeAllListeners(eventName?: EventType): Provider;
211
+ addListener(eventName: EventType, listener: Listener): Provider;
212
+ removeListener(eventName: EventType, listener: Listener): Provider;
213
+ abstract waitForTransaction(transactionHash: string, confirmations?: number, timeout?: number): Promise<TransactionReceipt>;
214
+ readonly _isProvider: boolean;
215
+ constructor();
216
+ static isProvider(value: any): value is Provider;
217
+ }
218
+
219
+ declare abstract class Signer {
220
+ readonly provider?: Provider;
221
+ abstract getAddress(): Promise<string>;
222
+ abstract signMessage(message: Bytes | string): Promise<string>;
223
+ abstract signTransaction(transaction: Deferrable<TransactionRequest>): Promise<string>;
224
+ abstract connect(provider: Provider): Signer;
225
+ readonly _isSigner: boolean;
226
+ constructor();
227
+ getBalance(blockTag?: BlockTag): Promise<BigNumber>;
228
+ getTransactionCount(blockTag?: BlockTag): Promise<number>;
229
+ estimateGas(transaction: Deferrable<TransactionRequest>): Promise<BigNumber>;
230
+ call(transaction: Deferrable<TransactionRequest>, blockTag?: BlockTag): Promise<string>;
231
+ sendTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionResponse>;
232
+ getChainId(): Promise<number>;
233
+ getGasPrice(): Promise<BigNumber>;
234
+ getFeeData(): Promise<FeeData$1>;
235
+ resolveName(name: string): Promise<string>;
236
+ checkTransaction(transaction: Deferrable<TransactionRequest>): Deferrable<TransactionRequest>;
237
+ populateTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionRequest>;
238
+ _checkProvider(operation?: string): void;
239
+ static isSigner(value: any): value is Signer;
240
+ }
241
+
1
242
  // TypeScript Version: 3.0
2
243
 
3
244
  type AxiosRequestHeaders = Record<string, string | number | boolean>;
@@ -177,6 +418,79 @@ interface AxiosInstance extends Axios {
177
418
  (url: string, config?: AxiosRequestConfig): AxiosPromise;
178
419
  }
179
420
 
421
+ /**
422
+ * Generates a deterministic Stark private key from the provided signer.
423
+ * @returns the private key as a hex string
424
+ */
425
+ declare function generateLegacyStarkPrivateKey(signer: Signer): Promise<string>;
426
+
427
+ /**
428
+ * An abstraction of a Stark account, which can be used to sign messages and transactions on StarkEx to execute state changing operations
429
+ */
430
+ interface StarkSigner {
431
+ /**
432
+ * Signs the prefixed-message
433
+ * @params message - this must be a UTF8-message
434
+ * @example "0x1234"
435
+ * @returns the signed prefixed-message
436
+ */
437
+ signMessage(message: string): Promise<string>;
438
+ /**
439
+ * Get the Signer address
440
+ * @returns the Signer's checksum address
441
+ */
442
+ getAddress(): string | Promise<string>;
443
+ }
444
+ /**
445
+ * A pair of Signers
446
+ */
447
+ interface WalletConnection {
448
+ /**
449
+ * The L1 signer
450
+ */
451
+ ethSigner: Signer;
452
+ /**
453
+ * The L2 signer
454
+ */
455
+ starkSigner: StarkSigner;
456
+ }
457
+
458
+ /**
459
+ * An ERC20 token
460
+ */
461
+ interface ERC20Token {
462
+ type: 'ERC20';
463
+ tokenAddress: string;
464
+ }
465
+ /**
466
+ * An ETH token
467
+ */
468
+ interface ETHToken {
469
+ type: 'ETH';
470
+ }
471
+ /**
472
+ * An amount of ETH token of unit Wei
473
+ */
474
+ interface ETHAmount extends ETHToken {
475
+ /**
476
+ * An amount in unit Wei
477
+ */
478
+ amount: string;
479
+ }
480
+ /**
481
+ * The token details and amount of ERC20 token units
482
+ */
483
+ interface ERC20Amount extends ERC20Token {
484
+ /**
485
+ * An amount in units for the given ERC20 token
486
+ */
487
+ amount: string;
488
+ }
489
+ /**
490
+ * Union type that represents exchange token type amounts
491
+ */
492
+ declare type ExchangeTokenAmount = ETHAmount | ERC20Amount;
493
+
180
494
  /**
181
495
  * Immutable X API
182
496
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -197,7 +511,7 @@ interface ConfigurationParameters {
197
511
  baseOptions?: any;
198
512
  formDataCtor?: new () => any;
199
513
  }
200
- declare class Configuration$1 {
514
+ declare class Configuration {
201
515
  /**
202
516
  * parameter for apiKey security
203
517
  * @param name security name
@@ -268,8 +582,8 @@ declare class Configuration$1 {
268
582
  declare class BaseAPI {
269
583
  protected basePath: string;
270
584
  protected axios: AxiosInstance;
271
- protected configuration: Configuration$1 | undefined;
272
- constructor(configuration?: Configuration$1, basePath?: string, axios?: AxiosInstance);
585
+ protected configuration: Configuration | undefined;
586
+ constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
273
587
  }
274
588
 
275
589
  /**
@@ -380,49 +694,6 @@ interface AggregateLimit {
380
694
  'min_amount'?: number;
381
695
  }
382
696
 
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
697
  /**
427
698
  * Immutable X API
428
699
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -465,30 +736,31 @@ interface CollectionDetails {
465
736
  * https://openapi-generator.tech
466
737
  * Do not edit the class manually.
467
738
  */
739
+
468
740
  /**
469
741
  *
470
742
  * @export
471
- * @interface Fee
743
+ * @interface AssetProperties
472
744
  */
473
- interface Fee {
745
+ interface AssetProperties {
474
746
  /**
475
- * Wallet address
476
- * @type {string}
477
- * @memberof Fee
747
+ *
748
+ * @type {CollectionDetails}
749
+ * @memberof AssetProperties
478
750
  */
479
- 'address': string;
751
+ 'collection'?: CollectionDetails;
480
752
  /**
481
- * The percentage of fee
482
- * @type {number}
483
- * @memberof Fee
753
+ * Image URL of this asset
754
+ * @type {string}
755
+ * @memberof AssetProperties
484
756
  */
485
- 'percentage': number;
757
+ 'image_url'?: string;
486
758
  /**
487
- * Type of fee. Examples: `royalty`, `maker`, `taker` or `protocol`
759
+ * Name of this asset
488
760
  * @type {string}
489
- * @memberof Fee
761
+ * @memberof AssetProperties
490
762
  */
491
- 'type': string;
763
+ 'name'?: string;
492
764
  }
493
765
 
494
766
  /**
@@ -502,25 +774,13 @@ interface Fee {
502
774
  * https://openapi-generator.tech
503
775
  * Do not edit the class manually.
504
776
  */
777
+
505
778
  /**
506
- *
779
+ * @type TokenDataProperties
780
+ * Properties of this asset
507
781
  * @export
508
- * @interface OrderDetails
509
782
  */
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
- }
783
+ declare type TokenDataProperties = AssetProperties;
524
784
 
525
785
  /**
526
786
  * Immutable X API
@@ -537,99 +797,57 @@ interface OrderDetails {
537
797
  /**
538
798
  *
539
799
  * @export
540
- * @interface Asset
800
+ * @interface TokenData
541
801
  */
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;
802
+ interface TokenData {
561
803
  /**
562
- * Royalties to pay on this asset operations
563
- * @type {Array<Fee>}
564
- * @memberof Asset
804
+ * Number of decimals supported by this asset
805
+ * @type {number}
806
+ * @memberof TokenData
565
807
  */
566
- 'fees'?: Array<Fee>;
808
+ 'decimals'?: number;
567
809
  /**
568
810
  * [DEPRECATED] Internal Immutable X Token ID
569
811
  * @type {string}
570
- * @memberof Asset
812
+ * @memberof TokenData
571
813
  */
572
814
  '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
815
  /**
592
816
  *
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
817
+ * @type {TokenDataProperties}
818
+ * @memberof TokenData
601
819
  */
602
- 'status': string;
820
+ 'properties'?: TokenDataProperties;
603
821
  /**
604
- * Address of the ERC721 contract
822
+ * Quantity of this asset - inclusive of fees for buy order in v1 API and exclusive of fees in v3 API
605
823
  * @type {string}
606
- * @memberof Asset
824
+ * @memberof TokenData
607
825
  */
608
- 'token_address': string;
826
+ 'quantity': string;
609
827
  /**
610
- * ERC721 Token ID of this asset
828
+ * Quantity of this asset with the sum of all fees applied to the asset
611
829
  * @type {string}
612
- * @memberof Asset
830
+ * @memberof TokenData
613
831
  */
614
- 'token_id': string;
832
+ 'quantity_with_fees': string;
615
833
  /**
616
- * Timestamp of when the asset was updated
834
+ * Symbol of a token
617
835
  * @type {string}
618
- * @memberof Asset
836
+ * @memberof TokenData
619
837
  */
620
- 'updated_at': string | null;
838
+ 'symbol'?: string;
621
839
  /**
622
- * URI to access this asset externally to Immutable X
840
+ * Address of ERC721/ERC20 contract
623
841
  * @type {string}
624
- * @memberof Asset
842
+ * @memberof TokenData
625
843
  */
626
- 'uri': string | null;
844
+ 'token_address'?: string;
627
845
  /**
628
- * Ethereum address of the user who owns this asset
846
+ * ERC721 Token ID
629
847
  * @type {string}
630
- * @memberof Asset
848
+ * @memberof TokenData
631
849
  */
632
- 'user': string;
850
+ 'token_id'?: string;
633
851
  }
634
852
 
635
853
  /**
@@ -645,30 +863,11 @@ interface Asset {
645
863
  */
646
864
 
647
865
  /**
648
- *
866
+ * @type TokenDataOAIGen
867
+ * Token details of this asset
649
868
  * @export
650
- * @interface AssetProperties
651
869
  */
652
- interface AssetProperties {
653
- /**
654
- *
655
- * @type {CollectionDetails}
656
- * @memberof AssetProperties
657
- */
658
- 'collection'?: CollectionDetails;
659
- /**
660
- * Image URL of this asset
661
- * @type {string}
662
- * @memberof AssetProperties
663
- */
664
- 'image_url'?: string;
665
- /**
666
- * Name of this asset
667
- * @type {string}
668
- * @memberof AssetProperties
669
- */
670
- 'name'?: string;
671
- }
870
+ declare type TokenDataOAIGen = TokenData;
672
871
 
673
872
  /**
674
873
  * Immutable X API
@@ -685,99 +884,21 @@ interface AssetProperties {
685
884
  /**
686
885
  *
687
886
  * @export
688
- * @interface AssetWithOrders
887
+ * @interface Token
689
888
  */
690
- interface AssetWithOrders {
889
+ interface Token {
691
890
  /**
692
891
  *
693
- * @type {CollectionDetails}
694
- * @memberof AssetWithOrders
892
+ * @type {TokenDataOAIGen}
893
+ * @memberof Token
695
894
  */
696
- 'collection': CollectionDetails;
895
+ 'data': TokenDataOAIGen;
697
896
  /**
698
- * Timestamp of when the asset was created
897
+ * Type of this asset (ETH/ERC20/ERC721)
699
898
  * @type {string}
700
- * @memberof AssetWithOrders
701
- */
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;
721
- /**
722
- * URL of the image which should be used for this asset
723
- * @type {string}
724
- * @memberof AssetWithOrders
725
- */
726
- 'image_url': string | null;
727
- /**
728
- * Metadata of this asset
729
- * @type {object}
730
- * @memberof AssetWithOrders
731
- */
732
- 'metadata': object | null;
733
- /**
734
- * Name of this asset
735
- * @type {string}
736
- * @memberof AssetWithOrders
737
- */
738
- 'name': string | null;
739
- /**
740
- *
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
773
- */
774
- 'uri': string | null;
775
- /**
776
- * Ethereum address of the user who owns this asset
777
- * @type {string}
778
- * @memberof AssetWithOrders
899
+ * @memberof Token
779
900
  */
780
- 'user': string;
901
+ 'type': string;
781
902
  }
782
903
 
783
904
  /**
@@ -794,39 +915,21 @@ interface AssetWithOrders {
794
915
  /**
795
916
  *
796
917
  * @export
797
- * @interface Balance
918
+ * @interface FeeData
798
919
  */
799
- interface Balance {
800
- /**
801
- * Amount which is currently inside the exchange
802
- * @type {string}
803
- * @memberof Balance
804
- */
805
- 'balance': string;
806
- /**
807
- * Amount which is currently preparing withdrawal from the exchange
808
- * @type {string}
809
- * @memberof Balance
810
- */
811
- 'preparing_withdrawal': string;
812
- /**
813
- * Symbol of the token (e.g. ETH, IMX)
814
- * @type {string}
815
- * @memberof Balance
816
- */
817
- 'symbol': string;
920
+ interface FeeData {
818
921
  /**
819
- * Address of the contract that represents this ERC20 token or empty for ETH
922
+ * Address of ERC721/ERC20 contract
820
923
  * @type {string}
821
- * @memberof Balance
924
+ * @memberof FeeData
822
925
  */
823
- 'token_address': string;
926
+ 'contract_address'?: string;
824
927
  /**
825
- * Amount which is currently withdrawable from the exchange
826
- * @type {string}
827
- * @memberof Balance
928
+ * Number of decimals supported by this asset
929
+ * @type {number}
930
+ * @memberof FeeData
828
931
  */
829
- 'withdrawable': string;
932
+ 'decimals'?: number;
830
933
  }
831
934
 
832
935
  /**
@@ -840,25 +943,31 @@ interface Balance {
840
943
  * https://openapi-generator.tech
841
944
  * Do not edit the class manually.
842
945
  */
946
+
843
947
  /**
844
948
  *
845
949
  * @export
846
- * @interface CancelOrderRequest
950
+ * @interface FeeToken
847
951
  */
848
- interface CancelOrderRequest {
952
+ interface FeeToken {
849
953
  /**
850
- * ID of the order
851
- * @type {number}
852
- * @memberof CancelOrderRequest
954
+ *
955
+ * @type {FeeData}
956
+ * @memberof FeeToken
853
957
  */
854
- 'order_id': number;
958
+ 'data'?: FeeData;
855
959
  /**
856
- * Payload signature
960
+ * Fee token type. One of ETH/ERC20
857
961
  * @type {string}
858
- * @memberof CancelOrderRequest
962
+ * @memberof FeeToken
859
963
  */
860
- 'stark_signature': string;
964
+ 'type'?: FeeTokenTypeEnum;
861
965
  }
966
+ declare const FeeTokenTypeEnum: {
967
+ readonly Eth: "ETH";
968
+ readonly Erc20: "ERC20";
969
+ };
970
+ declare type FeeTokenTypeEnum = typeof FeeTokenTypeEnum[keyof typeof FeeTokenTypeEnum];
862
971
 
863
972
  /**
864
973
  * Immutable X API
@@ -871,25 +980,13 @@ interface CancelOrderRequest {
871
980
  * https://openapi-generator.tech
872
981
  * Do not edit the class manually.
873
982
  */
983
+
874
984
  /**
875
- *
985
+ * @type OrderFeeInfoToken
986
+ * Details of the fee currency
876
987
  * @export
877
- * @interface CancelOrderResponse
878
988
  */
879
- interface CancelOrderResponse {
880
- /**
881
- * ID of the cancelled order
882
- * @type {number}
883
- * @memberof CancelOrderResponse
884
- */
885
- 'order_id': number;
886
- /**
887
- * New status of the order
888
- * @type {string}
889
- * @memberof CancelOrderResponse
890
- */
891
- 'status': string;
892
- }
989
+ declare type OrderFeeInfoToken = FeeToken;
893
990
 
894
991
  /**
895
992
  * Immutable X API
@@ -902,72 +999,37 @@ interface CancelOrderResponse {
902
999
  * https://openapi-generator.tech
903
1000
  * Do not edit the class manually.
904
1001
  */
1002
+
905
1003
  /**
906
1004
  *
907
1005
  * @export
908
- * @interface Collection
1006
+ * @interface OrderFeeInfo
909
1007
  */
910
- interface Collection {
911
- /**
912
- * Ethereum address of the ERC721 contract
913
- * @type {string}
914
- * @memberof Collection
915
- */
916
- 'address': string;
917
- /**
918
- * URL of the tile image for this collection
919
- * @type {string}
920
- * @memberof Collection
921
- */
922
- 'collection_image_url': string | null;
923
- /**
924
- * Timestamp of when the collection was created
925
- * @type {string}
926
- * @memberof Collection
927
- */
928
- 'created_at': string | null;
929
- /**
930
- * Description of the collection
931
- * @type {string}
932
- * @memberof Collection
933
- */
934
- 'description': string | null;
935
- /**
936
- * URL of the icon for this collection
937
- * @type {string}
938
- * @memberof Collection
939
- */
940
- 'icon_url': string | null;
1008
+ interface OrderFeeInfo {
941
1009
  /**
942
- * URL of the metadata for this collection
1010
+ * Address of the fee recipient
943
1011
  * @type {string}
944
- * @memberof Collection
1012
+ * @memberof OrderFeeInfo
945
1013
  */
946
- 'metadata_api_url': string | null;
1014
+ 'address'?: string;
947
1015
  /**
948
- * Name of the collection
1016
+ * Fee amount
949
1017
  * @type {string}
950
- * @memberof Collection
951
- */
952
- 'name': string;
953
- /**
954
- * The collection\'s project ID
955
- * @type {number}
956
- * @memberof Collection
1018
+ * @memberof OrderFeeInfo
957
1019
  */
958
- 'project_id': number;
1020
+ 'amount'?: string;
959
1021
  /**
960
- * Project owner address
961
- * @type {string}
962
- * @memberof Collection
1022
+ *
1023
+ * @type {OrderFeeInfoToken}
1024
+ * @memberof OrderFeeInfo
963
1025
  */
964
- 'project_owner_address': string;
1026
+ 'token'?: OrderFeeInfoToken;
965
1027
  /**
966
- * Timestamp of when the collection was updated
1028
+ * Fee type
967
1029
  * @type {string}
968
- * @memberof Collection
1030
+ * @memberof OrderFeeInfo
969
1031
  */
970
- 'updated_at': string | null;
1032
+ 'type'?: string;
971
1033
  }
972
1034
 
973
1035
  /**
@@ -984,21 +1046,33 @@ interface Collection {
984
1046
  /**
985
1047
  *
986
1048
  * @export
987
- * @interface Range
1049
+ * @interface ApiRegisterPassportUserRequest
988
1050
  */
989
- interface Range {
1051
+ interface ApiRegisterPassportUserRequest {
990
1052
  /**
991
- * Maximum value
992
- * @type {number}
993
- * @memberof Range
1053
+ * Eth signature
1054
+ * @type {string}
1055
+ * @memberof ApiRegisterPassportUserRequest
994
1056
  */
995
- 'max'?: number;
1057
+ 'eth_signature': string;
996
1058
  /**
997
- * Minimum value
998
- * @type {number}
999
- * @memberof Range
1059
+ * The ether key of the user
1060
+ * @type {string}
1061
+ * @memberof ApiRegisterPassportUserRequest
1000
1062
  */
1001
- 'min'?: number;
1063
+ 'ether_key': string;
1064
+ /**
1065
+ * Public stark key of the user
1066
+ * @type {string}
1067
+ * @memberof ApiRegisterPassportUserRequest
1068
+ */
1069
+ 'stark_key': string;
1070
+ /**
1071
+ * Payload signature
1072
+ * @type {string}
1073
+ * @memberof ApiRegisterPassportUserRequest
1074
+ */
1075
+ 'stark_signature': string;
1002
1076
  }
1003
1077
 
1004
1078
  /**
@@ -1012,7 +1086,516 @@ interface Range {
1012
1086
  * https://openapi-generator.tech
1013
1087
  * Do not edit the class manually.
1014
1088
  */
1015
-
1089
+ /**
1090
+ *
1091
+ * @export
1092
+ * @interface Fee
1093
+ */
1094
+ interface Fee {
1095
+ /**
1096
+ * Wallet address
1097
+ * @type {string}
1098
+ * @memberof Fee
1099
+ */
1100
+ 'address': string;
1101
+ /**
1102
+ * The percentage of fee
1103
+ * @type {number}
1104
+ * @memberof Fee
1105
+ */
1106
+ 'percentage': number;
1107
+ /**
1108
+ * Type of fee. Examples: `royalty`, `maker`, `taker` or `protocol`
1109
+ * @type {string}
1110
+ * @memberof Fee
1111
+ */
1112
+ 'type': string;
1113
+ }
1114
+
1115
+ /**
1116
+ * Immutable X API
1117
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1118
+ *
1119
+ * The version of the OpenAPI document: 3.0
1120
+ * Contact: support@immutable.com
1121
+ *
1122
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1123
+ * https://openapi-generator.tech
1124
+ * Do not edit the class manually.
1125
+ */
1126
+ /**
1127
+ *
1128
+ * @export
1129
+ * @interface OrderDetails
1130
+ */
1131
+ interface OrderDetails {
1132
+ /**
1133
+ * Buy orders for this asset
1134
+ * @type {Array<object>}
1135
+ * @memberof OrderDetails
1136
+ */
1137
+ 'buy_orders'?: Array<object>;
1138
+ /**
1139
+ * Sell orders for this asset
1140
+ * @type {Array<object>}
1141
+ * @memberof OrderDetails
1142
+ */
1143
+ 'sell_orders'?: Array<object>;
1144
+ }
1145
+
1146
+ /**
1147
+ * Immutable X API
1148
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1149
+ *
1150
+ * The version of the OpenAPI document: 3.0
1151
+ * Contact: support@immutable.com
1152
+ *
1153
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1154
+ * https://openapi-generator.tech
1155
+ * Do not edit the class manually.
1156
+ */
1157
+
1158
+ /**
1159
+ *
1160
+ * @export
1161
+ * @interface Asset
1162
+ */
1163
+ interface Asset {
1164
+ /**
1165
+ *
1166
+ * @type {CollectionDetails}
1167
+ * @memberof Asset
1168
+ */
1169
+ 'collection': CollectionDetails;
1170
+ /**
1171
+ * Timestamp of when the asset was created
1172
+ * @type {string}
1173
+ * @memberof Asset
1174
+ */
1175
+ 'created_at': string | null;
1176
+ /**
1177
+ * Description of this asset
1178
+ * @type {string}
1179
+ * @memberof Asset
1180
+ */
1181
+ 'description': string | null;
1182
+ /**
1183
+ * Royalties to pay on this asset operations
1184
+ * @type {Array<Fee>}
1185
+ * @memberof Asset
1186
+ */
1187
+ 'fees'?: Array<Fee>;
1188
+ /**
1189
+ * [DEPRECATED] Internal Immutable X Token ID
1190
+ * @type {string}
1191
+ * @memberof Asset
1192
+ */
1193
+ 'id'?: string;
1194
+ /**
1195
+ * URL of the image which should be used for this asset
1196
+ * @type {string}
1197
+ * @memberof Asset
1198
+ */
1199
+ 'image_url': string | null;
1200
+ /**
1201
+ * Metadata of this asset
1202
+ * @type {object}
1203
+ * @memberof Asset
1204
+ */
1205
+ 'metadata': object | null;
1206
+ /**
1207
+ * Name of this asset
1208
+ * @type {string}
1209
+ * @memberof Asset
1210
+ */
1211
+ 'name': string | null;
1212
+ /**
1213
+ *
1214
+ * @type {OrderDetails}
1215
+ * @memberof Asset
1216
+ */
1217
+ 'orders'?: OrderDetails;
1218
+ /**
1219
+ * Status of this asset (where it is in the system)
1220
+ * @type {string}
1221
+ * @memberof Asset
1222
+ */
1223
+ 'status': string;
1224
+ /**
1225
+ * Address of the ERC721 contract
1226
+ * @type {string}
1227
+ * @memberof Asset
1228
+ */
1229
+ 'token_address': string;
1230
+ /**
1231
+ * ERC721 Token ID of this asset
1232
+ * @type {string}
1233
+ * @memberof Asset
1234
+ */
1235
+ 'token_id': string;
1236
+ /**
1237
+ * Timestamp of when the asset was updated
1238
+ * @type {string}
1239
+ * @memberof Asset
1240
+ */
1241
+ 'updated_at': string | null;
1242
+ /**
1243
+ * URI to access this asset externally to Immutable X
1244
+ * @type {string}
1245
+ * @memberof Asset
1246
+ */
1247
+ 'uri': string | null;
1248
+ /**
1249
+ * Ethereum address of the user who owns this asset
1250
+ * @type {string}
1251
+ * @memberof Asset
1252
+ */
1253
+ 'user': string;
1254
+ }
1255
+
1256
+ /**
1257
+ * Immutable X API
1258
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1259
+ *
1260
+ * The version of the OpenAPI document: 3.0
1261
+ * Contact: support@immutable.com
1262
+ *
1263
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1264
+ * https://openapi-generator.tech
1265
+ * Do not edit the class manually.
1266
+ */
1267
+
1268
+ /**
1269
+ *
1270
+ * @export
1271
+ * @interface AssetWithOrders
1272
+ */
1273
+ interface AssetWithOrders {
1274
+ /**
1275
+ *
1276
+ * @type {CollectionDetails}
1277
+ * @memberof AssetWithOrders
1278
+ */
1279
+ 'collection': CollectionDetails;
1280
+ /**
1281
+ * Timestamp of when the asset was created
1282
+ * @type {string}
1283
+ * @memberof AssetWithOrders
1284
+ */
1285
+ 'created_at': string | null;
1286
+ /**
1287
+ * Description of this asset
1288
+ * @type {string}
1289
+ * @memberof AssetWithOrders
1290
+ */
1291
+ 'description': string | null;
1292
+ /**
1293
+ * Royalties to pay on this asset operations
1294
+ * @type {Array<Fee>}
1295
+ * @memberof AssetWithOrders
1296
+ */
1297
+ 'fees'?: Array<Fee>;
1298
+ /**
1299
+ * [DEPRECATED] Internal Immutable X Token ID
1300
+ * @type {string}
1301
+ * @memberof AssetWithOrders
1302
+ */
1303
+ 'id'?: string;
1304
+ /**
1305
+ * URL of the image which should be used for this asset
1306
+ * @type {string}
1307
+ * @memberof AssetWithOrders
1308
+ */
1309
+ 'image_url': string | null;
1310
+ /**
1311
+ * Metadata of this asset
1312
+ * @type {object}
1313
+ * @memberof AssetWithOrders
1314
+ */
1315
+ 'metadata': object | null;
1316
+ /**
1317
+ * Name of this asset
1318
+ * @type {string}
1319
+ * @memberof AssetWithOrders
1320
+ */
1321
+ 'name': string | null;
1322
+ /**
1323
+ *
1324
+ * @type {OrderDetails}
1325
+ * @memberof AssetWithOrders
1326
+ */
1327
+ 'orders'?: OrderDetails;
1328
+ /**
1329
+ * Status of this asset (where it is in the system)
1330
+ * @type {string}
1331
+ * @memberof AssetWithOrders
1332
+ */
1333
+ 'status': string;
1334
+ /**
1335
+ * Address of the ERC721 contract
1336
+ * @type {string}
1337
+ * @memberof AssetWithOrders
1338
+ */
1339
+ 'token_address': string;
1340
+ /**
1341
+ * ERC721 Token ID of this asset
1342
+ * @type {string}
1343
+ * @memberof AssetWithOrders
1344
+ */
1345
+ 'token_id': string;
1346
+ /**
1347
+ * Timestamp of when the asset was updated
1348
+ * @type {string}
1349
+ * @memberof AssetWithOrders
1350
+ */
1351
+ 'updated_at': string | null;
1352
+ /**
1353
+ * URI to access this asset externally to Immutable X
1354
+ * @type {string}
1355
+ * @memberof AssetWithOrders
1356
+ */
1357
+ 'uri': string | null;
1358
+ /**
1359
+ * Ethereum address of the user who owns this asset
1360
+ * @type {string}
1361
+ * @memberof AssetWithOrders
1362
+ */
1363
+ 'user': string;
1364
+ }
1365
+
1366
+ /**
1367
+ * Immutable X API
1368
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1369
+ *
1370
+ * The version of the OpenAPI document: 3.0
1371
+ * Contact: support@immutable.com
1372
+ *
1373
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1374
+ * https://openapi-generator.tech
1375
+ * Do not edit the class manually.
1376
+ */
1377
+ /**
1378
+ *
1379
+ * @export
1380
+ * @interface Balance
1381
+ */
1382
+ interface Balance {
1383
+ /**
1384
+ * Amount which is currently inside the exchange
1385
+ * @type {string}
1386
+ * @memberof Balance
1387
+ */
1388
+ 'balance': string;
1389
+ /**
1390
+ * Amount which is currently preparing withdrawal from the exchange
1391
+ * @type {string}
1392
+ * @memberof Balance
1393
+ */
1394
+ 'preparing_withdrawal': string;
1395
+ /**
1396
+ * Symbol of the token (e.g. ETH, IMX)
1397
+ * @type {string}
1398
+ * @memberof Balance
1399
+ */
1400
+ 'symbol': string;
1401
+ /**
1402
+ * Address of the contract that represents this ERC20 token or empty for ETH
1403
+ * @type {string}
1404
+ * @memberof Balance
1405
+ */
1406
+ 'token_address': string;
1407
+ /**
1408
+ * Amount which is currently withdrawable from the exchange
1409
+ * @type {string}
1410
+ * @memberof Balance
1411
+ */
1412
+ 'withdrawable': string;
1413
+ }
1414
+
1415
+ /**
1416
+ * Immutable X API
1417
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1418
+ *
1419
+ * The version of the OpenAPI document: 3.0
1420
+ * Contact: support@immutable.com
1421
+ *
1422
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1423
+ * https://openapi-generator.tech
1424
+ * Do not edit the class manually.
1425
+ */
1426
+ /**
1427
+ *
1428
+ * @export
1429
+ * @interface CancelOrderRequest
1430
+ */
1431
+ interface CancelOrderRequest {
1432
+ /**
1433
+ * ID of the order
1434
+ * @type {number}
1435
+ * @memberof CancelOrderRequest
1436
+ */
1437
+ 'order_id': number;
1438
+ /**
1439
+ * Payload signature
1440
+ * @type {string}
1441
+ * @memberof CancelOrderRequest
1442
+ */
1443
+ 'stark_signature': string;
1444
+ }
1445
+
1446
+ /**
1447
+ * Immutable X API
1448
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1449
+ *
1450
+ * The version of the OpenAPI document: 3.0
1451
+ * Contact: support@immutable.com
1452
+ *
1453
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1454
+ * https://openapi-generator.tech
1455
+ * Do not edit the class manually.
1456
+ */
1457
+ /**
1458
+ *
1459
+ * @export
1460
+ * @interface CancelOrderResponse
1461
+ */
1462
+ interface CancelOrderResponse {
1463
+ /**
1464
+ * ID of the cancelled order
1465
+ * @type {number}
1466
+ * @memberof CancelOrderResponse
1467
+ */
1468
+ 'order_id': number;
1469
+ /**
1470
+ * New status of the order
1471
+ * @type {string}
1472
+ * @memberof CancelOrderResponse
1473
+ */
1474
+ 'status': string;
1475
+ }
1476
+
1477
+ /**
1478
+ * Immutable X API
1479
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1480
+ *
1481
+ * The version of the OpenAPI document: 3.0
1482
+ * Contact: support@immutable.com
1483
+ *
1484
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1485
+ * https://openapi-generator.tech
1486
+ * Do not edit the class manually.
1487
+ */
1488
+ /**
1489
+ *
1490
+ * @export
1491
+ * @interface Collection
1492
+ */
1493
+ interface Collection {
1494
+ /**
1495
+ * Ethereum address of the ERC721 contract
1496
+ * @type {string}
1497
+ * @memberof Collection
1498
+ */
1499
+ 'address': string;
1500
+ /**
1501
+ * URL of the tile image for this collection
1502
+ * @type {string}
1503
+ * @memberof Collection
1504
+ */
1505
+ 'collection_image_url': string | null;
1506
+ /**
1507
+ * Timestamp of when the collection was created
1508
+ * @type {string}
1509
+ * @memberof Collection
1510
+ */
1511
+ 'created_at': string | null;
1512
+ /**
1513
+ * Description of the collection
1514
+ * @type {string}
1515
+ * @memberof Collection
1516
+ */
1517
+ 'description': string | null;
1518
+ /**
1519
+ * URL of the icon for this collection
1520
+ * @type {string}
1521
+ * @memberof Collection
1522
+ */
1523
+ 'icon_url': string | null;
1524
+ /**
1525
+ * URL of the metadata for this collection
1526
+ * @type {string}
1527
+ * @memberof Collection
1528
+ */
1529
+ 'metadata_api_url': string | null;
1530
+ /**
1531
+ * Name of the collection
1532
+ * @type {string}
1533
+ * @memberof Collection
1534
+ */
1535
+ 'name': string;
1536
+ /**
1537
+ * The collection\'s project ID
1538
+ * @type {number}
1539
+ * @memberof Collection
1540
+ */
1541
+ 'project_id': number;
1542
+ /**
1543
+ * Project owner address
1544
+ * @type {string}
1545
+ * @memberof Collection
1546
+ */
1547
+ 'project_owner_address': string;
1548
+ /**
1549
+ * Timestamp of when the collection was updated
1550
+ * @type {string}
1551
+ * @memberof Collection
1552
+ */
1553
+ 'updated_at': string | null;
1554
+ }
1555
+
1556
+ /**
1557
+ * Immutable X API
1558
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1559
+ *
1560
+ * The version of the OpenAPI document: 3.0
1561
+ * Contact: support@immutable.com
1562
+ *
1563
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1564
+ * https://openapi-generator.tech
1565
+ * Do not edit the class manually.
1566
+ */
1567
+ /**
1568
+ *
1569
+ * @export
1570
+ * @interface Range
1571
+ */
1572
+ interface Range {
1573
+ /**
1574
+ * Maximum value
1575
+ * @type {number}
1576
+ * @memberof Range
1577
+ */
1578
+ 'max'?: number;
1579
+ /**
1580
+ * Minimum value
1581
+ * @type {number}
1582
+ * @memberof Range
1583
+ */
1584
+ 'min'?: number;
1585
+ }
1586
+
1587
+ /**
1588
+ * Immutable X API
1589
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1590
+ *
1591
+ * The version of the OpenAPI document: 3.0
1592
+ * Contact: support@immutable.com
1593
+ *
1594
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1595
+ * https://openapi-generator.tech
1596
+ * Do not edit the class manually.
1597
+ */
1598
+
1016
1599
  /**
1017
1600
  *
1018
1601
  * @export
@@ -1369,77 +1952,169 @@ interface FeeEntry {
1369
1952
  * @export
1370
1953
  * @interface CreateOrderRequest
1371
1954
  */
1372
- interface CreateOrderRequest {
1955
+ interface CreateOrderRequest {
1956
+ /**
1957
+ * Amount to buy
1958
+ * @type {string}
1959
+ * @memberof CreateOrderRequest
1960
+ */
1961
+ 'amount_buy': string;
1962
+ /**
1963
+ * Amount to sell
1964
+ * @type {string}
1965
+ * @memberof CreateOrderRequest
1966
+ */
1967
+ 'amount_sell': string;
1968
+ /**
1969
+ * ID of the asset to buy
1970
+ * @type {string}
1971
+ * @memberof CreateOrderRequest
1972
+ */
1973
+ 'asset_id_buy': string;
1974
+ /**
1975
+ * ID of the asset to sell
1976
+ * @type {string}
1977
+ * @memberof CreateOrderRequest
1978
+ */
1979
+ 'asset_id_sell': string;
1980
+ /**
1981
+ * Expiration timestamp for this order
1982
+ * @type {number}
1983
+ * @memberof CreateOrderRequest
1984
+ */
1985
+ 'expiration_timestamp': number;
1986
+ /**
1987
+ * Fee information
1988
+ * @type {Array<FeeEntry>}
1989
+ * @memberof CreateOrderRequest
1990
+ */
1991
+ 'fees'?: Array<FeeEntry>;
1992
+ /**
1993
+ * Whether to include fees in order
1994
+ * @type {boolean}
1995
+ * @memberof CreateOrderRequest
1996
+ */
1997
+ 'include_fees'?: boolean;
1998
+ /**
1999
+ * Nonce of the order
2000
+ * @type {number}
2001
+ * @memberof CreateOrderRequest
2002
+ */
2003
+ 'nonce': number;
2004
+ /**
2005
+ * Public stark key of the user creating order
2006
+ * @type {string}
2007
+ * @memberof CreateOrderRequest
2008
+ */
2009
+ 'stark_key': string;
2010
+ /**
2011
+ * Payload signature
2012
+ * @type {string}
2013
+ * @memberof CreateOrderRequest
2014
+ */
2015
+ 'stark_signature': string;
2016
+ /**
2017
+ * ID of the vault into which the bought asset will be placed
2018
+ * @type {number}
2019
+ * @memberof CreateOrderRequest
2020
+ */
2021
+ 'vault_id_buy': number;
2022
+ /**
2023
+ * ID of the vault to sell from
2024
+ * @type {number}
2025
+ * @memberof CreateOrderRequest
2026
+ */
2027
+ 'vault_id_sell': number;
2028
+ }
2029
+
2030
+ /**
2031
+ * Immutable X API
2032
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2033
+ *
2034
+ * The version of the OpenAPI document: 3.0
2035
+ * Contact: support@immutable.com
2036
+ *
2037
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2038
+ * https://openapi-generator.tech
2039
+ * Do not edit the class manually.
2040
+ */
2041
+
2042
+ /**
2043
+ *
2044
+ * @export
2045
+ * @interface CreateOrderRequestV3
2046
+ */
2047
+ interface CreateOrderRequestV3 {
1373
2048
  /**
1374
2049
  * Amount to buy
1375
2050
  * @type {string}
1376
- * @memberof CreateOrderRequest
2051
+ * @memberof CreateOrderRequestV3
1377
2052
  */
1378
2053
  'amount_buy': string;
1379
2054
  /**
1380
2055
  * Amount to sell
1381
2056
  * @type {string}
1382
- * @memberof CreateOrderRequest
2057
+ * @memberof CreateOrderRequestV3
1383
2058
  */
1384
2059
  'amount_sell': string;
1385
2060
  /**
1386
2061
  * ID of the asset to buy
1387
2062
  * @type {string}
1388
- * @memberof CreateOrderRequest
2063
+ * @memberof CreateOrderRequestV3
1389
2064
  */
1390
2065
  'asset_id_buy': string;
1391
2066
  /**
1392
2067
  * ID of the asset to sell
1393
2068
  * @type {string}
1394
- * @memberof CreateOrderRequest
2069
+ * @memberof CreateOrderRequestV3
1395
2070
  */
1396
2071
  'asset_id_sell': string;
1397
2072
  /**
1398
2073
  * Expiration timestamp for this order
1399
2074
  * @type {number}
1400
- * @memberof CreateOrderRequest
2075
+ * @memberof CreateOrderRequestV3
1401
2076
  */
1402
2077
  'expiration_timestamp': number;
1403
2078
  /**
1404
2079
  * Fee information
1405
2080
  * @type {Array<FeeEntry>}
1406
- * @memberof CreateOrderRequest
2081
+ * @memberof CreateOrderRequestV3
1407
2082
  */
1408
2083
  'fees'?: Array<FeeEntry>;
1409
2084
  /**
1410
- * Whether to include fees in order
2085
+ * [DEPRECATED] Whether to include fees in order
1411
2086
  * @type {boolean}
1412
- * @memberof CreateOrderRequest
2087
+ * @memberof CreateOrderRequestV3
1413
2088
  */
1414
2089
  'include_fees'?: boolean;
1415
2090
  /**
1416
2091
  * Nonce of the order
1417
2092
  * @type {number}
1418
- * @memberof CreateOrderRequest
2093
+ * @memberof CreateOrderRequestV3
1419
2094
  */
1420
2095
  'nonce': number;
1421
2096
  /**
1422
2097
  * Public stark key of the user creating order
1423
2098
  * @type {string}
1424
- * @memberof CreateOrderRequest
2099
+ * @memberof CreateOrderRequestV3
1425
2100
  */
1426
2101
  'stark_key': string;
1427
2102
  /**
1428
2103
  * Payload signature
1429
2104
  * @type {string}
1430
- * @memberof CreateOrderRequest
2105
+ * @memberof CreateOrderRequestV3
1431
2106
  */
1432
2107
  'stark_signature': string;
1433
2108
  /**
1434
2109
  * ID of the vault into which the bought asset will be placed
1435
2110
  * @type {number}
1436
- * @memberof CreateOrderRequest
2111
+ * @memberof CreateOrderRequestV3
1437
2112
  */
1438
2113
  'vault_id_buy': number;
1439
2114
  /**
1440
2115
  * ID of the vault to sell from
1441
2116
  * @type {number}
1442
- * @memberof CreateOrderRequest
2117
+ * @memberof CreateOrderRequestV3
1443
2118
  */
1444
2119
  'vault_id_sell': number;
1445
2120
  }
@@ -1586,6 +2261,25 @@ interface FeeInfo {
1586
2261
  'source_vault_id': number;
1587
2262
  }
1588
2263
 
2264
+ /**
2265
+ * Immutable X API
2266
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2267
+ *
2268
+ * The version of the OpenAPI document: 3.0
2269
+ * Contact: support@immutable.com
2270
+ *
2271
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2272
+ * https://openapi-generator.tech
2273
+ * Do not edit the class manually.
2274
+ */
2275
+
2276
+ /**
2277
+ * @type CreateTradeRequestV1FeeInfo
2278
+ * Fee details
2279
+ * @export
2280
+ */
2281
+ declare type CreateTradeRequestV1FeeInfo = FeeInfo;
2282
+
1589
2283
  /**
1590
2284
  * Immutable X API
1591
2285
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -1636,10 +2330,10 @@ interface CreateTradeRequestV1 {
1636
2330
  'expiration_timestamp': number;
1637
2331
  /**
1638
2332
  *
1639
- * @type {FeeInfo}
2333
+ * @type {CreateTradeRequestV1FeeInfo}
1640
2334
  * @memberof CreateTradeRequestV1
1641
2335
  */
1642
- 'fee_info'?: FeeInfo;
2336
+ 'fee_info'?: CreateTradeRequestV1FeeInfo;
1643
2337
  /**
1644
2338
  * Fee information
1645
2339
  * @type {Array<FeeEntry>}
@@ -2103,106 +2797,6 @@ interface CurrencyWithLimits {
2103
2797
  'symbol'?: string;
2104
2798
  }
2105
2799
 
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
2800
  /**
2207
2801
  * Immutable X API
2208
2802
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -2437,74 +3031,6 @@ interface ExchangeCreateExchangeAndURLResponse {
2437
3031
  'wallet_address'?: string;
2438
3032
  }
2439
3033
 
2440
- /**
2441
- * Immutable X API
2442
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2443
- *
2444
- * The version of the OpenAPI document: 3.0
2445
- * Contact: support@immutable.com
2446
- *
2447
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2448
- * https://openapi-generator.tech
2449
- * Do not edit the class manually.
2450
- */
2451
- /**
2452
- *
2453
- * @export
2454
- * @interface FeeData
2455
- */
2456
- interface FeeData {
2457
- /**
2458
- * Address of ERC721/ERC20 contract
2459
- * @type {string}
2460
- * @memberof FeeData
2461
- */
2462
- 'contract_address'?: string;
2463
- /**
2464
- * Number of decimals supported by this asset
2465
- * @type {number}
2466
- * @memberof FeeData
2467
- */
2468
- 'decimals'?: number;
2469
- }
2470
-
2471
- /**
2472
- * Immutable X API
2473
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
2474
- *
2475
- * The version of the OpenAPI document: 3.0
2476
- * Contact: support@immutable.com
2477
- *
2478
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2479
- * https://openapi-generator.tech
2480
- * Do not edit the class manually.
2481
- */
2482
-
2483
- /**
2484
- *
2485
- * @export
2486
- * @interface FeeToken
2487
- */
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
3034
  /**
2509
3035
  * Immutable X API
2510
3036
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3093,6 +3619,44 @@ interface GetSignableDepositResponse {
3093
3619
  'vault_id': number;
3094
3620
  }
3095
3621
 
3622
+ /**
3623
+ * Immutable X API
3624
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3625
+ *
3626
+ * The version of the OpenAPI document: 3.0
3627
+ * Contact: support@immutable.com
3628
+ *
3629
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3630
+ * https://openapi-generator.tech
3631
+ * Do not edit the class manually.
3632
+ */
3633
+
3634
+ /**
3635
+ * @type GetSignableOrderRequestV3TokenBuy
3636
+ * Token to buy
3637
+ * @export
3638
+ */
3639
+ declare type GetSignableOrderRequestV3TokenBuy = SignableToken;
3640
+
3641
+ /**
3642
+ * Immutable X API
3643
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3644
+ *
3645
+ * The version of the OpenAPI document: 3.0
3646
+ * Contact: support@immutable.com
3647
+ *
3648
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3649
+ * https://openapi-generator.tech
3650
+ * Do not edit the class manually.
3651
+ */
3652
+
3653
+ /**
3654
+ * @type GetSignableOrderRequestV3TokenSell
3655
+ * Token to sell
3656
+ * @export
3657
+ */
3658
+ declare type GetSignableOrderRequestV3TokenSell = SignableToken;
3659
+
3096
3660
  /**
3097
3661
  * Immutable X API
3098
3662
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3108,53 +3672,78 @@ interface GetSignableDepositResponse {
3108
3672
  /**
3109
3673
  *
3110
3674
  * @export
3111
- * @interface GetSignableOrderRequest
3675
+ * @interface GetSignableOrderRequestV3
3112
3676
  */
3113
- interface GetSignableOrderRequest {
3677
+ interface GetSignableOrderRequestV3 {
3114
3678
  /**
3115
3679
  * Fee-exclusive amount to buy the asset
3116
3680
  * @type {string}
3117
- * @memberof GetSignableOrderRequest
3681
+ * @memberof GetSignableOrderRequestV3
3118
3682
  */
3119
3683
  'amount_buy': string;
3120
3684
  /**
3121
3685
  * Amount to sell (quantity)
3122
3686
  * @type {string}
3123
- * @memberof GetSignableOrderRequest
3687
+ * @memberof GetSignableOrderRequestV3
3124
3688
  */
3125
3689
  'amount_sell': string;
3126
3690
  /**
3127
3691
  * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
3128
3692
  * @type {number}
3129
- * @memberof GetSignableOrderRequest
3693
+ * @memberof GetSignableOrderRequestV3
3130
3694
  */
3131
3695
  'expiration_timestamp'?: number;
3132
3696
  /**
3133
3697
  * Inclusion of either maker or taker fees
3134
3698
  * @type {Array<FeeEntry>}
3135
- * @memberof GetSignableOrderRequest
3699
+ * @memberof GetSignableOrderRequestV3
3136
3700
  */
3137
3701
  'fees'?: Array<FeeEntry>;
3702
+ /**
3703
+ * 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
3704
+ * @type {boolean}
3705
+ * @memberof GetSignableOrderRequestV3
3706
+ */
3707
+ 'split_fees'?: boolean;
3138
3708
  /**
3139
3709
  *
3140
- * @type {SignableToken}
3141
- * @memberof GetSignableOrderRequest
3710
+ * @type {GetSignableOrderRequestV3TokenBuy}
3711
+ * @memberof GetSignableOrderRequestV3
3142
3712
  */
3143
- 'token_buy': SignableToken;
3713
+ 'token_buy': GetSignableOrderRequestV3TokenBuy;
3144
3714
  /**
3145
3715
  *
3146
- * @type {SignableToken}
3147
- * @memberof GetSignableOrderRequest
3716
+ * @type {GetSignableOrderRequestV3TokenSell}
3717
+ * @memberof GetSignableOrderRequestV3
3148
3718
  */
3149
- 'token_sell': SignableToken;
3719
+ 'token_sell': GetSignableOrderRequestV3TokenSell;
3150
3720
  /**
3151
3721
  * Ethereum address of the submitting user
3152
3722
  * @type {string}
3153
- * @memberof GetSignableOrderRequest
3723
+ * @memberof GetSignableOrderRequestV3
3154
3724
  */
3155
3725
  'user': string;
3156
3726
  }
3157
3727
 
3728
+ /**
3729
+ * Immutable X API
3730
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3731
+ *
3732
+ * The version of the OpenAPI document: 3.0
3733
+ * Contact: support@immutable.com
3734
+ *
3735
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3736
+ * https://openapi-generator.tech
3737
+ * Do not edit the class manually.
3738
+ */
3739
+
3740
+ /**
3741
+ * @type GetSignableOrderResponseFeeInfo
3742
+ * Fee information
3743
+ * @export
3744
+ */
3745
+ declare type GetSignableOrderResponseFeeInfo = FeeInfo;
3746
+
3158
3747
  /**
3159
3748
  * Immutable X API
3160
3749
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3205,10 +3794,10 @@ interface GetSignableOrderResponse {
3205
3794
  'expiration_timestamp': number;
3206
3795
  /**
3207
3796
  *
3208
- * @type {FeeInfo}
3797
+ * @type {GetSignableOrderResponseFeeInfo}
3209
3798
  * @memberof GetSignableOrderResponse
3210
3799
  */
3211
- 'fee_info'?: FeeInfo;
3800
+ 'fee_info'?: GetSignableOrderResponseFeeInfo;
3212
3801
  /**
3213
3802
  * Nonce of the order
3214
3803
  * @type {number}
@@ -3384,6 +3973,25 @@ interface GetSignableTradeRequest {
3384
3973
  'user': string;
3385
3974
  }
3386
3975
 
3976
+ /**
3977
+ * Immutable X API
3978
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3979
+ *
3980
+ * The version of the OpenAPI document: 3.0
3981
+ * Contact: support@immutable.com
3982
+ *
3983
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3984
+ * https://openapi-generator.tech
3985
+ * Do not edit the class manually.
3986
+ */
3987
+
3988
+ /**
3989
+ * @type GetSignableTradeResponseFeeInfo
3990
+ * Fee information
3991
+ * @export
3992
+ */
3993
+ declare type GetSignableTradeResponseFeeInfo = FeeInfo;
3994
+
3387
3995
  /**
3388
3996
  * Immutable X API
3389
3997
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -3434,10 +4042,10 @@ interface GetSignableTradeResponse {
3434
4042
  'expiration_timestamp': number;
3435
4043
  /**
3436
4044
  *
3437
- * @type {FeeInfo}
4045
+ * @type {GetSignableTradeResponseFeeInfo}
3438
4046
  * @memberof GetSignableTradeResponse
3439
4047
  */
3440
- 'fee_info'?: FeeInfo;
4048
+ 'fee_info'?: GetSignableTradeResponseFeeInfo;
3441
4049
  /**
3442
4050
  * Nonce of the order
3443
4051
  * @type {number}
@@ -4164,30 +4772,299 @@ interface Mint {
4164
4772
  */
4165
4773
 
4166
4774
  /**
4167
- *
4775
+ *
4776
+ * @export
4777
+ * @interface ListMintsResponse
4778
+ */
4779
+ interface ListMintsResponse {
4780
+ /**
4781
+ * Generated cursor returned by previous query
4782
+ * @type {string}
4783
+ * @memberof ListMintsResponse
4784
+ */
4785
+ 'cursor': string;
4786
+ /**
4787
+ * Remaining results flag. 1: there are remaining results matching this query, 0: no remaining results
4788
+ * @type {number}
4789
+ * @memberof ListMintsResponse
4790
+ */
4791
+ 'remaining': number;
4792
+ /**
4793
+ * Mints matching query parameters
4794
+ * @type {Array<Mint>}
4795
+ * @memberof ListMintsResponse
4796
+ */
4797
+ 'result': Array<Mint>;
4798
+ }
4799
+
4800
+ /**
4801
+ * Immutable X API
4802
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4803
+ *
4804
+ * The version of the OpenAPI document: 3.0
4805
+ * Contact: support@immutable.com
4806
+ *
4807
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4808
+ * https://openapi-generator.tech
4809
+ * Do not edit the class manually.
4810
+ */
4811
+
4812
+ /**
4813
+ * @type OrderBuy
4814
+ * Details of the asset being bought
4815
+ * @export
4816
+ */
4817
+ declare type OrderBuy = Token;
4818
+
4819
+ /**
4820
+ * Immutable X API
4821
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4822
+ *
4823
+ * The version of the OpenAPI document: 3.0
4824
+ * Contact: support@immutable.com
4825
+ *
4826
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4827
+ * https://openapi-generator.tech
4828
+ * Do not edit the class manually.
4829
+ */
4830
+
4831
+ /**
4832
+ * @type OrderSell
4833
+ * Details of the asset being sold
4834
+ * @export
4835
+ */
4836
+ declare type OrderSell = Token;
4837
+
4838
+ /**
4839
+ * Immutable X API
4840
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4841
+ *
4842
+ * The version of the OpenAPI document: 3.0
4843
+ * Contact: support@immutable.com
4844
+ *
4845
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4846
+ * https://openapi-generator.tech
4847
+ * Do not edit the class manually.
4848
+ */
4849
+
4850
+ /**
4851
+ *
4852
+ * @export
4853
+ * @interface Order
4854
+ */
4855
+ interface Order {
4856
+ /**
4857
+ * Amount of the asset already sold by this order
4858
+ * @type {string}
4859
+ * @memberof Order
4860
+ */
4861
+ 'amount_sold': string | null;
4862
+ /**
4863
+ *
4864
+ * @type {OrderBuy}
4865
+ * @memberof Order
4866
+ */
4867
+ 'buy': OrderBuy;
4868
+ /**
4869
+ * Expiration timestamp of this order
4870
+ * @type {string}
4871
+ * @memberof Order
4872
+ */
4873
+ 'expiration_timestamp': string | null;
4874
+ /**
4875
+ * Fee information for the order
4876
+ * @type {Array<OrderFeeInfo>}
4877
+ * @memberof Order
4878
+ */
4879
+ 'fees'?: Array<OrderFeeInfo>;
4880
+ /**
4881
+ * ID of the order
4882
+ * @type {number}
4883
+ * @memberof Order
4884
+ */
4885
+ 'order_id': number;
4886
+ /**
4887
+ *
4888
+ * @type {OrderSell}
4889
+ * @memberof Order
4890
+ */
4891
+ 'sell': OrderSell;
4892
+ /**
4893
+ * Status of the order
4894
+ * @type {string}
4895
+ * @memberof Order
4896
+ */
4897
+ 'status': string;
4898
+ /**
4899
+ * Timestamp this order was created
4900
+ * @type {string}
4901
+ * @memberof Order
4902
+ */
4903
+ 'timestamp': string | null;
4904
+ /**
4905
+ * Updated timestamp of this order
4906
+ * @type {string}
4907
+ * @memberof Order
4908
+ */
4909
+ 'updated_timestamp': string | null;
4910
+ /**
4911
+ * Ethereum address of the user who submitted the order
4912
+ * @type {string}
4913
+ * @memberof Order
4914
+ */
4915
+ 'user': string;
4916
+ }
4917
+
4918
+ /**
4919
+ * Immutable X API
4920
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4921
+ *
4922
+ * The version of the OpenAPI document: 3.0
4923
+ * Contact: support@immutable.com
4924
+ *
4925
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4926
+ * https://openapi-generator.tech
4927
+ * Do not edit the class manually.
4928
+ */
4929
+
4930
+ /**
4931
+ *
4932
+ * @export
4933
+ * @interface ListOrdersResponse
4934
+ */
4935
+ interface ListOrdersResponse {
4936
+ /**
4937
+ * Generated cursor returned by previous query
4938
+ * @type {string}
4939
+ * @memberof ListOrdersResponse
4940
+ */
4941
+ 'cursor': string;
4942
+ /**
4943
+ * Remaining results flag. 1: there are remaining results matching this query, 0: no remaining results
4944
+ * @type {number}
4945
+ * @memberof ListOrdersResponse
4946
+ */
4947
+ 'remaining': number;
4948
+ /**
4949
+ * Orders matching query parameters
4950
+ * @type {Array<Order>}
4951
+ * @memberof ListOrdersResponse
4952
+ */
4953
+ 'result': Array<Order>;
4954
+ }
4955
+
4956
+ /**
4957
+ * Immutable X API
4958
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4959
+ *
4960
+ * The version of the OpenAPI document: 3.0
4961
+ * Contact: support@immutable.com
4962
+ *
4963
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4964
+ * https://openapi-generator.tech
4965
+ * Do not edit the class manually.
4966
+ */
4967
+
4968
+ /**
4969
+ * @type OrderV3Buy
4970
+ * Details of the asset being bought
4971
+ * @export
4972
+ */
4973
+ declare type OrderV3Buy = Token;
4974
+
4975
+ /**
4976
+ * Immutable X API
4977
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4978
+ *
4979
+ * The version of the OpenAPI document: 3.0
4980
+ * Contact: support@immutable.com
4981
+ *
4982
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4983
+ * https://openapi-generator.tech
4984
+ * Do not edit the class manually.
4985
+ */
4986
+
4987
+ /**
4988
+ *
4989
+ * @export
4990
+ * @interface OrdersMakerTakerFee
4991
+ */
4992
+ interface OrdersMakerTakerFee {
4993
+ /**
4994
+ * Number of Decimals supported the fee token
4995
+ * @type {number}
4996
+ * @memberof OrdersMakerTakerFee
4997
+ */
4998
+ 'decimals'?: number;
4999
+ /**
5000
+ * Fees
5001
+ * @type {Array<OrderFeeInfo>}
5002
+ * @memberof OrdersMakerTakerFee
5003
+ */
5004
+ 'fees'?: Array<OrderFeeInfo>;
5005
+ /**
5006
+ * Quantity of this asset with the sum of all fees applied to the asset
5007
+ * @type {string}
5008
+ * @memberof OrdersMakerTakerFee
5009
+ */
5010
+ 'quantity_with_fees': string;
5011
+ /**
5012
+ * Symbol of the fee token
5013
+ * @type {string}
5014
+ * @memberof OrdersMakerTakerFee
5015
+ */
5016
+ 'symbol'?: string;
5017
+ /**
5018
+ * Address of the ERC20 contract for the fee token
5019
+ * @type {string}
5020
+ * @memberof OrdersMakerTakerFee
5021
+ */
5022
+ 'token_address'?: string;
5023
+ /**
5024
+ * Type of the fee token (ETH/ERC20)
5025
+ * @type {string}
5026
+ * @memberof OrdersMakerTakerFee
5027
+ */
5028
+ 'token_type'?: string;
5029
+ }
5030
+
5031
+ /**
5032
+ * Immutable X API
5033
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5034
+ *
5035
+ * The version of the OpenAPI document: 3.0
5036
+ * Contact: support@immutable.com
5037
+ *
5038
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5039
+ * https://openapi-generator.tech
5040
+ * Do not edit the class manually.
5041
+ */
5042
+
5043
+ /**
5044
+ * @type OrderV3MakerFees
5045
+ * MakerFees is the information about the fees that needs to be paid by the maker (liquidity)
5046
+ * @export
5047
+ */
5048
+ declare type OrderV3MakerFees = OrdersMakerTakerFee;
5049
+
5050
+ /**
5051
+ * Immutable X API
5052
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5053
+ *
5054
+ * The version of the OpenAPI document: 3.0
5055
+ * Contact: support@immutable.com
5056
+ *
5057
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5058
+ * https://openapi-generator.tech
5059
+ * Do not edit the class manually.
5060
+ */
5061
+
5062
+ /**
5063
+ * @type OrderV3Sell
5064
+ * Details of the asset being sold
4168
5065
  * @export
4169
- * @interface ListMintsResponse
4170
5066
  */
4171
- interface ListMintsResponse {
4172
- /**
4173
- * Generated cursor returned by previous query
4174
- * @type {string}
4175
- * @memberof ListMintsResponse
4176
- */
4177
- 'cursor': string;
4178
- /**
4179
- * Remaining results flag. 1: there are remaining results matching this query, 0: no remaining results
4180
- * @type {number}
4181
- * @memberof ListMintsResponse
4182
- */
4183
- 'remaining': number;
4184
- /**
4185
- * Mints matching query parameters
4186
- * @type {Array<Mint>}
4187
- * @memberof ListMintsResponse
4188
- */
4189
- 'result': Array<Mint>;
4190
- }
5067
+ declare type OrderV3Sell = Token;
4191
5068
 
4192
5069
  /**
4193
5070
  * Immutable X API
@@ -4202,36 +5079,11 @@ interface ListMintsResponse {
4202
5079
  */
4203
5080
 
4204
5081
  /**
4205
- *
5082
+ * @type OrderV3TakerFees
5083
+ * TakerFees is the information about the fees that needs to be paid by the taker (liquidity)
4206
5084
  * @export
4207
- * @interface OrderFeeInfo
4208
5085
  */
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
- }
5086
+ declare type OrderV3TakerFees = OrdersMakerTakerFee;
4235
5087
 
4236
5088
  /**
4237
5089
  * Immutable X API
@@ -4248,67 +5100,85 @@ interface OrderFeeInfo {
4248
5100
  /**
4249
5101
  *
4250
5102
  * @export
4251
- * @interface Order
5103
+ * @interface OrderV3
4252
5104
  */
4253
- interface Order {
5105
+ interface OrderV3 {
4254
5106
  /**
4255
5107
  * Amount of the asset already sold by this order
4256
5108
  * @type {string}
4257
- * @memberof Order
5109
+ * @memberof OrderV3
4258
5110
  */
4259
5111
  'amount_sold': string | null;
4260
5112
  /**
4261
5113
  *
4262
- * @type {Token}
4263
- * @memberof Order
5114
+ * @type {OrderV3Buy}
5115
+ * @memberof OrderV3
4264
5116
  */
4265
- 'buy': Token;
5117
+ 'buy': OrderV3Buy;
4266
5118
  /**
4267
5119
  * Expiration timestamp of this order
4268
5120
  * @type {string}
4269
- * @memberof Order
5121
+ * @memberof OrderV3
4270
5122
  */
4271
5123
  'expiration_timestamp': string | null;
4272
5124
  /**
4273
5125
  * Fee information for the order
4274
5126
  * @type {Array<OrderFeeInfo>}
4275
- * @memberof Order
5127
+ * @memberof OrderV3
4276
5128
  */
4277
5129
  'fees'?: Array<OrderFeeInfo>;
5130
+ /**
5131
+ *
5132
+ * @type {OrderV3MakerFees}
5133
+ * @memberof OrderV3
5134
+ */
5135
+ 'maker_fees'?: OrderV3MakerFees;
5136
+ /**
5137
+ * MakerTakerType
5138
+ * @type {string}
5139
+ * @memberof OrderV3
5140
+ */
5141
+ 'maker_taker_type'?: string;
4278
5142
  /**
4279
5143
  * ID of the order
4280
5144
  * @type {number}
4281
- * @memberof Order
5145
+ * @memberof OrderV3
4282
5146
  */
4283
5147
  'order_id': number;
4284
5148
  /**
4285
5149
  *
4286
- * @type {Token}
4287
- * @memberof Order
5150
+ * @type {OrderV3Sell}
5151
+ * @memberof OrderV3
4288
5152
  */
4289
- 'sell': Token;
5153
+ 'sell': OrderV3Sell;
4290
5154
  /**
4291
5155
  * Status of the order
4292
5156
  * @type {string}
4293
- * @memberof Order
5157
+ * @memberof OrderV3
4294
5158
  */
4295
5159
  'status': string;
5160
+ /**
5161
+ *
5162
+ * @type {OrderV3TakerFees}
5163
+ * @memberof OrderV3
5164
+ */
5165
+ 'taker_fees'?: OrderV3TakerFees;
4296
5166
  /**
4297
5167
  * Timestamp this order was created
4298
5168
  * @type {string}
4299
- * @memberof Order
5169
+ * @memberof OrderV3
4300
5170
  */
4301
5171
  'timestamp': string | null;
4302
5172
  /**
4303
5173
  * Updated timestamp of this order
4304
5174
  * @type {string}
4305
- * @memberof Order
5175
+ * @memberof OrderV3
4306
5176
  */
4307
5177
  'updated_timestamp': string | null;
4308
5178
  /**
4309
5179
  * Ethereum address of the user who submitted the order
4310
5180
  * @type {string}
4311
- * @memberof Order
5181
+ * @memberof OrderV3
4312
5182
  */
4313
5183
  'user': string;
4314
5184
  }
@@ -4328,27 +5198,27 @@ interface Order {
4328
5198
  /**
4329
5199
  *
4330
5200
  * @export
4331
- * @interface ListOrdersResponse
5201
+ * @interface ListOrdersResponseV3
4332
5202
  */
4333
- interface ListOrdersResponse {
5203
+ interface ListOrdersResponseV3 {
4334
5204
  /**
4335
5205
  * Generated cursor returned by previous query
4336
5206
  * @type {string}
4337
- * @memberof ListOrdersResponse
5207
+ * @memberof ListOrdersResponseV3
4338
5208
  */
4339
5209
  'cursor': string;
4340
5210
  /**
4341
5211
  * Remaining results flag. 1: there are remaining results matching this query, 0: no remaining results
4342
5212
  * @type {number}
4343
- * @memberof ListOrdersResponse
5213
+ * @memberof ListOrdersResponseV3
4344
5214
  */
4345
5215
  'remaining': number;
4346
5216
  /**
4347
5217
  * Orders matching query parameters
4348
- * @type {Array<Order>}
4349
- * @memberof ListOrdersResponse
5218
+ * @type {Array<OrderV3>}
5219
+ * @memberof ListOrdersResponseV3
4350
5220
  */
4351
- 'result': Array<Order>;
5221
+ 'result': Array<OrderV3>;
4352
5222
  }
4353
5223
 
4354
5224
  /**
@@ -4487,6 +5357,44 @@ interface TradeSide {
4487
5357
  'token_type': string;
4488
5358
  }
4489
5359
 
5360
+ /**
5361
+ * Immutable X API
5362
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5363
+ *
5364
+ * The version of the OpenAPI document: 3.0
5365
+ * Contact: support@immutable.com
5366
+ *
5367
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5368
+ * https://openapi-generator.tech
5369
+ * Do not edit the class manually.
5370
+ */
5371
+
5372
+ /**
5373
+ * @type TradeA
5374
+ * Side A of this trade (the buy order)
5375
+ * @export
5376
+ */
5377
+ declare type TradeA = TradeSide;
5378
+
5379
+ /**
5380
+ * Immutable X API
5381
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5382
+ *
5383
+ * The version of the OpenAPI document: 3.0
5384
+ * Contact: support@immutable.com
5385
+ *
5386
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5387
+ * https://openapi-generator.tech
5388
+ * Do not edit the class manually.
5389
+ */
5390
+
5391
+ /**
5392
+ * @type TradeB
5393
+ * Side B of this trade (the sell order)
5394
+ * @export
5395
+ */
5396
+ declare type TradeB = TradeSide;
5397
+
4490
5398
  /**
4491
5399
  * Immutable X API
4492
5400
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -4507,16 +5415,16 @@ interface TradeSide {
4507
5415
  interface Trade {
4508
5416
  /**
4509
5417
  *
4510
- * @type {TradeSide}
5418
+ * @type {TradeA}
4511
5419
  * @memberof Trade
4512
5420
  */
4513
- 'a': TradeSide;
5421
+ 'a': TradeA;
4514
5422
  /**
4515
5423
  *
4516
- * @type {TradeSide}
5424
+ * @type {TradeB}
4517
5425
  * @memberof Trade
4518
5426
  */
4519
- 'b': TradeSide;
5427
+ 'b': TradeB;
4520
5428
  /**
4521
5429
  * Status of this trade
4522
5430
  * @type {string}
@@ -5524,6 +6432,129 @@ interface SuccessResponse {
5524
6432
  'result': string;
5525
6433
  }
5526
6434
 
6435
+ /**
6436
+ * Immutable X API
6437
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6438
+ *
6439
+ * The version of the OpenAPI document: 3.0
6440
+ * Contact: support@immutable.com
6441
+ *
6442
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6443
+ * https://openapi-generator.tech
6444
+ * Do not edit the class manually.
6445
+ */
6446
+
6447
+ /**
6448
+ * @type TradesCreateTradeRequestFeeInfo
6449
+ * Fee details
6450
+ * @export
6451
+ */
6452
+ declare type TradesCreateTradeRequestFeeInfo = FeeInfo;
6453
+
6454
+ /**
6455
+ * Immutable X API
6456
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6457
+ *
6458
+ * The version of the OpenAPI document: 3.0
6459
+ * Contact: support@immutable.com
6460
+ *
6461
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6462
+ * https://openapi-generator.tech
6463
+ * Do not edit the class manually.
6464
+ */
6465
+
6466
+ /**
6467
+ *
6468
+ * @export
6469
+ * @interface TradesCreateTradeRequest
6470
+ */
6471
+ interface TradesCreateTradeRequest {
6472
+ /**
6473
+ * Amount to buy
6474
+ * @type {string}
6475
+ * @memberof TradesCreateTradeRequest
6476
+ */
6477
+ 'amount_buy': string;
6478
+ /**
6479
+ * Amount to sell
6480
+ * @type {string}
6481
+ * @memberof TradesCreateTradeRequest
6482
+ */
6483
+ 'amount_sell': string;
6484
+ /**
6485
+ * ID of the asset to buy
6486
+ * @type {string}
6487
+ * @memberof TradesCreateTradeRequest
6488
+ */
6489
+ 'asset_id_buy': string;
6490
+ /**
6491
+ * ID of the asset to sell
6492
+ * @type {string}
6493
+ * @memberof TradesCreateTradeRequest
6494
+ */
6495
+ 'asset_id_sell': string;
6496
+ /**
6497
+ * Expiration timestamp for this trade
6498
+ * @type {number}
6499
+ * @memberof TradesCreateTradeRequest
6500
+ */
6501
+ 'expiration_timestamp': number;
6502
+ /**
6503
+ *
6504
+ * @type {TradesCreateTradeRequestFeeInfo}
6505
+ * @memberof TradesCreateTradeRequest
6506
+ */
6507
+ 'fee_info'?: TradesCreateTradeRequestFeeInfo;
6508
+ /**
6509
+ * Fee information
6510
+ * @type {Array<FeeEntry>}
6511
+ * @memberof TradesCreateTradeRequest
6512
+ */
6513
+ 'fees'?: Array<FeeEntry>;
6514
+ /**
6515
+ * [deprecated] All orders include fees since the introduction of protocol fees
6516
+ * @type {boolean}
6517
+ * @memberof TradesCreateTradeRequest
6518
+ */
6519
+ 'include_fees'?: boolean;
6520
+ /**
6521
+ * Nonce of the trade
6522
+ * @type {number}
6523
+ * @memberof TradesCreateTradeRequest
6524
+ */
6525
+ 'nonce': number;
6526
+ /**
6527
+ * ID of the order
6528
+ * @type {number}
6529
+ * @memberof TradesCreateTradeRequest
6530
+ */
6531
+ 'order_id': number;
6532
+ /**
6533
+ * Public stark key of the user creating trade
6534
+ * @type {string}
6535
+ * @memberof TradesCreateTradeRequest
6536
+ */
6537
+ 'stark_key': string;
6538
+ /**
6539
+ * Payload signature
6540
+ * @type {string}
6541
+ * @memberof TradesCreateTradeRequest
6542
+ */
6543
+ 'stark_signature': string;
6544
+ /**
6545
+ * ID of the vault into which the traded asset will be placed
6546
+ * @type {number}
6547
+ * @memberof TradesCreateTradeRequest
6548
+ */
6549
+ 'vault_id_buy': number;
6550
+ /**
6551
+ * ID of the vault to sell from
6552
+ * @type {number}
6553
+ * @memberof TradesCreateTradeRequest
6554
+ */
6555
+ 'vault_id_sell': number;
6556
+ }
6557
+
5527
6558
  /**
5528
6559
  * Immutable X API
5529
6560
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -5739,7 +6770,7 @@ interface BalancesApiGetBalanceRequest {
5739
6770
  */
5740
6771
  readonly owner: string;
5741
6772
  /**
5742
- * Token address
6773
+ * Token address or \&#39;eth\&#39;
5743
6774
  * @type {string}
5744
6775
  * @memberof BalancesApiGetBalance
5745
6776
  */
@@ -7027,51 +8058,88 @@ declare class NftCheckoutPrimaryApi extends BaseAPI {
7027
8058
  * @throws {RequiredError}
7028
8059
  * @memberof NftCheckoutPrimaryApi
7029
8060
  */
7030
- getNftPrimaryTransactions(requestParameters?: NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<NftprimarytransactionListTransactionsResponse, any>>;
8061
+ getNftPrimaryTransactions(requestParameters?: NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<NftprimarytransactionListTransactionsResponse, any>>;
8062
+ /**
8063
+ * Registers a new contract for use in the minting with fiat card flow
8064
+ * @summary Executes NFT primary sales contract registration
8065
+ * @param {NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest} requestParameters Request parameters.
8066
+ * @param {*} [options] Override http request option.
8067
+ * @throws {RequiredError}
8068
+ * @memberof NftCheckoutPrimaryApi
8069
+ */
8070
+ registerNftPrimarySalesContract(requestParameters: NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ContractCreateResponse, any>>;
8071
+ }
8072
+ /**
8073
+ * Request parameters for cancelOrder operation in OrdersApi.
8074
+ * @export
8075
+ * @interface OrdersApiCancelOrderRequest
8076
+ */
8077
+ interface OrdersApiCancelOrderRequest {
8078
+ /**
8079
+ * Order ID to cancel
8080
+ * @type {string}
8081
+ * @memberof OrdersApiCancelOrder
8082
+ */
8083
+ readonly id: string;
8084
+ /**
8085
+ * cancel an order
8086
+ * @type {CancelOrderRequest}
8087
+ * @memberof OrdersApiCancelOrder
8088
+ */
8089
+ readonly cancelOrderRequest: CancelOrderRequest;
8090
+ /**
8091
+ * eth address
8092
+ * @type {string}
8093
+ * @memberof OrdersApiCancelOrder
8094
+ */
8095
+ readonly xImxEthAddress?: string;
8096
+ /**
8097
+ * eth signature
8098
+ * @type {string}
8099
+ * @memberof OrdersApiCancelOrder
8100
+ */
8101
+ readonly xImxEthSignature?: string;
7031
8102
  /**
7032
- * Registers a new contract for use in the minting with fiat card flow
7033
- * @summary Executes NFT primary sales contract registration
7034
- * @param {NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest} requestParameters Request parameters.
7035
- * @param {*} [options] Override http request option.
7036
- * @throws {RequiredError}
7037
- * @memberof NftCheckoutPrimaryApi
8103
+ * Authorization header
8104
+ * @type {string}
8105
+ * @memberof OrdersApiCancelOrder
7038
8106
  */
7039
- registerNftPrimarySalesContract(requestParameters: NftCheckoutPrimaryApiRegisterNftPrimarySalesContractRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ContractCreateResponse, any>>;
8107
+ readonly authorization?: string;
7040
8108
  }
7041
8109
  /**
7042
- * Request parameters for cancelOrder operation in OrdersApi.
8110
+ * Request parameters for cancelOrderV3 operation in OrdersApi.
7043
8111
  * @export
7044
- * @interface OrdersApiCancelOrderRequest
8112
+ * @interface OrdersApiCancelOrderV3Request
7045
8113
  */
7046
- interface OrdersApiCancelOrderRequest {
8114
+ interface OrdersApiCancelOrderV3Request {
7047
8115
  /**
7048
8116
  * Order ID to cancel
7049
8117
  * @type {string}
7050
- * @memberof OrdersApiCancelOrder
8118
+ * @memberof OrdersApiCancelOrderV3
7051
8119
  */
7052
8120
  readonly id: string;
7053
8121
  /**
7054
8122
  * cancel an order
7055
8123
  * @type {CancelOrderRequest}
7056
- * @memberof OrdersApiCancelOrder
8124
+ * @memberof OrdersApiCancelOrderV3
7057
8125
  */
7058
8126
  readonly cancelOrderRequest: CancelOrderRequest;
7059
8127
  /**
7060
8128
  * eth address
7061
8129
  * @type {string}
7062
- * @memberof OrdersApiCancelOrder
8130
+ * @memberof OrdersApiCancelOrderV3
7063
8131
  */
7064
8132
  readonly xImxEthAddress?: string;
7065
8133
  /**
7066
8134
  * eth signature
7067
8135
  * @type {string}
7068
- * @memberof OrdersApiCancelOrder
8136
+ * @memberof OrdersApiCancelOrderV3
7069
8137
  */
7070
8138
  readonly xImxEthSignature?: string;
7071
8139
  /**
7072
8140
  * Authorization header
7073
8141
  * @type {string}
7074
- * @memberof OrdersApiCancelOrder
8142
+ * @memberof OrdersApiCancelOrderV3
7075
8143
  */
7076
8144
  readonly authorization?: string;
7077
8145
  }
@@ -7106,6 +8174,37 @@ interface OrdersApiCreateOrderRequest {
7106
8174
  */
7107
8175
  readonly authorization?: string;
7108
8176
  }
8177
+ /**
8178
+ * Request parameters for createOrderV3 operation in OrdersApi.
8179
+ * @export
8180
+ * @interface OrdersApiCreateOrderV3Request
8181
+ */
8182
+ interface OrdersApiCreateOrderV3Request {
8183
+ /**
8184
+ * create an order
8185
+ * @type {CreateOrderRequestV3}
8186
+ * @memberof OrdersApiCreateOrderV3
8187
+ */
8188
+ readonly createOrderRequest: CreateOrderRequestV3;
8189
+ /**
8190
+ * eth address
8191
+ * @type {string}
8192
+ * @memberof OrdersApiCreateOrderV3
8193
+ */
8194
+ readonly xImxEthAddress?: string;
8195
+ /**
8196
+ * eth signature
8197
+ * @type {string}
8198
+ * @memberof OrdersApiCreateOrderV3
8199
+ */
8200
+ readonly xImxEthSignature?: string;
8201
+ /**
8202
+ * Authorization header
8203
+ * @type {string}
8204
+ * @memberof OrdersApiCreateOrderV3
8205
+ */
8206
+ readonly authorization?: string;
8207
+ }
7109
8208
  /**
7110
8209
  * Request parameters for getOrder operation in OrdersApi.
7111
8210
  * @export
@@ -7137,6 +8236,37 @@ interface OrdersApiGetOrderRequest {
7137
8236
  */
7138
8237
  readonly auxiliaryFeeRecipients?: string;
7139
8238
  }
8239
+ /**
8240
+ * Request parameters for getOrderV3 operation in OrdersApi.
8241
+ * @export
8242
+ * @interface OrdersApiGetOrderV3Request
8243
+ */
8244
+ interface OrdersApiGetOrderV3Request {
8245
+ /**
8246
+ * Order ID
8247
+ * @type {string}
8248
+ * @memberof OrdersApiGetOrderV3
8249
+ */
8250
+ readonly id: string;
8251
+ /**
8252
+ * Set flag to true to include fee body for the order
8253
+ * @type {boolean}
8254
+ * @memberof OrdersApiGetOrderV3
8255
+ */
8256
+ readonly includeFees?: boolean;
8257
+ /**
8258
+ * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
8259
+ * @type {string}
8260
+ * @memberof OrdersApiGetOrderV3
8261
+ */
8262
+ readonly auxiliaryFeePercentages?: string;
8263
+ /**
8264
+ * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
8265
+ * @type {string}
8266
+ * @memberof OrdersApiGetOrderV3
8267
+ */
8268
+ readonly auxiliaryFeeRecipients?: string;
8269
+ }
7140
8270
  /**
7141
8271
  * Request parameters for getSignableCancelOrder operation in OrdersApi.
7142
8272
  * @export
@@ -7150,6 +8280,19 @@ interface OrdersApiGetSignableCancelOrderRequest {
7150
8280
  */
7151
8281
  readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
7152
8282
  }
8283
+ /**
8284
+ * Request parameters for getSignableCancelOrderV3 operation in OrdersApi.
8285
+ * @export
8286
+ * @interface OrdersApiGetSignableCancelOrderV3Request
8287
+ */
8288
+ interface OrdersApiGetSignableCancelOrderV3Request {
8289
+ /**
8290
+ * get a signable cancel order
8291
+ * @type {GetSignableCancelOrderRequest}
8292
+ * @memberof OrdersApiGetSignableCancelOrderV3
8293
+ */
8294
+ readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
8295
+ }
7153
8296
  /**
7154
8297
  * Request parameters for getSignableOrder operation in OrdersApi.
7155
8298
  * @export
@@ -7157,190 +8300,371 @@ interface OrdersApiGetSignableCancelOrderRequest {
7157
8300
  */
7158
8301
  interface OrdersApiGetSignableOrderRequest {
7159
8302
  /**
7160
- * get a signable order
7161
- * @type {GetSignableOrderRequest}
8303
+ * get a signable order v3
8304
+ * @type {GetSignableOrderRequestV3}
7162
8305
  * @memberof OrdersApiGetSignableOrder
7163
8306
  */
7164
- readonly getSignableOrderRequestV3: GetSignableOrderRequest;
8307
+ readonly getSignableOrderRequestV3: GetSignableOrderRequestV3;
7165
8308
  }
7166
8309
  /**
7167
8310
  * Request parameters for listOrders operation in OrdersApi.
7168
8311
  * @export
7169
8312
  * @interface OrdersApiListOrdersRequest
7170
8313
  */
7171
- interface OrdersApiListOrdersRequest {
8314
+ interface OrdersApiListOrdersRequest {
8315
+ /**
8316
+ * Page size of the result
8317
+ * @type {number}
8318
+ * @memberof OrdersApiListOrders
8319
+ */
8320
+ readonly pageSize?: number;
8321
+ /**
8322
+ * Cursor
8323
+ * @type {string}
8324
+ * @memberof OrdersApiListOrders
8325
+ */
8326
+ readonly cursor?: string;
8327
+ /**
8328
+ * Property to sort by
8329
+ * @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
8330
+ * @memberof OrdersApiListOrders
8331
+ */
8332
+ readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
8333
+ /**
8334
+ * Direction to sort (asc/desc)
8335
+ * @type {string}
8336
+ * @memberof OrdersApiListOrders
8337
+ */
8338
+ readonly direction?: string;
8339
+ /**
8340
+ * Ethereum address of the user who submitted this order
8341
+ * @type {string}
8342
+ * @memberof OrdersApiListOrders
8343
+ */
8344
+ readonly user?: string;
8345
+ /**
8346
+ * Status of this order
8347
+ * @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
8348
+ * @memberof OrdersApiListOrders
8349
+ */
8350
+ readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
8351
+ /**
8352
+ * 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;
8353
+ * @type {string}
8354
+ * @memberof OrdersApiListOrders
8355
+ */
8356
+ readonly minTimestamp?: string;
8357
+ /**
8358
+ * 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;
8359
+ * @type {string}
8360
+ * @memberof OrdersApiListOrders
8361
+ */
8362
+ readonly maxTimestamp?: string;
8363
+ /**
8364
+ * 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;
8365
+ * @type {string}
8366
+ * @memberof OrdersApiListOrders
8367
+ */
8368
+ readonly updatedMinTimestamp?: string;
8369
+ /**
8370
+ * 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;
8371
+ * @type {string}
8372
+ * @memberof OrdersApiListOrders
8373
+ */
8374
+ readonly updatedMaxTimestamp?: string;
8375
+ /**
8376
+ * Token type of the asset this order buys
8377
+ * @type {string}
8378
+ * @memberof OrdersApiListOrders
8379
+ */
8380
+ readonly buyTokenType?: string;
8381
+ /**
8382
+ * ERC721 Token ID of the asset this order buys
8383
+ * @type {string}
8384
+ * @memberof OrdersApiListOrders
8385
+ */
8386
+ readonly buyTokenId?: string;
8387
+ /**
8388
+ * Internal IMX ID of the asset this order buys
8389
+ * @type {string}
8390
+ * @memberof OrdersApiListOrders
8391
+ */
8392
+ readonly buyAssetId?: string;
8393
+ /**
8394
+ * Token address of the asset this order buys
8395
+ * @type {string}
8396
+ * @memberof OrdersApiListOrders
8397
+ */
8398
+ readonly buyTokenAddress?: string;
8399
+ /**
8400
+ * Token name of the asset this order buys
8401
+ * @type {string}
8402
+ * @memberof OrdersApiListOrders
8403
+ */
8404
+ readonly buyTokenName?: string;
8405
+ /**
8406
+ * Min quantity for the asset this order buys
8407
+ * @type {string}
8408
+ * @memberof OrdersApiListOrders
8409
+ */
8410
+ readonly buyMinQuantity?: string;
8411
+ /**
8412
+ * Max quantity for the asset this order buys
8413
+ * @type {string}
8414
+ * @memberof OrdersApiListOrders
8415
+ */
8416
+ readonly buyMaxQuantity?: string;
8417
+ /**
8418
+ * JSON-encoded metadata filters for the asset this order buys
8419
+ * @type {string}
8420
+ * @memberof OrdersApiListOrders
8421
+ */
8422
+ readonly buyMetadata?: string;
8423
+ /**
8424
+ * Token type of the asset this order sells
8425
+ * @type {string}
8426
+ * @memberof OrdersApiListOrders
8427
+ */
8428
+ readonly sellTokenType?: string;
8429
+ /**
8430
+ * ERC721 Token ID of the asset this order sells
8431
+ * @type {string}
8432
+ * @memberof OrdersApiListOrders
8433
+ */
8434
+ readonly sellTokenId?: string;
8435
+ /**
8436
+ * Internal IMX ID of the asset this order sells
8437
+ * @type {string}
8438
+ * @memberof OrdersApiListOrders
8439
+ */
8440
+ readonly sellAssetId?: string;
8441
+ /**
8442
+ * Token address of the asset this order sells
8443
+ * @type {string}
8444
+ * @memberof OrdersApiListOrders
8445
+ */
8446
+ readonly sellTokenAddress?: string;
8447
+ /**
8448
+ * Token name of the asset this order sells
8449
+ * @type {string}
8450
+ * @memberof OrdersApiListOrders
8451
+ */
8452
+ readonly sellTokenName?: string;
8453
+ /**
8454
+ * Min quantity for the asset this order sells
8455
+ * @type {string}
8456
+ * @memberof OrdersApiListOrders
8457
+ */
8458
+ readonly sellMinQuantity?: string;
8459
+ /**
8460
+ * Max quantity for the asset this order sells
8461
+ * @type {string}
8462
+ * @memberof OrdersApiListOrders
8463
+ */
8464
+ readonly sellMaxQuantity?: string;
8465
+ /**
8466
+ * JSON-encoded metadata filters for the asset this order sells
8467
+ * @type {string}
8468
+ * @memberof OrdersApiListOrders
8469
+ */
8470
+ readonly sellMetadata?: string;
8471
+ /**
8472
+ * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
8473
+ * @type {string}
8474
+ * @memberof OrdersApiListOrders
8475
+ */
8476
+ readonly auxiliaryFeePercentages?: string;
8477
+ /**
8478
+ * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
8479
+ * @type {string}
8480
+ * @memberof OrdersApiListOrders
8481
+ */
8482
+ readonly auxiliaryFeeRecipients?: string;
8483
+ /**
8484
+ * Set flag to true to include fee object for orders
8485
+ * @type {boolean}
8486
+ * @memberof OrdersApiListOrders
8487
+ */
8488
+ readonly includeFees?: boolean;
8489
+ }
8490
+ /**
8491
+ * Request parameters for listOrdersV3 operation in OrdersApi.
8492
+ * @export
8493
+ * @interface OrdersApiListOrdersV3Request
8494
+ */
8495
+ interface OrdersApiListOrdersV3Request {
7172
8496
  /**
7173
8497
  * Page size of the result
7174
8498
  * @type {number}
7175
- * @memberof OrdersApiListOrders
8499
+ * @memberof OrdersApiListOrdersV3
7176
8500
  */
7177
8501
  readonly pageSize?: number;
7178
8502
  /**
7179
8503
  * Cursor
7180
8504
  * @type {string}
7181
- * @memberof OrdersApiListOrders
8505
+ * @memberof OrdersApiListOrdersV3
7182
8506
  */
7183
8507
  readonly cursor?: string;
7184
8508
  /**
7185
8509
  * Property to sort by
7186
8510
  * @type {'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at'}
7187
- * @memberof OrdersApiListOrders
8511
+ * @memberof OrdersApiListOrdersV3
7188
8512
  */
7189
8513
  readonly orderBy?: 'created_at' | 'expired_at' | 'sell_quantity' | 'buy_quantity' | 'buy_quantity_with_fees' | 'updated_at';
7190
8514
  /**
7191
8515
  * Direction to sort (asc/desc)
7192
8516
  * @type {string}
7193
- * @memberof OrdersApiListOrders
8517
+ * @memberof OrdersApiListOrdersV3
7194
8518
  */
7195
8519
  readonly direction?: string;
7196
8520
  /**
7197
8521
  * Ethereum address of the user who submitted this order
7198
8522
  * @type {string}
7199
- * @memberof OrdersApiListOrders
8523
+ * @memberof OrdersApiListOrdersV3
7200
8524
  */
7201
8525
  readonly user?: string;
7202
8526
  /**
7203
8527
  * Status of this order
7204
8528
  * @type {'active' | 'filled' | 'cancelled' | 'expired' | 'inactive'}
7205
- * @memberof OrdersApiListOrders
8529
+ * @memberof OrdersApiListOrdersV3
7206
8530
  */
7207
8531
  readonly status?: 'active' | 'filled' | 'cancelled' | 'expired' | 'inactive';
7208
8532
  /**
7209
- * Minimum created at timestamp for this order, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
8533
+ * 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
8534
  * @type {string}
7211
- * @memberof OrdersApiListOrders
8535
+ * @memberof OrdersApiListOrdersV3
7212
8536
  */
7213
8537
  readonly minTimestamp?: string;
7214
8538
  /**
7215
- * Maximum created at timestamp for this order, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
8539
+ * 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
8540
  * @type {string}
7217
- * @memberof OrdersApiListOrders
8541
+ * @memberof OrdersApiListOrdersV3
7218
8542
  */
7219
8543
  readonly maxTimestamp?: string;
7220
8544
  /**
7221
- * Minimum updated at timestamp for this order, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
8545
+ * 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
8546
  * @type {string}
7223
- * @memberof OrdersApiListOrders
8547
+ * @memberof OrdersApiListOrdersV3
7224
8548
  */
7225
8549
  readonly updatedMinTimestamp?: string;
7226
8550
  /**
7227
- * Maximum updated at timestamp for this order, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
8551
+ * 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
8552
  * @type {string}
7229
- * @memberof OrdersApiListOrders
8553
+ * @memberof OrdersApiListOrdersV3
7230
8554
  */
7231
8555
  readonly updatedMaxTimestamp?: string;
7232
8556
  /**
7233
8557
  * Token type of the asset this order buys
7234
8558
  * @type {string}
7235
- * @memberof OrdersApiListOrders
8559
+ * @memberof OrdersApiListOrdersV3
7236
8560
  */
7237
8561
  readonly buyTokenType?: string;
7238
8562
  /**
7239
8563
  * ERC721 Token ID of the asset this order buys
7240
8564
  * @type {string}
7241
- * @memberof OrdersApiListOrders
8565
+ * @memberof OrdersApiListOrdersV3
7242
8566
  */
7243
8567
  readonly buyTokenId?: string;
7244
8568
  /**
7245
8569
  * Internal IMX ID of the asset this order buys
7246
8570
  * @type {string}
7247
- * @memberof OrdersApiListOrders
8571
+ * @memberof OrdersApiListOrdersV3
7248
8572
  */
7249
8573
  readonly buyAssetId?: string;
7250
8574
  /**
7251
8575
  * Token address of the asset this order buys
7252
8576
  * @type {string}
7253
- * @memberof OrdersApiListOrders
8577
+ * @memberof OrdersApiListOrdersV3
7254
8578
  */
7255
8579
  readonly buyTokenAddress?: string;
7256
8580
  /**
7257
8581
  * Token name of the asset this order buys
7258
8582
  * @type {string}
7259
- * @memberof OrdersApiListOrders
8583
+ * @memberof OrdersApiListOrdersV3
7260
8584
  */
7261
8585
  readonly buyTokenName?: string;
7262
8586
  /**
7263
8587
  * Min quantity for the asset this order buys
7264
8588
  * @type {string}
7265
- * @memberof OrdersApiListOrders
8589
+ * @memberof OrdersApiListOrdersV3
7266
8590
  */
7267
8591
  readonly buyMinQuantity?: string;
7268
8592
  /**
7269
8593
  * Max quantity for the asset this order buys
7270
8594
  * @type {string}
7271
- * @memberof OrdersApiListOrders
8595
+ * @memberof OrdersApiListOrdersV3
7272
8596
  */
7273
8597
  readonly buyMaxQuantity?: string;
7274
8598
  /**
7275
8599
  * JSON-encoded metadata filters for the asset this order buys
7276
8600
  * @type {string}
7277
- * @memberof OrdersApiListOrders
8601
+ * @memberof OrdersApiListOrdersV3
7278
8602
  */
7279
8603
  readonly buyMetadata?: string;
7280
8604
  /**
7281
8605
  * Token type of the asset this order sells
7282
8606
  * @type {string}
7283
- * @memberof OrdersApiListOrders
8607
+ * @memberof OrdersApiListOrdersV3
7284
8608
  */
7285
8609
  readonly sellTokenType?: string;
7286
8610
  /**
7287
8611
  * ERC721 Token ID of the asset this order sells
7288
8612
  * @type {string}
7289
- * @memberof OrdersApiListOrders
8613
+ * @memberof OrdersApiListOrdersV3
7290
8614
  */
7291
8615
  readonly sellTokenId?: string;
7292
8616
  /**
7293
8617
  * Internal IMX ID of the asset this order sells
7294
8618
  * @type {string}
7295
- * @memberof OrdersApiListOrders
8619
+ * @memberof OrdersApiListOrdersV3
7296
8620
  */
7297
8621
  readonly sellAssetId?: string;
7298
8622
  /**
7299
8623
  * Token address of the asset this order sells
7300
8624
  * @type {string}
7301
- * @memberof OrdersApiListOrders
8625
+ * @memberof OrdersApiListOrdersV3
7302
8626
  */
7303
8627
  readonly sellTokenAddress?: string;
7304
8628
  /**
7305
8629
  * Token name of the asset this order sells
7306
8630
  * @type {string}
7307
- * @memberof OrdersApiListOrders
8631
+ * @memberof OrdersApiListOrdersV3
7308
8632
  */
7309
8633
  readonly sellTokenName?: string;
7310
8634
  /**
7311
8635
  * Min quantity for the asset this order sells
7312
8636
  * @type {string}
7313
- * @memberof OrdersApiListOrders
8637
+ * @memberof OrdersApiListOrdersV3
7314
8638
  */
7315
8639
  readonly sellMinQuantity?: string;
7316
8640
  /**
7317
8641
  * Max quantity for the asset this order sells
7318
8642
  * @type {string}
7319
- * @memberof OrdersApiListOrders
8643
+ * @memberof OrdersApiListOrdersV3
7320
8644
  */
7321
8645
  readonly sellMaxQuantity?: string;
7322
8646
  /**
7323
8647
  * JSON-encoded metadata filters for the asset this order sells
7324
8648
  * @type {string}
7325
- * @memberof OrdersApiListOrders
8649
+ * @memberof OrdersApiListOrdersV3
7326
8650
  */
7327
8651
  readonly sellMetadata?: string;
7328
8652
  /**
7329
8653
  * Comma separated string of fee percentages that are to be paired with auxiliary_fee_recipients
7330
8654
  * @type {string}
7331
- * @memberof OrdersApiListOrders
8655
+ * @memberof OrdersApiListOrdersV3
7332
8656
  */
7333
8657
  readonly auxiliaryFeePercentages?: string;
7334
8658
  /**
7335
8659
  * Comma separated string of fee recipients that are to be paired with auxiliary_fee_percentages
7336
8660
  * @type {string}
7337
- * @memberof OrdersApiListOrders
8661
+ * @memberof OrdersApiListOrdersV3
7338
8662
  */
7339
8663
  readonly auxiliaryFeeRecipients?: string;
7340
8664
  /**
7341
8665
  * Set flag to true to include fee object for orders
7342
8666
  * @type {boolean}
7343
- * @memberof OrdersApiListOrders
8667
+ * @memberof OrdersApiListOrdersV3
7344
8668
  */
7345
8669
  readonly includeFees?: boolean;
7346
8670
  }
@@ -7352,7 +8676,7 @@ interface OrdersApiListOrdersRequest {
7352
8676
  */
7353
8677
  declare class OrdersApi extends BaseAPI {
7354
8678
  /**
7355
- * Cancel an order
8679
+ * Cancel an order. Use https://docs.x.immutable.com/reference#/operations/getSignableCancelOrder to get request body params.
7356
8680
  * @summary Cancel an order
7357
8681
  * @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
7358
8682
  * @param {*} [options] Override http request option.
@@ -7361,7 +8685,16 @@ declare class OrdersApi extends BaseAPI {
7361
8685
  */
7362
8686
  cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
7363
8687
  /**
7364
- * Create an order
8688
+ * Cancel an order (V3)
8689
+ * @summary Cancel an order (V3)
8690
+ * @param {OrdersApiCancelOrderV3Request} requestParameters Request parameters.
8691
+ * @param {*} [options] Override http request option.
8692
+ * @throws {RequiredError}
8693
+ * @memberof OrdersApi
8694
+ */
8695
+ cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
8696
+ /**
8697
+ * Create an order. Use https://docs.x.immutable.com/reference#/operations/getSignableOrder to get request body params.
7365
8698
  * @summary Create an order
7366
8699
  * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
7367
8700
  * @param {*} [options] Override http request option.
@@ -7370,14 +8703,32 @@ declare class OrdersApi extends BaseAPI {
7370
8703
  */
7371
8704
  createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
7372
8705
  /**
7373
- * Get details of an order with the given ID
7374
- * @summary Get details of an order with the given ID
8706
+ * Create an order using the v3 orderbook. Currently only buy NFT orders are supported.
8707
+ * @summary Create an order (V3)
8708
+ * @param {OrdersApiCreateOrderV3Request} requestParameters Request parameters.
8709
+ * @param {*} [options] Override http request option.
8710
+ * @throws {RequiredError}
8711
+ * @memberof OrdersApi
8712
+ */
8713
+ createOrderV3(requestParameters: OrdersApiCreateOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
8714
+ /**
8715
+ * Get an order
8716
+ * @summary Get an order
7375
8717
  * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
7376
8718
  * @param {*} [options] Override http request option.
7377
8719
  * @throws {RequiredError}
7378
8720
  * @memberof OrdersApi
7379
8721
  */
7380
8722
  getOrder(requestParameters: OrdersApiGetOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Order, any>>;
8723
+ /**
8724
+ * Get an order (V3)
8725
+ * @summary Get an order (V3)
8726
+ * @param {OrdersApiGetOrderV3Request} requestParameters Request parameters.
8727
+ * @param {*} [options] Override http request option.
8728
+ * @throws {RequiredError}
8729
+ * @memberof OrdersApi
8730
+ */
8731
+ getOrderV3(requestParameters: OrdersApiGetOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<OrderV3, any>>;
7381
8732
  /**
7382
8733
  * Get a signable cancel order message
7383
8734
  * @summary Get a signable cancel order message
@@ -7387,6 +8738,15 @@ declare class OrdersApi extends BaseAPI {
7387
8738
  * @memberof OrdersApi
7388
8739
  */
7389
8740
  getSignableCancelOrder(requestParameters: OrdersApiGetSignableCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
8741
+ /**
8742
+ * Get a signable cancel order message (V3)
8743
+ * @summary Get a signable cancel order message (V3)
8744
+ * @param {OrdersApiGetSignableCancelOrderV3Request} requestParameters Request parameters.
8745
+ * @param {*} [options] Override http request option.
8746
+ * @throws {RequiredError}
8747
+ * @memberof OrdersApi
8748
+ */
8749
+ getSignableCancelOrderV3(requestParameters: OrdersApiGetSignableCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
7390
8750
  /**
7391
8751
  * Get a signable order request (V3)
7392
8752
  * @summary Get a signable order request (V3)
@@ -7405,6 +8765,15 @@ declare class OrdersApi extends BaseAPI {
7405
8765
  * @memberof OrdersApi
7406
8766
  */
7407
8767
  listOrders(requestParameters?: OrdersApiListOrdersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponse, any>>;
8768
+ /**
8769
+ * Get a list of orders (V3)
8770
+ * @summary Get a list of orders (V3)
8771
+ * @param {OrdersApiListOrdersV3Request} requestParameters Request parameters.
8772
+ * @param {*} [options] Override http request option.
8773
+ * @throws {RequiredError}
8774
+ * @memberof OrdersApi
8775
+ */
8776
+ listOrdersV3(requestParameters?: OrdersApiListOrdersV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<ListOrdersResponseV3, any>>;
7408
8777
  }
7409
8778
  /**
7410
8779
  * Request parameters for createProject operation in ProjectsApi.
@@ -7647,6 +9016,37 @@ interface TradesApiCreateTradeRequest {
7647
9016
  */
7648
9017
  readonly authorization?: string;
7649
9018
  }
9019
+ /**
9020
+ * Request parameters for createTradeV3 operation in TradesApi.
9021
+ * @export
9022
+ * @interface TradesApiCreateTradeV3Request
9023
+ */
9024
+ interface TradesApiCreateTradeV3Request {
9025
+ /**
9026
+ * create a trade
9027
+ * @type {TradesCreateTradeRequest}
9028
+ * @memberof TradesApiCreateTradeV3
9029
+ */
9030
+ readonly createTradeRequest: TradesCreateTradeRequest;
9031
+ /**
9032
+ * eth address
9033
+ * @type {string}
9034
+ * @memberof TradesApiCreateTradeV3
9035
+ */
9036
+ readonly xImxEthAddress?: string;
9037
+ /**
9038
+ * eth signature
9039
+ * @type {string}
9040
+ * @memberof TradesApiCreateTradeV3
9041
+ */
9042
+ readonly xImxEthSignature?: string;
9043
+ /**
9044
+ * Authorization header
9045
+ * @type {string}
9046
+ * @memberof TradesApiCreateTradeV3
9047
+ */
9048
+ readonly authorization?: string;
9049
+ }
7650
9050
  /**
7651
9051
  * Request parameters for getSignableTrade operation in TradesApi.
7652
9052
  * @export
@@ -7723,10 +9123,10 @@ interface TradesApiListTradesRequest {
7723
9123
  readonly cursor?: string;
7724
9124
  /**
7725
9125
  * Property to sort by
7726
- * @type {string}
9126
+ * @type {'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
7727
9127
  * @memberof TradesApiListTrades
7728
9128
  */
7729
- readonly orderBy?: string;
9129
+ readonly orderBy?: 'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
7730
9130
  /**
7731
9131
  * Direction to sort (asc/desc)
7732
9132
  * @type {string}
@@ -7746,6 +9146,79 @@ interface TradesApiListTradesRequest {
7746
9146
  */
7747
9147
  readonly maxTimestamp?: string;
7748
9148
  }
9149
+ /**
9150
+ * Request parameters for listTradesV3 operation in TradesApi.
9151
+ * @export
9152
+ * @interface TradesApiListTradesV3Request
9153
+ */
9154
+ interface TradesApiListTradesV3Request {
9155
+ /**
9156
+ * Party A\&#39;s (buy order) token type of currency used to buy
9157
+ * @type {string}
9158
+ * @memberof TradesApiListTradesV3
9159
+ */
9160
+ readonly partyATokenType?: string;
9161
+ /**
9162
+ * Party A\&#39;s (buy order) token address of currency used to buy
9163
+ * @type {string}
9164
+ * @memberof TradesApiListTradesV3
9165
+ */
9166
+ readonly partyATokenAddress?: string;
9167
+ /**
9168
+ * Party B\&#39;s (sell order) token type of NFT sold - always ERC721
9169
+ * @type {string}
9170
+ * @memberof TradesApiListTradesV3
9171
+ */
9172
+ readonly partyBTokenType?: string;
9173
+ /**
9174
+ * Party B\&#39;s (sell order) collection address of NFT sold
9175
+ * @type {string}
9176
+ * @memberof TradesApiListTradesV3
9177
+ */
9178
+ readonly partyBTokenAddress?: string;
9179
+ /**
9180
+ * Party B\&#39;s (sell order) token id of NFT sold
9181
+ * @type {string}
9182
+ * @memberof TradesApiListTradesV3
9183
+ */
9184
+ readonly partyBTokenId?: string;
9185
+ /**
9186
+ * Page size of the result
9187
+ * @type {number}
9188
+ * @memberof TradesApiListTradesV3
9189
+ */
9190
+ readonly pageSize?: number;
9191
+ /**
9192
+ * Cursor
9193
+ * @type {string}
9194
+ * @memberof TradesApiListTradesV3
9195
+ */
9196
+ readonly cursor?: string;
9197
+ /**
9198
+ * Property to sort by
9199
+ * @type {'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp'}
9200
+ * @memberof TradesApiListTradesV3
9201
+ */
9202
+ readonly orderBy?: 'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp';
9203
+ /**
9204
+ * Direction to sort (asc/desc)
9205
+ * @type {string}
9206
+ * @memberof TradesApiListTradesV3
9207
+ */
9208
+ readonly direction?: string;
9209
+ /**
9210
+ * Minimum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
9211
+ * @type {string}
9212
+ * @memberof TradesApiListTradesV3
9213
+ */
9214
+ readonly minTimestamp?: string;
9215
+ /**
9216
+ * Maximum timestamp for this trade, in ISO 8601 UTC format. Example: \&#39;2022-05-27T00:10:22Z\&#39;
9217
+ * @type {string}
9218
+ * @memberof TradesApiListTradesV3
9219
+ */
9220
+ readonly maxTimestamp?: string;
9221
+ }
7749
9222
  /**
7750
9223
  * TradesApi - object-oriented interface
7751
9224
  * @export
@@ -7754,7 +9227,7 @@ interface TradesApiListTradesRequest {
7754
9227
  */
7755
9228
  declare class TradesApi extends BaseAPI {
7756
9229
  /**
7757
- * Create a Trade
9230
+ * Create a trade. Use https://docs.x.immutable.com/reference#/operations/getSignableTrade to get request body params.
7758
9231
  * @summary Create a Trade between two parties
7759
9232
  * @param {TradesApiCreateTradeRequest} requestParameters Request parameters.
7760
9233
  * @param {*} [options] Override http request option.
@@ -7762,6 +9235,15 @@ declare class TradesApi extends BaseAPI {
7762
9235
  * @memberof TradesApi
7763
9236
  */
7764
9237
  createTrade(requestParameters: TradesApiCreateTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
9238
+ /**
9239
+ * Create a Trade. Currently only buy order is supported.
9240
+ * @summary Create a Trade (V3)
9241
+ * @param {TradesApiCreateTradeV3Request} requestParameters Request parameters.
9242
+ * @param {*} [options] Override http request option.
9243
+ * @throws {RequiredError}
9244
+ * @memberof TradesApi
9245
+ */
9246
+ createTradeV3(requestParameters: TradesApiCreateTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
7765
9247
  /**
7766
9248
  * Get a signable trade V3 message
7767
9249
  * @summary Get a signable trade V3 message
@@ -7789,6 +9271,15 @@ declare class TradesApi extends BaseAPI {
7789
9271
  * @memberof TradesApi
7790
9272
  */
7791
9273
  listTrades(requestParameters?: TradesApiListTradesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTradesResponse, any>>;
9274
+ /**
9275
+ * Get a list of trades (V3)
9276
+ * @summary Get a list of trades (V3)
9277
+ * @param {TradesApiListTradesV3Request} requestParameters Request parameters.
9278
+ * @param {*} [options] Override http request option.
9279
+ * @throws {RequiredError}
9280
+ * @memberof TradesApi
9281
+ */
9282
+ listTradesV3(requestParameters?: TradesApiListTradesV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<ListTradesResponse, any>>;
7792
9283
  }
7793
9284
  /**
7794
9285
  * Request parameters for createTransfer operation in TransfersApi.
@@ -8008,7 +9499,7 @@ interface TransfersApiListTransfersRequest {
8008
9499
  */
8009
9500
  declare class TransfersApi extends BaseAPI {
8010
9501
  /**
8011
- * Create a new transfer request
9502
+ * Create a new transfer request.
8012
9503
  * @summary Creates a transfer of multiple tokens between two parties
8013
9504
  * @param {TransfersApiCreateTransferRequest} requestParameters Request parameters.
8014
9505
  * @param {*} [options] Override http request option.
@@ -8017,7 +9508,7 @@ declare class TransfersApi extends BaseAPI {
8017
9508
  */
8018
9509
  createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
8019
9510
  /**
8020
- * Create a new transfer request
9511
+ * Create a new transfer request.
8021
9512
  * @summary Creates a transfer of tokens between two parties
8022
9513
  * @param {TransfersApiCreateTransferV1Request} requestParameters Request parameters.
8023
9514
  * @param {*} [options] Override http request option.
@@ -8360,7 +9851,7 @@ interface WithdrawalsApiListWithdrawalsRequest {
8360
9851
  */
8361
9852
  declare class WithdrawalsApi extends BaseAPI {
8362
9853
  /**
8363
- * Creates a withdrawal
9854
+ * Creates a withdrawal.
8364
9855
  * @summary Creates a withdrawal of a token
8365
9856
  * @param {WithdrawalsApiCreateWithdrawalRequest} requestParameters Request parameters.
8366
9857
  * @param {*} [options] Override http request option.
@@ -8396,6 +9887,30 @@ declare class WithdrawalsApi extends BaseAPI {
8396
9887
  */
8397
9888
  listWithdrawals(requestParameters?: WithdrawalsApiListWithdrawalsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ListWithdrawalsResponse, any>>;
8398
9889
  }
9890
+ /**
9891
+ * Parameter required to Mint tokens
9892
+ */
9893
+ declare type UnsignedMintRequest = Omit<MintRequest, 'auth_signature'>;
9894
+ /**
9895
+ * Parameter required to create a Transfer
9896
+ */
9897
+ declare type UnsignedExchangeTransferRequest = ExchangeTokenAmount & {
9898
+ /**
9899
+ * Ethereum address of the receiving user
9900
+ */
9901
+ receiver: string;
9902
+ /**
9903
+ * Exchange transaction ID
9904
+ */
9905
+ transactionID: string;
9906
+ };
9907
+
9908
+ /**
9909
+ * Creates a new Stark Signer
9910
+ * @params starkPrivateKey - the private key as a hex string
9911
+ * @returns a StarkSigner
9912
+ */
9913
+ declare function createStarkSigner(starkPrivateKey: string): StarkSigner;
8399
9914
 
8400
9915
  /**
8401
9916
  * The configuration for the Ethereum network
@@ -8412,7 +9927,7 @@ interface ImmutableXConfiguration {
8412
9927
  /**
8413
9928
  * The configuration for the API client
8414
9929
  */
8415
- apiConfiguration: Configuration$1;
9930
+ apiConfiguration: Configuration;
8416
9931
  /**
8417
9932
  * The configuration for the Ethereum network
8418
9933
  */
@@ -8420,20 +9935,30 @@ interface ImmutableXConfiguration {
8420
9935
  }
8421
9936
 
8422
9937
  declare enum Environment {
8423
- DEVELOPMENT = "development",
8424
- SANDBOX = "sandbox",
8425
- PRODUCTION = "production"
9938
+ PRODUCTION = "production",
9939
+ SANDBOX = "sandbox"
8426
9940
  }
8427
- type StarkExConfig = ImmutableXConfiguration & {
8428
- env: Environment;
8429
- };
8430
- declare class Configuration {
8431
- private readonly starkExConfig;
8432
- constructor(config: StarkExConfig);
8433
- getStarkExConfig(): StarkExConfig;
9941
+ declare class ImmutableConfiguration {
9942
+ readonly environment: Environment;
9943
+ readonly apiKey?: string;
9944
+ constructor(options: {
9945
+ environment: Environment;
9946
+ apiKey?: string;
9947
+ });
9948
+ }
9949
+ interface ModuleConfiguration<T> {
9950
+ baseConfig: ImmutableConfiguration;
9951
+ overrides?: T;
9952
+ }
9953
+
9954
+ interface ImxOverrides {
9955
+ immutableXConfig: ImmutableXConfiguration;
9956
+ }
9957
+ interface ImxModuleConfiguration extends ModuleConfiguration<ImxOverrides> {
8434
9958
  }
8435
9959
 
8436
- declare const StarkExAPIFactory: (config: Configuration) => {
9960
+ declare class ImmutableXClient {
9961
+ private immutableX;
8437
9962
  depositsApi: DepositsApi;
8438
9963
  mintsApi: MintsApi;
8439
9964
  ordersApi: OrdersApi;
@@ -8450,6 +9975,332 @@ declare const StarkExAPIFactory: (config: Configuration) => {
8450
9975
  metadataApi: MetadataApi;
8451
9976
  metadataRefreshesApi: MetadataRefreshesApi;
8452
9977
  projectsApi: ProjectsApi;
8453
- };
9978
+ constructor(config: ImxModuleConfiguration);
9979
+ /**
9980
+ * Get details of a Deposit with the given ID
9981
+ * @param request - the request object containing the parameters to be provided in the API request
9982
+ * @returns a promise that resolves with the requested Deposit
9983
+ * @throws {@link index.IMXError}
9984
+ */
9985
+ getDeposit(request: DepositsApiGetDepositRequest): Promise<Deposit>;
9986
+ /**
9987
+ * Get a list of Deposits
9988
+ * @param request - optional request object containing the parameters to be provided in the API request
9989
+ * @returns a promise that resolves with the requested list of Deposits
9990
+ * @throws {@link index.IMXError}
9991
+ */
9992
+ listDeposits(request?: DepositsApiListDepositsRequest): Promise<ListDepositsResponse>;
9993
+ /**
9994
+ * Get Stark keys for a registered User
9995
+ * @param ethAddress - the eth address of the User
9996
+ * @returns a promise that resolves with the requested User
9997
+ * @throws {@link index.IMXError}
9998
+ */
9999
+ getUser(ethAddress: string): Promise<GetUsersApiResponse>;
10000
+ /**
10001
+ * Get details of an Asset
10002
+ * @param request - the request object containing the parameters to be provided in the API request
10003
+ * @returns a promise that resolves with the requested Asset
10004
+ * @throws {@link index.IMXError}
10005
+ */
10006
+ getAsset(request: AssetsApiGetAssetRequest): Promise<Asset>;
10007
+ /**
10008
+ * Get a list of Assets
10009
+ * @param request - optional request object containing the parameters to be provided in the API request
10010
+ * @returns a promise that resolves with the requested list of Assets
10011
+ * @throws {@link index.IMXError}
10012
+ */
10013
+ listAssets(request?: AssetsApiListAssetsRequest): Promise<ListAssetsResponse>;
10014
+ /**
10015
+ * Create a Collection
10016
+ * @param ethSigner - the L1 signer
10017
+ * @param request - the request object to be provided in the API request
10018
+ * @returns a promise that resolves with the created Collection
10019
+ * @throws {@link index.IMXError}
10020
+ */
10021
+ createCollection(ethSigner: Signer, request: CreateCollectionRequest): Promise<Collection>;
10022
+ /**
10023
+ * Get details of a Collection at the given address
10024
+ * @param request - the request object containing the parameters to be provided in the API request
10025
+ * @returns a promise that resolves with the requested Collection
10026
+ * @throws {@link index.IMXError}
10027
+ */
10028
+ getCollection(request: CollectionsApiGetCollectionRequest): Promise<Collection>;
10029
+ /**
10030
+ * Get a list of Collection filters
10031
+ * @param request - the request object containing the parameters to be provided in the API request
10032
+ * @returns a promise that resolves with the requested list of Collection Filters
10033
+ * @throws {@link index.IMXError}
10034
+ */
10035
+ listCollectionFilters(request: CollectionsApiListCollectionFiltersRequest): Promise<CollectionFilter>;
10036
+ /**
10037
+ * Get a list of Collections
10038
+ * @param request - optional request object containing the parameters to be provided in the API request
10039
+ * @returns a promise that resolves with the requested list of Collections
10040
+ * @throws {@link index.IMXError}
10041
+ */
10042
+ listCollections(request?: CollectionsApiListCollectionsRequest): Promise<ListCollectionsResponse>;
10043
+ /**
10044
+ * Update a Collection
10045
+ * @param ethSigner - the L1 signer
10046
+ * @param collectionAddress - the Collection contract address
10047
+ * @param request - the request object containing the parameters to be provided in the API request
10048
+ * @returns a promise that resolves with the updated Collection
10049
+ * @throws {@link index.IMXError}
10050
+ */
10051
+ updateCollection(ethSigner: Signer, collectionAddress: string, request: UpdateCollectionRequest): Promise<Collection>;
10052
+ /**
10053
+ * Add metadata schema to Collection
10054
+ * @param ethSigner - the L1 signer
10055
+ * @param collectionAddress - the Collection contract address
10056
+ * @param request - the request object containing the parameters to be provided in the API request
10057
+ * @returns a promise that resolves with the SuccessResponse if successful
10058
+ * @throws {@link index.IMXError}
10059
+ */
10060
+ addMetadataSchemaToCollection(ethSigner: Signer, collectionAddress: string, request: AddMetadataSchemaToCollectionRequest): Promise<SuccessResponse>;
10061
+ /**
10062
+ * Get Metadata schema
10063
+ * @param request - the request object containing the parameters to be provided in the API request
10064
+ * @returns a promise that resolves with the requested Metadata schema
10065
+ * @throws {@link index.IMXError}
10066
+ */
10067
+ getMetadataSchema(request: MetadataApiGetMetadataSchemaRequest): Promise<MetadataSchemaProperty[]>;
10068
+ /**
10069
+ * Update metadata schema by name
10070
+ * @param ethSigner - the L1 signer
10071
+ * @param collectionAddress - the Collection contract address
10072
+ * @param name - the Metadata schema name
10073
+ * @param request - the request object containing the parameters to be provided in the API request
10074
+ * @returns a promise that resolves with the SuccessResponse if successful
10075
+ * @throws {@link index.IMXError}
10076
+ */
10077
+ updateMetadataSchemaByName(ethSigner: Signer, collectionAddress: string, name: string, request: MetadataSchemaRequest): Promise<SuccessResponse>;
10078
+ /**
10079
+ * Get a list of metadata refreshes
10080
+ * @param ethSigner - the L1 signer
10081
+ * @param collectionAddress - the Collection contract address
10082
+ * @param pageSize - the page size of the result
10083
+ * @param cursor - the cursor
10084
+ * @returns a promise that resolves with the requested metadata refreshes
10085
+ * @throws {@link index.IMXError}
10086
+ */
10087
+ listMetadataRefreshes(ethSigner: Signer, collectionAddress?: string, pageSize?: number, cursor?: string): Promise<GetMetadataRefreshes>;
10088
+ /**
10089
+ * Get a list of metadata refresh errors
10090
+ * @param ethSigner - the L1 signer
10091
+ * @param refreshId - the metadata refresh ID
10092
+ * @param pageSize - the page size of the result
10093
+ * @param cursor - the cursor
10094
+ * @returns a promise that resolves with the requested metadata refresh errors
10095
+ * @throws {@link index.IMXError}
10096
+ */
10097
+ getMetadataRefreshErrors(ethSigner: Signer, refreshId: string, pageSize?: number, cursor?: string): Promise<GetMetadataRefreshErrorsResponse>;
10098
+ /**
10099
+ * Get a list of metadata refresh results
10100
+ * @param ethSigner - the L1 signer
10101
+ * @param refreshId - the metadata refresh ID
10102
+ * @returns a promise that resolves with the requested metadata refresh results
10103
+ * @throws {@link index.IMXError}
10104
+ */
10105
+ getMetadataRefreshResults(ethSigner: Signer, refreshId: string): Promise<GetMetadataRefreshResponse>;
10106
+ /**
10107
+ * Request a metadata refresh
10108
+ * @param ethSigner - the L1 signer
10109
+ * @param request the request object containing the parameters to be provided in the API request
10110
+ * @returns a promise that resolves with the requested metadata refresh
10111
+ * @throws {@link index.IMXError}
10112
+ */
10113
+ createMetadataRefresh(ethSigner: Signer, request: CreateMetadataRefreshRequest): Promise<CreateMetadataRefreshResponse>;
10114
+ /**
10115
+ * Create a Project
10116
+ * @param ethSigner - the L1 signer
10117
+ * @param request - the request object containing the parameters to be provided in the API request
10118
+ * @returns a promise that resolves with the created Project
10119
+ * @throws {@link index.IMXError}
10120
+ */
10121
+ createProject(ethSigner: Signer, request: CreateProjectRequest): Promise<CreateProjectResponse>;
10122
+ /**
10123
+ * Get a Project
10124
+ * @param ethSigner - the L1 signer
10125
+ * @param id - the Project ID
10126
+ * @returns a promise that resolves with the requested Project
10127
+ * @throws {@link index.IMXError}
10128
+ */
10129
+ getProject(ethSigner: Signer, id: string): Promise<Project>;
10130
+ /**
10131
+ * Get Projects owned by the given User
10132
+ * @param ethSigner - the L1 signer
10133
+ * @param pageSize - the page size of the result
10134
+ * @param cursor - the cursor
10135
+ * @param orderBy - the property to sort by
10136
+ * @param direction - direction to sort (asc/desc)
10137
+ * @returns a promise that resolves with the requested Projects
10138
+ * @throws {@link index.IMXError}
10139
+ */
10140
+ getProjects(ethSigner: Signer, pageSize?: number, cursor?: string, orderBy?: string, direction?: string): Promise<GetProjectsResponse>;
10141
+ /**
10142
+ * Get the token Balances of the User
10143
+ * @param request - the request object containing the parameters to be provided in the API request
10144
+ * @returns a promise that resolves with the requested Balance
10145
+ * @throws {@link index.IMXError}
10146
+ */
10147
+ getBalance(request: BalancesApiGetBalanceRequest): Promise<Balance>;
10148
+ /**
10149
+ * Get a list of Balances for given User
10150
+ * @param request the request object containing the parameters to be provided in the API request
10151
+ * @returns a promise that resolves with the requested list of Balances
10152
+ * @throws {@link index.IMXError}
10153
+ */
10154
+ listBalances(request: BalancesApiListBalancesRequest): Promise<ListBalancesResponse>;
10155
+ /**
10156
+ * Get details of a Mint with the given ID
10157
+ * @param request the request object containing the parameters to be provided in the API request
10158
+ * @returns a promise that resolves with the requested Mint
10159
+ * @throws {@link index.IMXError}
10160
+ */
10161
+ getMint(request: MintsApiGetMintRequest): Promise<Mint[]>;
10162
+ /**
10163
+ * Get a list of Mints
10164
+ * @param request optional request object containing the parameters to be provided in the API request
10165
+ * @returns a promise that resolves with the requested list of Mints
10166
+ * @throws {@link index.IMXError}
10167
+ */
10168
+ listMints(request?: MintsApiListMintsRequest): Promise<ListMintsResponse>;
10169
+ /**
10170
+ * Mint tokens in a batch with fees
10171
+ * @param ethSigner - the L1 signer
10172
+ * @param request - the request object to be provided in the API request
10173
+ * @returns a promise that resolves with the minted tokens
10174
+ * @throws {@link index.IMXError}
10175
+ */
10176
+ mint(ethSigner: Signer, request: UnsignedMintRequest): Promise<MintTokensResponse>;
10177
+ /**
10178
+ * Get a list of Withdrawals
10179
+ * @param request - optional request object containing the parameters to be provided in the API request
10180
+ * @returns a promise that resolves with the requested list of Withdrawals
10181
+ * @throws {@link index.IMXError}
10182
+ */
10183
+ listWithdrawals(request?: WithdrawalsApiListWithdrawalsRequest): Promise<ListWithdrawalsResponse>;
10184
+ /**
10185
+ * Get details of Withdrawal with the given ID
10186
+ * @param request - the request object containing the parameters to be provided in the API request
10187
+ * @returns a promise that resolves with the requested Withdrawal
10188
+ * @throws {@link index.IMXError}
10189
+ */
10190
+ getWithdrawal(request: WithdrawalsApiGetWithdrawalRequest): Promise<Withdrawal>;
10191
+ /**
10192
+ * Get details of an Order with the given ID
10193
+ * @param request - the request object containing the parameters to be provided in the API request
10194
+ * @returns a promise that resolves with the requested Order
10195
+ * @throws {@link index.IMXError}
10196
+ */
10197
+ getOrder(request: OrdersApiGetOrderRequest): Promise<Order>;
10198
+ /**
10199
+ * Get a list of Orders
10200
+ * @param request - optional request object containing the parameters to be provided in the API request
10201
+ * @returns a promise that resolves with the requested list of Orders
10202
+ * @throws {@link index.IMXError}
10203
+ */
10204
+ listOrders(request?: OrdersApiListOrdersRequest): Promise<ListOrdersResponse>;
10205
+ /**
10206
+ * Get details of a Trade with the given ID
10207
+ * @param request - the request object containing the parameters to be provided in the API request
10208
+ * @returns a promise that resolves with the requested Trade
10209
+ * @throws {@link index.IMXError}
10210
+ */
10211
+ getTrade(request: TradesApiGetTradeRequest): Promise<Trade>;
10212
+ /**
10213
+ * Get a list of Trades
10214
+ * @param request - optional request object containing the parameters to be provided in the API request
10215
+ * @returns a promise that resolves with the requested list of Trades
10216
+ * @throws {@link index.IMXError}
10217
+ */
10218
+ listTrades(request?: TradesApiListTradesRequest): Promise<ListTradesResponse>;
10219
+ /**
10220
+ * Get details of a Token
10221
+ * @param request - the request object containing the parameters to be provided in the API request
10222
+ * @returns a promise that resolves with the requested Token
10223
+ * @throws {@link index.IMXError}
10224
+ */
10225
+ getToken(request: TokensApiGetTokenRequest): Promise<TokenDetails>;
10226
+ /**
10227
+ * Get a list of Tokens
10228
+ * @param request - optional request object containing the parameters to be provided in the API request
10229
+ * @returns a promise that resolves with the requested list of Tokens
10230
+ * @throws {@link index.IMXError}
10231
+ */
10232
+ listTokens(request?: TokensApiListTokensRequest): Promise<ListTokensResponse>;
10233
+ /**
10234
+ * Get details of a Transfer with the given ID
10235
+ * @param request - the request object containing the parameters to be provided in the API request
10236
+ * @returns a promise that resolves with the requested Transfer
10237
+ * @throws {@link index.IMXError}
10238
+ */
10239
+ getTransfer(request: TransfersApiGetTransferRequest): Promise<Transfer>;
10240
+ /**
10241
+ * Get a list of Transfers
10242
+ * @param request - optional request object containing the parameters to be provided in the API request
10243
+ * @returns a promise that resolves with the requested list of Transfers
10244
+ * @throws {@link index.IMXError}
10245
+ */
10246
+ listTransfers(request?: TransfersApiListTransfersRequest): Promise<ListTransfersResponse>;
10247
+ /**
10248
+ * Create a new Exchange transaction
10249
+ * @param request - the request object to be provided in the API request
10250
+ * @returns a promise that resolves with the created Exchange Transaction
10251
+ * @throws {@link index.IMXError}
10252
+ */
10253
+ createExchange(request: ExchangesApiCreateExchangeRequest): Promise<ExchangeCreateExchangeAndURLResponse>;
10254
+ /**
10255
+ * Get an Exchange transaction
10256
+ * @param request - the request object to be provided in the API request
10257
+ * @returns a promise that resolves with the Exchange Transaction
10258
+ * @throws {@link index.IMXError}
10259
+ */
10260
+ getExchange(request: ExchangesApiGetExchangeRequest): Promise<Exchange>;
10261
+ /**
10262
+ * Get Exchange transactions
10263
+ * @param request - the request object to be provided in the API request
10264
+ * @returns a promise that resolves with Exchange Transactions
10265
+ * @throws {@link index.IMXError}
10266
+ */
10267
+ getExchanges(request: ExchangesApiGetExchangesRequest): Promise<GetTransactionsResponse>;
10268
+ /**
10269
+ * Create a new Transfer request
10270
+ * @param walletConnection - the pair of Eth/Stark signers
10271
+ * @param request - the request object to be provided in the API request
10272
+ * @returns a promise that resolves with the created Exchange Transfer
10273
+ * @throws {@link index.IMXError}
10274
+ */
10275
+ exchangeTransfer(walletConnection: WalletConnection, request: UnsignedExchangeTransferRequest): Promise<CreateTransferResponseV1>;
10276
+ /**
10277
+ * Create a new nft primary transaction
10278
+ * @param request - the request object to be provided in the API request
10279
+ * @returns a promise that resolves with the created nft primary Transaction
10280
+ * @throws {@link index.IMXError}
10281
+ */
10282
+ createNftPrimary(request: NftCheckoutPrimaryApiCreateNftPrimaryRequest): Promise<NftprimarytransactionCreateResponse>;
10283
+ /**
10284
+ * Get nft primary supported currencies and their limits
10285
+ * @param request - the request object to be provided in the API request
10286
+ * @returns a promise that resolves with nft primary Currencies
10287
+ * @throws {@link index.IMXError}
10288
+ */
10289
+ getCurrenciesNFTCheckoutPrimary(request: NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimaryRequest): Promise<CurrencyWithLimits>;
10290
+ /**
10291
+ * Get nft primary transaction by transaction id
10292
+ * @param request - the request object to be provided in the API request
10293
+ * @returns a promise that resolves with nft primary transaction
10294
+ * @throws {@link index.IMXError}
10295
+ */
10296
+ getNftPrimaryTransaction(request: NftCheckoutPrimaryApiGetNftPrimaryTransactionRequest): Promise<NftprimarytransactionGetResponse>;
10297
+ /**
10298
+ * Get list of nft primary transactions
10299
+ * @param request - the request object to be provided in the API request
10300
+ * @returns a promise that resolves with nft primary transaction
10301
+ * @throws {@link index.IMXError}
10302
+ */
10303
+ getNftPrimaryTransactions(request: NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest): Promise<NftprimarytransactionListTransactionsResponse>;
10304
+ }
8454
10305
 
8455
- export { StarkExAPIFactory };
10306
+ export { ImmutableXClient, ImxModuleConfiguration as ImxClientModuleConfiguration, WalletConnection as ImxClientWalletConnection, createStarkSigner as imxClientCreateStarkSigner, generateLegacyStarkPrivateKey as imxClientGenerateLegacyStarkPrivateKey };