@imtbl/sdk 1.33.0 → 1.34.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.
@@ -0,0 +1,3502 @@
1
+ type CreateMintRequest = {
2
+ contract_address: string;
3
+ asset_id: string;
4
+ metadata: any;
5
+ owner_address: string;
6
+ };
7
+ type MintRequest = {
8
+ id: string;
9
+ contract_address: string;
10
+ wallet_address: string;
11
+ asset_id: string;
12
+ metadata: any;
13
+ owner_address: string;
14
+ tried_count: number;
15
+ };
16
+ type SubmittedMintRequest = {
17
+ tokenId: string | null;
18
+ status: string;
19
+ assetId: string;
20
+ contractAddress: string;
21
+ ownerAddress: string;
22
+ metadataId: string;
23
+ imtblZkevmMintRequestUpdatedId: string;
24
+ error: any | null;
25
+ };
26
+ interface MintingPersistence {
27
+ recordMint: (request: CreateMintRequest) => Promise<void>;
28
+ getNextBatchForSubmission: (limit: number) => Promise<MintRequest[]>;
29
+ updateMintingStatusToSubmitted: (id: string[]) => Promise<void>;
30
+ updateMintingStatusToSubmissionFailed: (id: string[]) => Promise<void>;
31
+ syncMintingStatus: (submittedMintRequest: SubmittedMintRequest) => Promise<void>;
32
+ markAsConflict: (assetIds: string[], contractAddress: string) => Promise<void>;
33
+ resetMintingStatus: (ids: string[]) => Promise<void>;
34
+ markForRetry: (ids: string[]) => Promise<void>;
35
+ getMintingRequest: (contractAddress: string, referenceId: string) => Promise<MintRequest>;
36
+ }
37
+
38
+ declare const mintingPersistence: MintingPersistence;
39
+
40
+ /**
41
+ * Immutable zkEVM API
42
+ * Immutable Multi Rollup API
43
+ *
44
+ * The version of the OpenAPI document: 1.0.0
45
+ * Contact: support@immutable.com
46
+ *
47
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
48
+ * https://openapi-generator.tech
49
+ * Do not edit the class manually.
50
+ */
51
+ interface ConfigurationParameters {
52
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
53
+ username?: string;
54
+ password?: string;
55
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
56
+ basePath?: string;
57
+ baseOptions?: any;
58
+ formDataCtor?: new () => any;
59
+ }
60
+ declare class Configuration {
61
+ /**
62
+ * parameter for apiKey security
63
+ * @param name security name
64
+ * @memberof Configuration
65
+ */
66
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
67
+ /**
68
+ * parameter for basic security
69
+ *
70
+ * @type {string}
71
+ * @memberof Configuration
72
+ */
73
+ username?: string;
74
+ /**
75
+ * parameter for basic security
76
+ *
77
+ * @type {string}
78
+ * @memberof Configuration
79
+ */
80
+ password?: string;
81
+ /**
82
+ * parameter for oauth2 security
83
+ * @param name security name
84
+ * @param scopes oauth2 scope
85
+ * @memberof Configuration
86
+ */
87
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
88
+ /**
89
+ * override base path
90
+ *
91
+ * @type {string}
92
+ * @memberof Configuration
93
+ */
94
+ basePath?: string;
95
+ /**
96
+ * base options for axios calls
97
+ *
98
+ * @type {any}
99
+ * @memberof Configuration
100
+ */
101
+ baseOptions?: any;
102
+ /**
103
+ * The FormData constructor that will be used to create multipart form data
104
+ * requests. You can inject this here so that execution environments that
105
+ * do not support the FormData class can still run the generated client.
106
+ *
107
+ * @type {new () => FormData}
108
+ */
109
+ formDataCtor?: new () => any;
110
+ constructor(param?: ConfigurationParameters);
111
+ /**
112
+ * Check if the given MIME is a JSON MIME.
113
+ * JSON MIME examples:
114
+ * application/json
115
+ * application/json; charset=UTF8
116
+ * APPLICATION/JSON
117
+ * application/vnd.company+json
118
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
119
+ * @return True if the given MIME is JSON, false otherwise.
120
+ */
121
+ isJsonMime(mime: string): boolean;
122
+ }
123
+
124
+ /**
125
+ * Immutable zkEVM API
126
+ * Immutable Multi Rollup API
127
+ *
128
+ * The version of the OpenAPI document: 1.0.0
129
+ * Contact: support@immutable.com
130
+ *
131
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
132
+ * https://openapi-generator.tech
133
+ * Do not edit the class manually.
134
+ */
135
+ /**
136
+ * The contract type for an NFT
137
+ * @export
138
+ * @enum {string}
139
+ */
140
+ declare const NFTContractType: {
141
+ readonly Erc721: "ERC721";
142
+ readonly Erc1155: "ERC1155";
143
+ };
144
+ type NFTContractType = typeof NFTContractType[keyof typeof NFTContractType];
145
+
146
+ /**
147
+ * Immutable zkEVM API
148
+ * Immutable Multi Rollup API
149
+ *
150
+ * The version of the OpenAPI document: 1.0.0
151
+ * Contact: support@immutable.com
152
+ *
153
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
154
+ * https://openapi-generator.tech
155
+ * Do not edit the class manually.
156
+ */
157
+
158
+ /**
159
+ *
160
+ * @export
161
+ * @interface ActivityNFT
162
+ */
163
+ interface ActivityNFT {
164
+ /**
165
+ *
166
+ * @type {NFTContractType}
167
+ * @memberof ActivityNFT
168
+ */
169
+ 'contract_type': NFTContractType;
170
+ /**
171
+ * The token contract address
172
+ * @type {string}
173
+ * @memberof ActivityNFT
174
+ */
175
+ 'contract_address': string;
176
+ /**
177
+ * An `uint256` token id as string
178
+ * @type {string}
179
+ * @memberof ActivityNFT
180
+ */
181
+ 'token_id': string;
182
+ /**
183
+ * The amount of tokens exchanged
184
+ * @type {string}
185
+ * @memberof ActivityNFT
186
+ */
187
+ 'amount': string;
188
+ }
189
+
190
+ /**
191
+ * Immutable zkEVM API
192
+ * Immutable Multi Rollup API
193
+ *
194
+ * The version of the OpenAPI document: 1.0.0
195
+ * Contact: support@immutable.com
196
+ *
197
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
198
+ * https://openapi-generator.tech
199
+ * Do not edit the class manually.
200
+ */
201
+ /**
202
+ * The contract type for a token
203
+ * @export
204
+ * @enum {string}
205
+ */
206
+ declare const TokenContractType: {
207
+ readonly Erc20: "ERC20";
208
+ };
209
+ type TokenContractType = typeof TokenContractType[keyof typeof TokenContractType];
210
+
211
+ /**
212
+ * Immutable zkEVM API
213
+ * Immutable Multi Rollup API
214
+ *
215
+ * The version of the OpenAPI document: 1.0.0
216
+ * Contact: support@immutable.com
217
+ *
218
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
219
+ * https://openapi-generator.tech
220
+ * Do not edit the class manually.
221
+ */
222
+
223
+ /**
224
+ *
225
+ * @export
226
+ * @interface ActivityToken
227
+ */
228
+ interface ActivityToken {
229
+ /**
230
+ *
231
+ * @type {TokenContractType}
232
+ * @memberof ActivityToken
233
+ */
234
+ 'contract_type': TokenContractType;
235
+ /**
236
+ * The contract address
237
+ * @type {string}
238
+ * @memberof ActivityToken
239
+ */
240
+ 'contract_address': string;
241
+ }
242
+
243
+ /**
244
+ * Immutable zkEVM API
245
+ * Immutable Multi Rollup API
246
+ *
247
+ * The version of the OpenAPI document: 1.0.0
248
+ * Contact: support@immutable.com
249
+ *
250
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
251
+ * https://openapi-generator.tech
252
+ * Do not edit the class manually.
253
+ */
254
+
255
+ /**
256
+ * @type ActivityAsset
257
+ * The contract and asset details for this activity
258
+ * @export
259
+ */
260
+ type ActivityAsset = ActivityNFT | ActivityToken;
261
+
262
+ /**
263
+ * Immutable zkEVM API
264
+ * Immutable Multi Rollup API
265
+ *
266
+ * The version of the OpenAPI document: 1.0.0
267
+ * Contact: support@immutable.com
268
+ *
269
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
270
+ * https://openapi-generator.tech
271
+ * Do not edit the class manually.
272
+ */
273
+
274
+ /**
275
+ * The burn activity details
276
+ * @export
277
+ * @interface Burn
278
+ */
279
+ interface Burn {
280
+ /**
281
+ * The account address the asset was transferred from
282
+ * @type {string}
283
+ * @memberof Burn
284
+ */
285
+ 'from': string;
286
+ /**
287
+ * The amount of assets burnt
288
+ * @type {string}
289
+ * @memberof Burn
290
+ */
291
+ 'amount': string;
292
+ /**
293
+ *
294
+ * @type {ActivityAsset}
295
+ * @memberof Burn
296
+ */
297
+ 'asset': ActivityAsset;
298
+ }
299
+
300
+ /**
301
+ * Immutable zkEVM API
302
+ * Immutable Multi Rollup API
303
+ *
304
+ * The version of the OpenAPI document: 1.0.0
305
+ * Contact: support@immutable.com
306
+ *
307
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
308
+ * https://openapi-generator.tech
309
+ * Do not edit the class manually.
310
+ */
311
+
312
+ /**
313
+ * The deposit activity details
314
+ * @export
315
+ * @interface Deposit
316
+ */
317
+ interface Deposit {
318
+ /**
319
+ * The account address the asset was deposited to
320
+ * @type {string}
321
+ * @memberof Deposit
322
+ */
323
+ 'to': string;
324
+ /**
325
+ * The deposited amount
326
+ * @type {string}
327
+ * @memberof Deposit
328
+ */
329
+ 'amount': string;
330
+ /**
331
+ *
332
+ * @type {ActivityAsset}
333
+ * @memberof Deposit
334
+ */
335
+ 'asset': ActivityAsset;
336
+ }
337
+
338
+ /**
339
+ * Immutable zkEVM API
340
+ * Immutable Multi Rollup API
341
+ *
342
+ * The version of the OpenAPI document: 1.0.0
343
+ * Contact: support@immutable.com
344
+ *
345
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
346
+ * https://openapi-generator.tech
347
+ * Do not edit the class manually.
348
+ */
349
+
350
+ /**
351
+ * The mint activity details
352
+ * @export
353
+ * @interface Mint
354
+ */
355
+ interface Mint {
356
+ /**
357
+ * The account address the asset was minted to
358
+ * @type {string}
359
+ * @memberof Mint
360
+ */
361
+ 'to': string;
362
+ /**
363
+ * The minted amount
364
+ * @type {string}
365
+ * @memberof Mint
366
+ */
367
+ 'amount': string;
368
+ /**
369
+ *
370
+ * @type {ActivityAsset}
371
+ * @memberof Mint
372
+ */
373
+ 'asset': ActivityAsset;
374
+ }
375
+
376
+ /**
377
+ * Immutable zkEVM API
378
+ * Immutable Multi Rollup API
379
+ *
380
+ * The version of the OpenAPI document: 1.0.0
381
+ * Contact: support@immutable.com
382
+ *
383
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
384
+ * https://openapi-generator.tech
385
+ * Do not edit the class manually.
386
+ */
387
+ /**
388
+ *
389
+ * @export
390
+ * @interface SaleFee
391
+ */
392
+ interface SaleFee {
393
+ /**
394
+ * Fee payable to recipient upon settlement
395
+ * @type {string}
396
+ * @memberof SaleFee
397
+ */
398
+ 'amount'?: string;
399
+ /**
400
+ * Fee type
401
+ * @type {string}
402
+ * @memberof SaleFee
403
+ */
404
+ 'type'?: SaleFeeTypeEnum;
405
+ /**
406
+ * Wallet address of fee recipient
407
+ * @type {string}
408
+ * @memberof SaleFee
409
+ */
410
+ 'recipient'?: string;
411
+ }
412
+ declare const SaleFeeTypeEnum: {
413
+ readonly Royalty: "ROYALTY";
414
+ };
415
+ type SaleFeeTypeEnum = typeof SaleFeeTypeEnum[keyof typeof SaleFeeTypeEnum];
416
+
417
+ /**
418
+ * Immutable zkEVM API
419
+ * Immutable Multi Rollup API
420
+ *
421
+ * The version of the OpenAPI document: 1.0.0
422
+ * Contact: support@immutable.com
423
+ *
424
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
425
+ * https://openapi-generator.tech
426
+ * Do not edit the class manually.
427
+ */
428
+ /**
429
+ *
430
+ * @export
431
+ * @interface ActivityNativeToken
432
+ */
433
+ interface ActivityNativeToken {
434
+ /**
435
+ * The token symbol
436
+ * @type {string}
437
+ * @memberof ActivityNativeToken
438
+ */
439
+ 'symbol': string;
440
+ }
441
+
442
+ /**
443
+ * Immutable zkEVM API
444
+ * Immutable Multi Rollup API
445
+ *
446
+ * The version of the OpenAPI document: 1.0.0
447
+ * Contact: support@immutable.com
448
+ *
449
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
450
+ * https://openapi-generator.tech
451
+ * Do not edit the class manually.
452
+ */
453
+
454
+ /**
455
+ * @type SalePaymentToken
456
+ * The type of payment token
457
+ * @export
458
+ */
459
+ type SalePaymentToken = ActivityNativeToken | ActivityToken;
460
+
461
+ /**
462
+ * Immutable zkEVM API
463
+ * Immutable Multi Rollup API
464
+ *
465
+ * The version of the OpenAPI document: 1.0.0
466
+ * Contact: support@immutable.com
467
+ *
468
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
469
+ * https://openapi-generator.tech
470
+ * Do not edit the class manually.
471
+ */
472
+
473
+ /**
474
+ *
475
+ * @export
476
+ * @interface SalePayment
477
+ */
478
+ interface SalePayment {
479
+ /**
480
+ *
481
+ * @type {SalePaymentToken}
482
+ * @memberof SalePayment
483
+ */
484
+ 'token': SalePaymentToken;
485
+ /**
486
+ * The base price of the sale not including any fees
487
+ * @type {string}
488
+ * @memberof SalePayment
489
+ */
490
+ 'price_excluding_fees': string;
491
+ /**
492
+ * The total price of the sale. Includes the sum of all fees
493
+ * @type {string}
494
+ * @memberof SalePayment
495
+ */
496
+ 'price_including_fees': string;
497
+ /**
498
+ * The fees associated with this sale
499
+ * @type {Array<SaleFee>}
500
+ * @memberof SalePayment
501
+ */
502
+ 'fees': Array<SaleFee>;
503
+ }
504
+
505
+ /**
506
+ * Immutable zkEVM API
507
+ * Immutable Multi Rollup API
508
+ *
509
+ * The version of the OpenAPI document: 1.0.0
510
+ * Contact: support@immutable.com
511
+ *
512
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
513
+ * https://openapi-generator.tech
514
+ * Do not edit the class manually.
515
+ */
516
+
517
+ /**
518
+ * The NFT Sale activity details
519
+ * @export
520
+ * @interface NFTSale
521
+ */
522
+ interface NFTSale {
523
+ /**
524
+ * The id of order
525
+ * @type {string}
526
+ * @memberof NFTSale
527
+ */
528
+ 'order_id': string;
529
+ /**
530
+ * The account address of buyer
531
+ * @type {string}
532
+ * @memberof NFTSale
533
+ */
534
+ 'to': string;
535
+ /**
536
+ * The account address of seller
537
+ * @type {string}
538
+ * @memberof NFTSale
539
+ */
540
+ 'from': string;
541
+ /**
542
+ *
543
+ * @type {Array<ActivityNFT>}
544
+ * @memberof NFTSale
545
+ */
546
+ 'asset': Array<ActivityNFT>;
547
+ /**
548
+ *
549
+ * @type {SalePayment}
550
+ * @memberof NFTSale
551
+ */
552
+ 'payment': SalePayment;
553
+ }
554
+
555
+ /**
556
+ * Immutable zkEVM API
557
+ * Immutable Multi Rollup API
558
+ *
559
+ * The version of the OpenAPI document: 1.0.0
560
+ * Contact: support@immutable.com
561
+ *
562
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
563
+ * https://openapi-generator.tech
564
+ * Do not edit the class manually.
565
+ */
566
+
567
+ /**
568
+ * The transfer activity details
569
+ * @export
570
+ * @interface Transfer
571
+ */
572
+ interface Transfer {
573
+ /**
574
+ * The account address the asset was transferred from
575
+ * @type {string}
576
+ * @memberof Transfer
577
+ */
578
+ 'from': string;
579
+ /**
580
+ * The account address the asset was transferred to
581
+ * @type {string}
582
+ * @memberof Transfer
583
+ */
584
+ 'to': string;
585
+ /**
586
+ * The amount of assets transferred
587
+ * @type {string}
588
+ * @memberof Transfer
589
+ */
590
+ 'amount': string;
591
+ /**
592
+ *
593
+ * @type {ActivityAsset}
594
+ * @memberof Transfer
595
+ */
596
+ 'asset': ActivityAsset;
597
+ }
598
+
599
+ /**
600
+ * Immutable zkEVM API
601
+ * Immutable Multi Rollup API
602
+ *
603
+ * The version of the OpenAPI document: 1.0.0
604
+ * Contact: support@immutable.com
605
+ *
606
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
607
+ * https://openapi-generator.tech
608
+ * Do not edit the class manually.
609
+ */
610
+
611
+ /**
612
+ * The withdrawal activity details
613
+ * @export
614
+ * @interface Withdrawal
615
+ */
616
+ interface Withdrawal {
617
+ /**
618
+ * The account address the asset was withdrawn from
619
+ * @type {string}
620
+ * @memberof Withdrawal
621
+ */
622
+ 'from': string;
623
+ /**
624
+ * The amount of assets withdrawn
625
+ * @type {string}
626
+ * @memberof Withdrawal
627
+ */
628
+ 'amount': string;
629
+ /**
630
+ *
631
+ * @type {ActivityAsset}
632
+ * @memberof Withdrawal
633
+ */
634
+ 'asset': ActivityAsset;
635
+ }
636
+
637
+ /**
638
+ * Immutable zkEVM API
639
+ * Immutable Multi Rollup API
640
+ *
641
+ * The version of the OpenAPI document: 1.0.0
642
+ * Contact: support@immutable.com
643
+ *
644
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
645
+ * https://openapi-generator.tech
646
+ * Do not edit the class manually.
647
+ */
648
+
649
+ /**
650
+ * @type ActivityDetails
651
+ * The activity details
652
+ * @export
653
+ */
654
+ type ActivityDetails = Burn | Deposit | Mint | NFTSale | Transfer | Withdrawal;
655
+
656
+ /**
657
+ * Immutable zkEVM API
658
+ * Immutable Multi Rollup API
659
+ *
660
+ * The version of the OpenAPI document: 1.0.0
661
+ * Contact: support@immutable.com
662
+ *
663
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
664
+ * https://openapi-generator.tech
665
+ * Do not edit the class manually.
666
+ */
667
+ /**
668
+ * The activity type
669
+ * @export
670
+ * @enum {string}
671
+ */
672
+ declare const ActivityType: {
673
+ readonly Mint: "mint";
674
+ readonly Burn: "burn";
675
+ readonly Transfer: "transfer";
676
+ readonly Sale: "sale";
677
+ readonly Deposit: "deposit";
678
+ readonly Withdrawal: "withdrawal";
679
+ };
680
+ type ActivityType = typeof ActivityType[keyof typeof ActivityType];
681
+
682
+ /**
683
+ * Immutable zkEVM API
684
+ * Immutable Multi Rollup API
685
+ *
686
+ * The version of the OpenAPI document: 1.0.0
687
+ * Contact: support@immutable.com
688
+ *
689
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
690
+ * https://openapi-generator.tech
691
+ * Do not edit the class manually.
692
+ */
693
+ /**
694
+ * The metadata related to blockchain transaction
695
+ * @export
696
+ * @interface BlockchainMetadata
697
+ */
698
+ interface BlockchainMetadata {
699
+ /**
700
+ * The transaction hash of the activity
701
+ * @type {string}
702
+ * @memberof BlockchainMetadata
703
+ */
704
+ 'transaction_hash': string;
705
+ /**
706
+ * EVM block number (uint64 as string)
707
+ * @type {string}
708
+ * @memberof BlockchainMetadata
709
+ */
710
+ 'block_number': string;
711
+ /**
712
+ * Transaction index in a block (uint32 as string)
713
+ * @type {string}
714
+ * @memberof BlockchainMetadata
715
+ */
716
+ 'transaction_index': string;
717
+ /**
718
+ * The log index of activity in a block (uint32 as string)
719
+ * @type {string}
720
+ * @memberof BlockchainMetadata
721
+ */
722
+ 'log_index': string | null;
723
+ }
724
+
725
+ /**
726
+ * Immutable zkEVM API
727
+ * Immutable Multi Rollup API
728
+ *
729
+ * The version of the OpenAPI document: 1.0.0
730
+ * Contact: support@immutable.com
731
+ *
732
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
733
+ * https://openapi-generator.tech
734
+ * Do not edit the class manually.
735
+ */
736
+ /**
737
+ * The chain details
738
+ * @export
739
+ * @interface Chain
740
+ */
741
+ interface Chain {
742
+ /**
743
+ * The id of chain
744
+ * @type {string}
745
+ * @memberof Chain
746
+ */
747
+ 'id': string;
748
+ /**
749
+ * The name of chain
750
+ * @type {string}
751
+ * @memberof Chain
752
+ */
753
+ 'name': string;
754
+ }
755
+
756
+ /**
757
+ * Immutable zkEVM API
758
+ * Immutable Multi Rollup API
759
+ *
760
+ * The version of the OpenAPI document: 1.0.0
761
+ * Contact: support@immutable.com
762
+ *
763
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
764
+ * https://openapi-generator.tech
765
+ * Do not edit the class manually.
766
+ */
767
+
768
+ /**
769
+ *
770
+ * @export
771
+ * @interface Activity
772
+ */
773
+ interface Activity {
774
+ /**
775
+ * Activity id in UUIDv4 format
776
+ * @type {string}
777
+ * @memberof Activity
778
+ */
779
+ 'id': string;
780
+ /**
781
+ *
782
+ * @type {Chain}
783
+ * @memberof Activity
784
+ */
785
+ 'chain': Chain;
786
+ /**
787
+ *
788
+ * @type {ActivityType}
789
+ * @memberof Activity
790
+ */
791
+ 'type': ActivityType;
792
+ /**
793
+ *
794
+ * @type {ActivityDetails}
795
+ * @memberof Activity
796
+ */
797
+ 'details': ActivityDetails;
798
+ /**
799
+ * The time activity was updated at
800
+ * @type {string}
801
+ * @memberof Activity
802
+ */
803
+ 'updated_at': string;
804
+ /**
805
+ * The time activity was indexed
806
+ * @type {string}
807
+ * @memberof Activity
808
+ */
809
+ 'indexed_at': string;
810
+ /**
811
+ *
812
+ * @type {BlockchainMetadata}
813
+ * @memberof Activity
814
+ */
815
+ 'blockchain_metadata': BlockchainMetadata | null;
816
+ }
817
+
818
+ /**
819
+ * Immutable zkEVM API
820
+ * Immutable Multi Rollup API
821
+ *
822
+ * The version of the OpenAPI document: 1.0.0
823
+ * Contact: support@immutable.com
824
+ *
825
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
826
+ * https://openapi-generator.tech
827
+ * Do not edit the class manually.
828
+ */
829
+ /**
830
+ * The verification status for a given contract
831
+ * @export
832
+ * @enum {string}
833
+ */
834
+ declare const AssetVerificationStatus: {
835
+ readonly Verified: "verified";
836
+ readonly Unverified: "unverified";
837
+ readonly Spam: "spam";
838
+ readonly Inactive: "inactive";
839
+ };
840
+ type AssetVerificationStatus = typeof AssetVerificationStatus[keyof typeof AssetVerificationStatus];
841
+
842
+ /**
843
+ * Immutable zkEVM API
844
+ * Immutable Multi Rollup API
845
+ *
846
+ * The version of the OpenAPI document: 1.0.0
847
+ * Contact: support@immutable.com
848
+ *
849
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
850
+ * https://openapi-generator.tech
851
+ * Do not edit the class manually.
852
+ */
853
+ /**
854
+ *
855
+ * @export
856
+ * @interface ChainWithDetailsAllOf
857
+ */
858
+ interface ChainWithDetailsAllOf {
859
+ /**
860
+ * URL for RPC node
861
+ * @type {string}
862
+ * @memberof ChainWithDetailsAllOf
863
+ */
864
+ 'rpc_url': string | null;
865
+ }
866
+
867
+ /**
868
+ * Immutable zkEVM API
869
+ * Immutable Multi Rollup API
870
+ *
871
+ * The version of the OpenAPI document: 1.0.0
872
+ * Contact: support@immutable.com
873
+ *
874
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
875
+ * https://openapi-generator.tech
876
+ * Do not edit the class manually.
877
+ */
878
+
879
+ /**
880
+ * @type ChainWithDetails
881
+ * @export
882
+ */
883
+ type ChainWithDetails = Chain & ChainWithDetailsAllOf;
884
+
885
+ /**
886
+ * Immutable zkEVM API
887
+ * Immutable Multi Rollup API
888
+ *
889
+ * The version of the OpenAPI document: 1.0.0
890
+ * Contact: support@immutable.com
891
+ *
892
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
893
+ * https://openapi-generator.tech
894
+ * Do not edit the class manually.
895
+ */
896
+ /**
897
+ * The collection contract type
898
+ * @export
899
+ * @enum {string}
900
+ */
901
+ declare const CollectionContractType: {
902
+ readonly Erc721: "ERC721";
903
+ readonly Erc1155: "ERC1155";
904
+ };
905
+ type CollectionContractType = typeof CollectionContractType[keyof typeof CollectionContractType];
906
+
907
+ /**
908
+ * Immutable zkEVM API
909
+ * Immutable Multi Rollup API
910
+ *
911
+ * The version of the OpenAPI document: 1.0.0
912
+ * Contact: support@immutable.com
913
+ *
914
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
915
+ * https://openapi-generator.tech
916
+ * Do not edit the class manually.
917
+ */
918
+
919
+ /**
920
+ *
921
+ * @export
922
+ * @interface Collection
923
+ */
924
+ interface Collection {
925
+ /**
926
+ *
927
+ * @type {Chain}
928
+ * @memberof Collection
929
+ */
930
+ 'chain': Chain;
931
+ /**
932
+ * The name of the collection
933
+ * @type {string}
934
+ * @memberof Collection
935
+ */
936
+ 'name': string | null;
937
+ /**
938
+ * The symbol of contract
939
+ * @type {string}
940
+ * @memberof Collection
941
+ */
942
+ 'symbol': string | null;
943
+ /**
944
+ *
945
+ * @type {CollectionContractType}
946
+ * @memberof Collection
947
+ */
948
+ 'contract_type': CollectionContractType;
949
+ /**
950
+ * The address of the contract
951
+ * @type {string}
952
+ * @memberof Collection
953
+ */
954
+ 'contract_address': string;
955
+ /**
956
+ * The description of collection
957
+ * @type {string}
958
+ * @memberof Collection
959
+ */
960
+ 'description': string | null;
961
+ /**
962
+ * The url of the collection image
963
+ * @type {string}
964
+ * @memberof Collection
965
+ */
966
+ 'image': string | null;
967
+ /**
968
+ * The url of external link
969
+ * @type {string}
970
+ * @memberof Collection
971
+ */
972
+ 'external_link': string | null;
973
+ /**
974
+ * The uri for the metadata of the collection
975
+ * @type {string}
976
+ * @memberof Collection
977
+ */
978
+ 'contract_uri'?: string | null;
979
+ /**
980
+ * The metadata uri for nft
981
+ * @type {string}
982
+ * @memberof Collection
983
+ */
984
+ 'base_uri': string | null;
985
+ /**
986
+ *
987
+ * @type {AssetVerificationStatus}
988
+ * @memberof Collection
989
+ */
990
+ 'verification_status': AssetVerificationStatus;
991
+ /**
992
+ * When the collection was first indexed
993
+ * @type {string}
994
+ * @memberof Collection
995
+ */
996
+ 'indexed_at': string;
997
+ /**
998
+ * When the collection was last updated
999
+ * @type {string}
1000
+ * @memberof Collection
1001
+ */
1002
+ 'updated_at': string;
1003
+ /**
1004
+ * When the collection metadata was last synced
1005
+ * @type {string}
1006
+ * @memberof Collection
1007
+ */
1008
+ 'metadata_synced_at': string | null;
1009
+ }
1010
+
1011
+ /**
1012
+ * Immutable zkEVM API
1013
+ * Immutable Multi Rollup API
1014
+ *
1015
+ * The version of the OpenAPI document: 1.0.0
1016
+ * Contact: support@immutable.com
1017
+ *
1018
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1019
+ * https://openapi-generator.tech
1020
+ * Do not edit the class manually.
1021
+ */
1022
+ /**
1023
+ *
1024
+ * @export
1025
+ * @interface CollectionMetadata
1026
+ */
1027
+ interface CollectionMetadata {
1028
+ /**
1029
+ * The name of the collection
1030
+ * @type {string}
1031
+ * @memberof CollectionMetadata
1032
+ */
1033
+ 'name': string | null;
1034
+ /**
1035
+ * The symbol of contract
1036
+ * @type {string}
1037
+ * @memberof CollectionMetadata
1038
+ */
1039
+ 'symbol': string | null;
1040
+ /**
1041
+ * The description of collection
1042
+ * @type {string}
1043
+ * @memberof CollectionMetadata
1044
+ */
1045
+ 'description': string | null;
1046
+ /**
1047
+ * The url of the collection image
1048
+ * @type {string}
1049
+ * @memberof CollectionMetadata
1050
+ */
1051
+ 'image': string | null;
1052
+ /**
1053
+ * The url of external link
1054
+ * @type {string}
1055
+ * @memberof CollectionMetadata
1056
+ */
1057
+ 'external_link': string | null;
1058
+ /**
1059
+ * The uri for the metadata of the collection
1060
+ * @type {string}
1061
+ * @memberof CollectionMetadata
1062
+ */
1063
+ 'contract_uri': string | null;
1064
+ /**
1065
+ * The metadata uri for nft
1066
+ * @type {string}
1067
+ * @memberof CollectionMetadata
1068
+ */
1069
+ 'base_uri': string | null;
1070
+ }
1071
+
1072
+ /**
1073
+ * Immutable zkEVM API
1074
+ * Immutable Multi Rollup API
1075
+ *
1076
+ * The version of the OpenAPI document: 1.0.0
1077
+ * Contact: support@immutable.com
1078
+ *
1079
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1080
+ * https://openapi-generator.tech
1081
+ * Do not edit the class manually.
1082
+ */
1083
+ /**
1084
+ * @type NFTMetadataAttributeValue
1085
+ * The metadata trait value
1086
+ * @export
1087
+ */
1088
+ type NFTMetadataAttributeValue = boolean | number | string;
1089
+
1090
+ /**
1091
+ * Immutable zkEVM API
1092
+ * Immutable Multi Rollup API
1093
+ *
1094
+ * The version of the OpenAPI document: 1.0.0
1095
+ * Contact: support@immutable.com
1096
+ *
1097
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1098
+ * https://openapi-generator.tech
1099
+ * Do not edit the class manually.
1100
+ */
1101
+
1102
+ /**
1103
+ *
1104
+ * @export
1105
+ * @interface NFTMetadataAttribute
1106
+ */
1107
+ interface NFTMetadataAttribute {
1108
+ /**
1109
+ * The metadata trait type
1110
+ * @type {string}
1111
+ * @memberof NFTMetadataAttribute
1112
+ */
1113
+ 'trait_type': string;
1114
+ /**
1115
+ *
1116
+ * @type {NFTMetadataAttributeValue}
1117
+ * @memberof NFTMetadataAttribute
1118
+ */
1119
+ 'value': NFTMetadataAttributeValue;
1120
+ }
1121
+
1122
+ /**
1123
+ * Immutable zkEVM API
1124
+ * Immutable Multi Rollup API
1125
+ *
1126
+ * The version of the OpenAPI document: 1.0.0
1127
+ * Contact: support@immutable.com
1128
+ *
1129
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1130
+ * https://openapi-generator.tech
1131
+ * Do not edit the class manually.
1132
+ */
1133
+
1134
+ /**
1135
+ * The NFT metadata
1136
+ * @export
1137
+ * @interface NFTMetadataRequest
1138
+ */
1139
+ interface NFTMetadataRequest {
1140
+ /**
1141
+ * The name of the NFT
1142
+ * @type {string}
1143
+ * @memberof NFTMetadataRequest
1144
+ */
1145
+ 'name'?: string | null;
1146
+ /**
1147
+ * The description of the NFT
1148
+ * @type {string}
1149
+ * @memberof NFTMetadataRequest
1150
+ */
1151
+ 'description'?: string | null;
1152
+ /**
1153
+ * The image url of the NFT
1154
+ * @type {string}
1155
+ * @memberof NFTMetadataRequest
1156
+ */
1157
+ 'image'?: string | null;
1158
+ /**
1159
+ * The external link of the NFT
1160
+ * @type {string}
1161
+ * @memberof NFTMetadataRequest
1162
+ */
1163
+ 'external_url'?: string | null;
1164
+ /**
1165
+ * The animation url of the NFT
1166
+ * @type {string}
1167
+ * @memberof NFTMetadataRequest
1168
+ */
1169
+ 'animation_url'?: string | null;
1170
+ /**
1171
+ * The youtube link of the NFT
1172
+ * @type {string}
1173
+ * @memberof NFTMetadataRequest
1174
+ */
1175
+ 'youtube_url'?: string | null;
1176
+ /**
1177
+ * List of Metadata attributes
1178
+ * @type {Array<NFTMetadataAttribute>}
1179
+ * @memberof NFTMetadataRequest
1180
+ */
1181
+ 'attributes'?: Array<NFTMetadataAttribute> | null;
1182
+ }
1183
+
1184
+ /**
1185
+ * Immutable zkEVM API
1186
+ * Immutable Multi Rollup API
1187
+ *
1188
+ * The version of the OpenAPI document: 1.0.0
1189
+ * Contact: support@immutable.com
1190
+ *
1191
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1192
+ * https://openapi-generator.tech
1193
+ * Do not edit the class manually.
1194
+ */
1195
+
1196
+ /**
1197
+ *
1198
+ * @export
1199
+ * @interface MintAsset
1200
+ */
1201
+ interface MintAsset {
1202
+ /**
1203
+ * The id of this asset in the system that originates the mint request
1204
+ * @type {string}
1205
+ * @memberof MintAsset
1206
+ */
1207
+ 'reference_id': string;
1208
+ /**
1209
+ * The address of the receiver
1210
+ * @type {string}
1211
+ * @memberof MintAsset
1212
+ */
1213
+ 'owner_address': string;
1214
+ /**
1215
+ * An optional `uint256` token id as string. Required for ERC1155 collections.
1216
+ * @type {string}
1217
+ * @memberof MintAsset
1218
+ */
1219
+ 'token_id'?: string | null;
1220
+ /**
1221
+ * Optional mount of tokens to mint. Required for ERC1155 collections. ERC712 collections can omit this field or set it to 1
1222
+ * @type {string}
1223
+ * @memberof MintAsset
1224
+ */
1225
+ 'amount'?: string | null;
1226
+ /**
1227
+ *
1228
+ * @type {NFTMetadataRequest}
1229
+ * @memberof MintAsset
1230
+ */
1231
+ 'metadata'?: NFTMetadataRequest;
1232
+ }
1233
+
1234
+ /**
1235
+ * Immutable zkEVM API
1236
+ * Immutable Multi Rollup API
1237
+ *
1238
+ * The version of the OpenAPI document: 1.0.0
1239
+ * Contact: support@immutable.com
1240
+ *
1241
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1242
+ * https://openapi-generator.tech
1243
+ * Do not edit the class manually.
1244
+ */
1245
+
1246
+ /**
1247
+ *
1248
+ * @export
1249
+ * @interface CreateMintRequestRequest
1250
+ */
1251
+ interface CreateMintRequestRequest {
1252
+ /**
1253
+ * List of nft to be minted
1254
+ * @type {Array<MintAsset>}
1255
+ * @memberof CreateMintRequestRequest
1256
+ */
1257
+ 'assets': Array<MintAsset>;
1258
+ }
1259
+
1260
+ /**
1261
+ * Immutable zkEVM API
1262
+ * Immutable Multi Rollup API
1263
+ *
1264
+ * The version of the OpenAPI document: 1.0.0
1265
+ * Contact: support@immutable.com
1266
+ *
1267
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1268
+ * https://openapi-generator.tech
1269
+ * Do not edit the class manually.
1270
+ */
1271
+ /**
1272
+ *
1273
+ * @export
1274
+ * @interface CreateMintRequestResult
1275
+ */
1276
+ interface CreateMintRequestResult {
1277
+ /**
1278
+ *
1279
+ * @type {string}
1280
+ * @memberof CreateMintRequestResult
1281
+ */
1282
+ 'imx_mint_requests_limit': string;
1283
+ /**
1284
+ *
1285
+ * @type {string}
1286
+ * @memberof CreateMintRequestResult
1287
+ */
1288
+ 'imx_mint_requests_limit_reset': string;
1289
+ /**
1290
+ *
1291
+ * @type {string}
1292
+ * @memberof CreateMintRequestResult
1293
+ */
1294
+ 'imx_remaining_mint_requests': string;
1295
+ /**
1296
+ *
1297
+ * @type {string}
1298
+ * @memberof CreateMintRequestResult
1299
+ */
1300
+ 'imx_mint_requests_retry_after': string;
1301
+ }
1302
+
1303
+ /**
1304
+ * Immutable zkEVM API
1305
+ * Immutable Multi Rollup API
1306
+ *
1307
+ * The version of the OpenAPI document: 1.0.0
1308
+ * Contact: support@immutable.com
1309
+ *
1310
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1311
+ * https://openapi-generator.tech
1312
+ * Do not edit the class manually.
1313
+ */
1314
+
1315
+ /**
1316
+ * Single activity
1317
+ * @export
1318
+ * @interface GetActivityResult
1319
+ */
1320
+ interface GetActivityResult {
1321
+ /**
1322
+ *
1323
+ * @type {Activity}
1324
+ * @memberof GetActivityResult
1325
+ */
1326
+ 'result': Activity;
1327
+ }
1328
+
1329
+ /**
1330
+ * Immutable zkEVM API
1331
+ * Immutable Multi Rollup API
1332
+ *
1333
+ * The version of the OpenAPI document: 1.0.0
1334
+ * Contact: support@immutable.com
1335
+ *
1336
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1337
+ * https://openapi-generator.tech
1338
+ * Do not edit the class manually.
1339
+ */
1340
+
1341
+ /**
1342
+ * Single Collection
1343
+ * @export
1344
+ * @interface GetCollectionResult
1345
+ */
1346
+ interface GetCollectionResult {
1347
+ /**
1348
+ *
1349
+ * @type {Collection}
1350
+ * @memberof GetCollectionResult
1351
+ */
1352
+ 'result': Collection;
1353
+ }
1354
+
1355
+ /**
1356
+ * Immutable zkEVM API
1357
+ * Immutable Multi Rollup API
1358
+ *
1359
+ * The version of the OpenAPI document: 1.0.0
1360
+ * Contact: support@immutable.com
1361
+ *
1362
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1363
+ * https://openapi-generator.tech
1364
+ * Do not edit the class manually.
1365
+ */
1366
+
1367
+ /**
1368
+ *
1369
+ * @export
1370
+ * @interface Metadata
1371
+ */
1372
+ interface Metadata {
1373
+ /**
1374
+ * Metadata id in UUIDv4 format
1375
+ * @type {string}
1376
+ * @memberof Metadata
1377
+ */
1378
+ 'id': string;
1379
+ /**
1380
+ *
1381
+ * @type {Chain}
1382
+ * @memberof Metadata
1383
+ */
1384
+ 'chain': Chain;
1385
+ /**
1386
+ * The contract address of the metadata
1387
+ * @type {string}
1388
+ * @memberof Metadata
1389
+ */
1390
+ 'contract_address': string;
1391
+ /**
1392
+ * When the metadata was created
1393
+ * @type {string}
1394
+ * @memberof Metadata
1395
+ */
1396
+ 'created_at': string;
1397
+ /**
1398
+ * When the metadata was last updated
1399
+ * @type {string}
1400
+ * @memberof Metadata
1401
+ */
1402
+ 'updated_at': string | null;
1403
+ /**
1404
+ * The name of the NFT
1405
+ * @type {string}
1406
+ * @memberof Metadata
1407
+ */
1408
+ 'name': string | null;
1409
+ /**
1410
+ * The description of the NFT
1411
+ * @type {string}
1412
+ * @memberof Metadata
1413
+ */
1414
+ 'description': string | null;
1415
+ /**
1416
+ * The image url of the NFT
1417
+ * @type {string}
1418
+ * @memberof Metadata
1419
+ */
1420
+ 'image': string | null;
1421
+ /**
1422
+ * The external website link of NFT
1423
+ * @type {string}
1424
+ * @memberof Metadata
1425
+ */
1426
+ 'external_url'?: string | null;
1427
+ /**
1428
+ * The animation url of the NFT
1429
+ * @type {string}
1430
+ * @memberof Metadata
1431
+ */
1432
+ 'animation_url': string | null;
1433
+ /**
1434
+ * The youtube URL of NFT
1435
+ * @type {string}
1436
+ * @memberof Metadata
1437
+ */
1438
+ 'youtube_url': string | null;
1439
+ /**
1440
+ * List of Metadata attributes
1441
+ * @type {Array<NFTMetadataAttribute>}
1442
+ * @memberof Metadata
1443
+ */
1444
+ 'attributes': Array<NFTMetadataAttribute> | null;
1445
+ }
1446
+
1447
+ /**
1448
+ * Immutable zkEVM API
1449
+ * Immutable Multi Rollup API
1450
+ *
1451
+ * The version of the OpenAPI document: 1.0.0
1452
+ * Contact: support@immutable.com
1453
+ *
1454
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1455
+ * https://openapi-generator.tech
1456
+ * Do not edit the class manually.
1457
+ */
1458
+
1459
+ /**
1460
+ * Single metadata
1461
+ * @export
1462
+ * @interface GetMetadataResult
1463
+ */
1464
+ interface GetMetadataResult {
1465
+ /**
1466
+ *
1467
+ * @type {Metadata}
1468
+ * @memberof GetMetadataResult
1469
+ */
1470
+ 'result': Metadata;
1471
+ }
1472
+
1473
+ /**
1474
+ * Immutable zkEVM API
1475
+ * Immutable Multi Rollup API
1476
+ *
1477
+ * The version of the OpenAPI document: 1.0.0
1478
+ * Contact: support@immutable.com
1479
+ *
1480
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1481
+ * https://openapi-generator.tech
1482
+ * Do not edit the class manually.
1483
+ */
1484
+ /**
1485
+ * The error details in case the mint request fails
1486
+ * @export
1487
+ * @interface MintRequestErrorMessage
1488
+ */
1489
+ interface MintRequestErrorMessage {
1490
+ /**
1491
+ * An error message in case the mint request fails
1492
+ * @type {string}
1493
+ * @memberof MintRequestErrorMessage
1494
+ */
1495
+ 'message'?: string;
1496
+ }
1497
+
1498
+ /**
1499
+ * Immutable zkEVM API
1500
+ * Immutable Multi Rollup API
1501
+ *
1502
+ * The version of the OpenAPI document: 1.0.0
1503
+ * Contact: support@immutable.com
1504
+ *
1505
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1506
+ * https://openapi-generator.tech
1507
+ * Do not edit the class manually.
1508
+ */
1509
+ /**
1510
+ * The status of the mint request
1511
+ * @export
1512
+ * @enum {string}
1513
+ */
1514
+ declare const MintRequestStatus: {
1515
+ readonly Pending: "pending";
1516
+ readonly Succeeded: "succeeded";
1517
+ readonly Failed: "failed";
1518
+ };
1519
+ type MintRequestStatus = typeof MintRequestStatus[keyof typeof MintRequestStatus];
1520
+
1521
+ /**
1522
+ * Immutable zkEVM API
1523
+ * Immutable Multi Rollup API
1524
+ *
1525
+ * The version of the OpenAPI document: 1.0.0
1526
+ * Contact: support@immutable.com
1527
+ *
1528
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1529
+ * https://openapi-generator.tech
1530
+ * Do not edit the class manually.
1531
+ */
1532
+
1533
+ /**
1534
+ *
1535
+ * @export
1536
+ * @interface GetMintRequestResult
1537
+ */
1538
+ interface GetMintRequestResult {
1539
+ /**
1540
+ *
1541
+ * @type {Chain}
1542
+ * @memberof GetMintRequestResult
1543
+ */
1544
+ 'chain': Chain;
1545
+ /**
1546
+ * The address of the contract
1547
+ * @type {string}
1548
+ * @memberof GetMintRequestResult
1549
+ */
1550
+ 'collection_address': string;
1551
+ /**
1552
+ * The reference id of this mint request
1553
+ * @type {string}
1554
+ * @memberof GetMintRequestResult
1555
+ */
1556
+ 'reference_id': string;
1557
+ /**
1558
+ * The address of the owner of the NFT
1559
+ * @type {string}
1560
+ * @memberof GetMintRequestResult
1561
+ */
1562
+ 'owner_address': string;
1563
+ /**
1564
+ * An `uint256` token id as string. Only available when the mint request succeeds
1565
+ * @type {string}
1566
+ * @memberof GetMintRequestResult
1567
+ */
1568
+ 'token_id': string | null;
1569
+ /**
1570
+ * An `uint256` amount as string. Only relevant for mint requests on ERC1155 contracts
1571
+ * @type {string}
1572
+ * @memberof GetMintRequestResult
1573
+ */
1574
+ 'amount'?: string | null;
1575
+ /**
1576
+ * The id of the mint activity associated with this mint request
1577
+ * @type {string}
1578
+ * @memberof GetMintRequestResult
1579
+ */
1580
+ 'activity_id'?: string | null;
1581
+ /**
1582
+ * The transaction hash of the activity
1583
+ * @type {string}
1584
+ * @memberof GetMintRequestResult
1585
+ */
1586
+ 'transaction_hash': string | null;
1587
+ /**
1588
+ * When the mint request was created
1589
+ * @type {string}
1590
+ * @memberof GetMintRequestResult
1591
+ */
1592
+ 'created_at': string;
1593
+ /**
1594
+ * When the mint request was last updated
1595
+ * @type {string}
1596
+ * @memberof GetMintRequestResult
1597
+ */
1598
+ 'updated_at': string;
1599
+ /**
1600
+ *
1601
+ * @type {MintRequestErrorMessage}
1602
+ * @memberof GetMintRequestResult
1603
+ */
1604
+ 'error': MintRequestErrorMessage | null;
1605
+ /**
1606
+ *
1607
+ * @type {MintRequestStatus}
1608
+ * @memberof GetMintRequestResult
1609
+ */
1610
+ 'status': MintRequestStatus;
1611
+ }
1612
+
1613
+ /**
1614
+ * Immutable zkEVM API
1615
+ * Immutable Multi Rollup API
1616
+ *
1617
+ * The version of the OpenAPI document: 1.0.0
1618
+ * Contact: support@immutable.com
1619
+ *
1620
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1621
+ * https://openapi-generator.tech
1622
+ * Do not edit the class manually.
1623
+ */
1624
+
1625
+ /**
1626
+ *
1627
+ * @export
1628
+ * @interface NFT
1629
+ */
1630
+ interface NFT {
1631
+ /**
1632
+ *
1633
+ * @type {Chain}
1634
+ * @memberof NFT
1635
+ */
1636
+ 'chain': Chain;
1637
+ /**
1638
+ * An `uint256` token id as string
1639
+ * @type {string}
1640
+ * @memberof NFT
1641
+ */
1642
+ 'token_id': string;
1643
+ /**
1644
+ * The contract address of the NFT
1645
+ * @type {string}
1646
+ * @memberof NFT
1647
+ */
1648
+ 'contract_address': string;
1649
+ /**
1650
+ *
1651
+ * @type {NFTContractType}
1652
+ * @memberof NFT
1653
+ */
1654
+ 'contract_type': NFTContractType;
1655
+ /**
1656
+ * When the NFT was first indexed
1657
+ * @type {string}
1658
+ * @memberof NFT
1659
+ */
1660
+ 'indexed_at': string;
1661
+ /**
1662
+ * When the NFT owner was last updated
1663
+ * @type {string}
1664
+ * @memberof NFT
1665
+ */
1666
+ 'updated_at': string;
1667
+ /**
1668
+ * When NFT metadata was last synced
1669
+ * @type {string}
1670
+ * @memberof NFT
1671
+ */
1672
+ 'metadata_synced_at': string | null;
1673
+ /**
1674
+ * The id of the metadata of this NFT
1675
+ * @type {string}
1676
+ * @memberof NFT
1677
+ */
1678
+ 'metadata_id'?: string | null;
1679
+ /**
1680
+ * The name of the NFT
1681
+ * @type {string}
1682
+ * @memberof NFT
1683
+ */
1684
+ 'name': string | null;
1685
+ /**
1686
+ * The description of the NFT
1687
+ * @type {string}
1688
+ * @memberof NFT
1689
+ */
1690
+ 'description': string | null;
1691
+ /**
1692
+ * The image url of the NFT
1693
+ * @type {string}
1694
+ * @memberof NFT
1695
+ */
1696
+ 'image': string | null;
1697
+ /**
1698
+ * The external website link of NFT
1699
+ * @type {string}
1700
+ * @memberof NFT
1701
+ */
1702
+ 'external_link': string | null;
1703
+ /**
1704
+ * The animation url of the NFT
1705
+ * @type {string}
1706
+ * @memberof NFT
1707
+ */
1708
+ 'animation_url': string | null;
1709
+ /**
1710
+ * The youtube URL of NFT
1711
+ * @type {string}
1712
+ * @memberof NFT
1713
+ */
1714
+ 'youtube_url': string | null;
1715
+ /**
1716
+ * List of NFT Metadata attributes
1717
+ * @type {Array<NFTMetadataAttribute>}
1718
+ * @memberof NFT
1719
+ */
1720
+ 'attributes': Array<NFTMetadataAttribute>;
1721
+ /**
1722
+ * The total supply of NFT
1723
+ * @type {string}
1724
+ * @memberof NFT
1725
+ */
1726
+ 'total_supply'?: string | null;
1727
+ }
1728
+
1729
+ /**
1730
+ * Immutable zkEVM API
1731
+ * Immutable Multi Rollup API
1732
+ *
1733
+ * The version of the OpenAPI document: 1.0.0
1734
+ * Contact: support@immutable.com
1735
+ *
1736
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1737
+ * https://openapi-generator.tech
1738
+ * Do not edit the class manually.
1739
+ */
1740
+
1741
+ /**
1742
+ * Single NFT
1743
+ * @export
1744
+ * @interface GetNFTResult
1745
+ */
1746
+ interface GetNFTResult {
1747
+ /**
1748
+ *
1749
+ * @type {NFT}
1750
+ * @memberof GetNFTResult
1751
+ */
1752
+ 'result': NFT;
1753
+ }
1754
+
1755
+ /**
1756
+ * Immutable zkEVM API
1757
+ * Immutable Multi Rollup API
1758
+ *
1759
+ * The version of the OpenAPI document: 1.0.0
1760
+ * Contact: support@immutable.com
1761
+ *
1762
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1763
+ * https://openapi-generator.tech
1764
+ * Do not edit the class manually.
1765
+ */
1766
+
1767
+ /**
1768
+ *
1769
+ * @export
1770
+ * @interface Token
1771
+ */
1772
+ interface Token {
1773
+ /**
1774
+ *
1775
+ * @type {Chain}
1776
+ * @memberof Token
1777
+ */
1778
+ 'chain': Chain;
1779
+ /**
1780
+ * The address of token contract
1781
+ * @type {string}
1782
+ * @memberof Token
1783
+ */
1784
+ 'contract_address': string;
1785
+ /**
1786
+ * The address of root token contract
1787
+ * @type {string}
1788
+ * @memberof Token
1789
+ */
1790
+ 'root_contract_address': string | null;
1791
+ /**
1792
+ * The symbol of token
1793
+ * @type {string}
1794
+ * @memberof Token
1795
+ */
1796
+ 'symbol': string | null;
1797
+ /**
1798
+ * The decimals of token
1799
+ * @type {number}
1800
+ * @memberof Token
1801
+ */
1802
+ 'decimals': number | null;
1803
+ /**
1804
+ * The image url of token
1805
+ * @type {string}
1806
+ * @memberof Token
1807
+ */
1808
+ 'image_url': string | null;
1809
+ /**
1810
+ * The name of token
1811
+ * @type {string}
1812
+ * @memberof Token
1813
+ */
1814
+ 'name': string | null;
1815
+ /**
1816
+ *
1817
+ * @type {AssetVerificationStatus}
1818
+ * @memberof Token
1819
+ */
1820
+ 'verification_status': AssetVerificationStatus;
1821
+ /**
1822
+ * When the collection was last updated
1823
+ * @type {string}
1824
+ * @memberof Token
1825
+ */
1826
+ 'updated_at': string;
1827
+ }
1828
+
1829
+ /**
1830
+ * Immutable zkEVM API
1831
+ * Immutable Multi Rollup API
1832
+ *
1833
+ * The version of the OpenAPI document: 1.0.0
1834
+ * Contact: support@immutable.com
1835
+ *
1836
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1837
+ * https://openapi-generator.tech
1838
+ * Do not edit the class manually.
1839
+ */
1840
+
1841
+ /**
1842
+ * Single Token
1843
+ * @export
1844
+ * @interface GetTokenResult
1845
+ */
1846
+ interface GetTokenResult {
1847
+ /**
1848
+ *
1849
+ * @type {Token}
1850
+ * @memberof GetTokenResult
1851
+ */
1852
+ 'result': Token;
1853
+ }
1854
+
1855
+ /**
1856
+ * Immutable zkEVM API
1857
+ * Immutable Multi Rollup API
1858
+ *
1859
+ * The version of the OpenAPI document: 1.0.0
1860
+ * Contact: support@immutable.com
1861
+ *
1862
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1863
+ * https://openapi-generator.tech
1864
+ * Do not edit the class manually.
1865
+ */
1866
+ /**
1867
+ * Pagination properties
1868
+ * @export
1869
+ * @interface Page
1870
+ */
1871
+ interface Page {
1872
+ /**
1873
+ * First item as an encoded string
1874
+ * @type {string}
1875
+ * @memberof Page
1876
+ */
1877
+ 'previous_cursor': string | null;
1878
+ /**
1879
+ * Last item as an encoded string
1880
+ * @type {string}
1881
+ * @memberof Page
1882
+ */
1883
+ 'next_cursor': string | null;
1884
+ }
1885
+
1886
+ /**
1887
+ * Immutable zkEVM API
1888
+ * Immutable Multi Rollup API
1889
+ *
1890
+ * The version of the OpenAPI document: 1.0.0
1891
+ * Contact: support@immutable.com
1892
+ *
1893
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1894
+ * https://openapi-generator.tech
1895
+ * Do not edit the class manually.
1896
+ */
1897
+
1898
+ /**
1899
+ * List activities response
1900
+ * @export
1901
+ * @interface ListActivitiesResult
1902
+ */
1903
+ interface ListActivitiesResult {
1904
+ /**
1905
+ * List of activities
1906
+ * @type {Array<Activity>}
1907
+ * @memberof ListActivitiesResult
1908
+ */
1909
+ 'result': Array<Activity>;
1910
+ /**
1911
+ *
1912
+ * @type {Page}
1913
+ * @memberof ListActivitiesResult
1914
+ */
1915
+ 'page': Page;
1916
+ }
1917
+
1918
+ /**
1919
+ * Immutable zkEVM API
1920
+ * Immutable Multi Rollup API
1921
+ *
1922
+ * The version of the OpenAPI document: 1.0.0
1923
+ * Contact: support@immutable.com
1924
+ *
1925
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1926
+ * https://openapi-generator.tech
1927
+ * Do not edit the class manually.
1928
+ */
1929
+
1930
+ /**
1931
+ *
1932
+ * @export
1933
+ * @interface ListChainsResult
1934
+ */
1935
+ interface ListChainsResult {
1936
+ /**
1937
+ * List of chains
1938
+ * @type {Array<ChainWithDetails>}
1939
+ * @memberof ListChainsResult
1940
+ */
1941
+ 'result': Array<ChainWithDetails>;
1942
+ /**
1943
+ *
1944
+ * @type {Page}
1945
+ * @memberof ListChainsResult
1946
+ */
1947
+ 'page': Page;
1948
+ }
1949
+
1950
+ /**
1951
+ * Immutable zkEVM API
1952
+ * Immutable Multi Rollup API
1953
+ *
1954
+ * The version of the OpenAPI document: 1.0.0
1955
+ * Contact: support@immutable.com
1956
+ *
1957
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1958
+ * https://openapi-generator.tech
1959
+ * Do not edit the class manually.
1960
+ */
1961
+
1962
+ /**
1963
+ *
1964
+ * @export
1965
+ * @interface ListCollectionsResult
1966
+ */
1967
+ interface ListCollectionsResult {
1968
+ /**
1969
+ * List of collections
1970
+ * @type {Array<Collection>}
1971
+ * @memberof ListCollectionsResult
1972
+ */
1973
+ 'result': Array<Collection>;
1974
+ /**
1975
+ *
1976
+ * @type {Page}
1977
+ * @memberof ListCollectionsResult
1978
+ */
1979
+ 'page': Page;
1980
+ }
1981
+
1982
+ /**
1983
+ * Immutable zkEVM API
1984
+ * Immutable Multi Rollup API
1985
+ *
1986
+ * The version of the OpenAPI document: 1.0.0
1987
+ * Contact: support@immutable.com
1988
+ *
1989
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1990
+ * https://openapi-generator.tech
1991
+ * Do not edit the class manually.
1992
+ */
1993
+
1994
+ /**
1995
+ *
1996
+ * @export
1997
+ * @interface ListMetadataResult
1998
+ */
1999
+ interface ListMetadataResult {
2000
+ /**
2001
+ * List of metadata
2002
+ * @type {Array<Metadata>}
2003
+ * @memberof ListMetadataResult
2004
+ */
2005
+ 'result': Array<Metadata>;
2006
+ /**
2007
+ *
2008
+ * @type {Page}
2009
+ * @memberof ListMetadataResult
2010
+ */
2011
+ 'page': Page;
2012
+ }
2013
+
2014
+ /**
2015
+ * Immutable zkEVM API
2016
+ * Immutable Multi Rollup API
2017
+ *
2018
+ * The version of the OpenAPI document: 1.0.0
2019
+ * Contact: support@immutable.com
2020
+ *
2021
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2022
+ * https://openapi-generator.tech
2023
+ * Do not edit the class manually.
2024
+ */
2025
+
2026
+ /**
2027
+ * List mint requests
2028
+ * @export
2029
+ * @interface ListMintRequestsResult
2030
+ */
2031
+ interface ListMintRequestsResult {
2032
+ /**
2033
+ * List of mint requests
2034
+ * @type {Array<GetMintRequestResult>}
2035
+ * @memberof ListMintRequestsResult
2036
+ */
2037
+ 'result': Array<GetMintRequestResult>;
2038
+ /**
2039
+ *
2040
+ * @type {Page}
2041
+ * @memberof ListMintRequestsResult
2042
+ */
2043
+ 'page': Page;
2044
+ }
2045
+
2046
+ /**
2047
+ * Immutable zkEVM API
2048
+ * Immutable Multi Rollup API
2049
+ *
2050
+ * The version of the OpenAPI document: 1.0.0
2051
+ * Contact: support@immutable.com
2052
+ *
2053
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2054
+ * https://openapi-generator.tech
2055
+ * Do not edit the class manually.
2056
+ */
2057
+
2058
+ /**
2059
+ *
2060
+ * @export
2061
+ * @interface NFTOwner
2062
+ */
2063
+ interface NFTOwner {
2064
+ /**
2065
+ *
2066
+ * @type {Chain}
2067
+ * @memberof NFTOwner
2068
+ */
2069
+ 'chain': Chain;
2070
+ /**
2071
+ * The address of NFT contract
2072
+ * @type {string}
2073
+ * @memberof NFTOwner
2074
+ */
2075
+ 'contract_address': string;
2076
+ /**
2077
+ * An `uint256` token id as string
2078
+ * @type {string}
2079
+ * @memberof NFTOwner
2080
+ */
2081
+ 'token_id': string;
2082
+ /**
2083
+ * The account address of the owner of the NFT
2084
+ * @type {string}
2085
+ * @memberof NFTOwner
2086
+ */
2087
+ 'account_address': string;
2088
+ /**
2089
+ * (deprecated - use balance instead) The quantity of owned tokens (uint256 as string)
2090
+ * @type {string}
2091
+ * @memberof NFTOwner
2092
+ * @deprecated
2093
+ */
2094
+ 'quantity': string;
2095
+ /**
2096
+ * The amount of owned tokens (uint256 as string)
2097
+ * @type {string}
2098
+ * @memberof NFTOwner
2099
+ */
2100
+ 'balance': string;
2101
+ /**
2102
+ * When the NFT owner was last updated
2103
+ * @type {string}
2104
+ * @memberof NFTOwner
2105
+ */
2106
+ 'updated_at'?: string;
2107
+ }
2108
+
2109
+ /**
2110
+ * Immutable zkEVM API
2111
+ * Immutable Multi Rollup API
2112
+ *
2113
+ * The version of the OpenAPI document: 1.0.0
2114
+ * Contact: support@immutable.com
2115
+ *
2116
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2117
+ * https://openapi-generator.tech
2118
+ * Do not edit the class manually.
2119
+ */
2120
+
2121
+ /**
2122
+ *
2123
+ * @export
2124
+ * @interface ListNFTOwnersResult
2125
+ */
2126
+ interface ListNFTOwnersResult {
2127
+ /**
2128
+ * List of nft owners
2129
+ * @type {Array<NFTOwner>}
2130
+ * @memberof ListNFTOwnersResult
2131
+ */
2132
+ 'result': Array<NFTOwner>;
2133
+ /**
2134
+ *
2135
+ * @type {Page}
2136
+ * @memberof ListNFTOwnersResult
2137
+ */
2138
+ 'page': Page;
2139
+ }
2140
+
2141
+ /**
2142
+ * Immutable zkEVM API
2143
+ * Immutable Multi Rollup API
2144
+ *
2145
+ * The version of the OpenAPI document: 1.0.0
2146
+ * Contact: support@immutable.com
2147
+ *
2148
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2149
+ * https://openapi-generator.tech
2150
+ * Do not edit the class manually.
2151
+ */
2152
+
2153
+ /**
2154
+ *
2155
+ * @export
2156
+ * @interface ListNFTsResult
2157
+ */
2158
+ interface ListNFTsResult {
2159
+ /**
2160
+ * List of NFTs
2161
+ * @type {Array<NFT>}
2162
+ * @memberof ListNFTsResult
2163
+ */
2164
+ 'result': Array<NFT>;
2165
+ /**
2166
+ *
2167
+ * @type {Page}
2168
+ * @memberof ListNFTsResult
2169
+ */
2170
+ 'page': Page;
2171
+ }
2172
+
2173
+ /**
2174
+ * Immutable zkEVM API
2175
+ * Immutable Multi Rollup API
2176
+ *
2177
+ * The version of the OpenAPI document: 1.0.0
2178
+ * Contact: support@immutable.com
2179
+ *
2180
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2181
+ * https://openapi-generator.tech
2182
+ * Do not edit the class manually.
2183
+ */
2184
+
2185
+ /**
2186
+ *
2187
+ * @export
2188
+ * @interface ListTokensResult
2189
+ */
2190
+ interface ListTokensResult {
2191
+ /**
2192
+ * List of tokens
2193
+ * @type {Array<Token>}
2194
+ * @memberof ListTokensResult
2195
+ */
2196
+ 'result': Array<Token>;
2197
+ /**
2198
+ *
2199
+ * @type {Page}
2200
+ * @memberof ListTokensResult
2201
+ */
2202
+ 'page': Page;
2203
+ }
2204
+
2205
+ /**
2206
+ * Immutable zkEVM API
2207
+ * Immutable Multi Rollup API
2208
+ *
2209
+ * The version of the OpenAPI document: 1.0.0
2210
+ * Contact: support@immutable.com
2211
+ *
2212
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2213
+ * https://openapi-generator.tech
2214
+ * Do not edit the class manually.
2215
+ */
2216
+ /**
2217
+ *
2218
+ * @export
2219
+ * @interface MetadataRefreshRateLimitResult
2220
+ */
2221
+ interface MetadataRefreshRateLimitResult {
2222
+ /**
2223
+ *
2224
+ * @type {string}
2225
+ * @memberof MetadataRefreshRateLimitResult
2226
+ */
2227
+ 'imx_refreshes_limit': string;
2228
+ /**
2229
+ *
2230
+ * @type {string}
2231
+ * @memberof MetadataRefreshRateLimitResult
2232
+ */
2233
+ 'imx_refresh_limit_reset': string;
2234
+ /**
2235
+ *
2236
+ * @type {string}
2237
+ * @memberof MetadataRefreshRateLimitResult
2238
+ */
2239
+ 'imx_remaining_refreshes': string;
2240
+ /**
2241
+ *
2242
+ * @type {string}
2243
+ * @memberof MetadataRefreshRateLimitResult
2244
+ */
2245
+ 'retry_after': string;
2246
+ }
2247
+
2248
+ /**
2249
+ * Immutable zkEVM API
2250
+ * Immutable Multi Rollup API
2251
+ *
2252
+ * The version of the OpenAPI document: 1.0.0
2253
+ * Contact: support@immutable.com
2254
+ *
2255
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2256
+ * https://openapi-generator.tech
2257
+ * Do not edit the class manually.
2258
+ */
2259
+
2260
+ /**
2261
+ *
2262
+ * @export
2263
+ * @interface RefreshCollectionMetadataRequest
2264
+ */
2265
+ interface RefreshCollectionMetadataRequest {
2266
+ /**
2267
+ *
2268
+ * @type {CollectionMetadata}
2269
+ * @memberof RefreshCollectionMetadataRequest
2270
+ */
2271
+ 'collection_metadata': CollectionMetadata;
2272
+ }
2273
+
2274
+ /**
2275
+ * Immutable zkEVM API
2276
+ * Immutable Multi Rollup API
2277
+ *
2278
+ * The version of the OpenAPI document: 1.0.0
2279
+ * Contact: support@immutable.com
2280
+ *
2281
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2282
+ * https://openapi-generator.tech
2283
+ * Do not edit the class manually.
2284
+ */
2285
+
2286
+ /**
2287
+ *
2288
+ * @export
2289
+ * @interface RefreshCollectionMetadataResult
2290
+ */
2291
+ interface RefreshCollectionMetadataResult {
2292
+ /**
2293
+ *
2294
+ * @type {string}
2295
+ * @memberof RefreshCollectionMetadataResult
2296
+ */
2297
+ 'contract_address': string;
2298
+ /**
2299
+ *
2300
+ * @type {Chain}
2301
+ * @memberof RefreshCollectionMetadataResult
2302
+ */
2303
+ 'chain': Chain;
2304
+ /**
2305
+ *
2306
+ * @type {CollectionMetadata}
2307
+ * @memberof RefreshCollectionMetadataResult
2308
+ */
2309
+ 'collection_metadata': CollectionMetadata;
2310
+ }
2311
+
2312
+ /**
2313
+ * Immutable zkEVM API
2314
+ * Immutable Multi Rollup API
2315
+ *
2316
+ * The version of the OpenAPI document: 1.0.0
2317
+ * Contact: support@immutable.com
2318
+ *
2319
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2320
+ * https://openapi-generator.tech
2321
+ * Do not edit the class manually.
2322
+ */
2323
+ /**
2324
+ *
2325
+ * @export
2326
+ * @interface RefreshMetadataByIDAllOf
2327
+ */
2328
+ interface RefreshMetadataByIDAllOf {
2329
+ /**
2330
+ * Metadata id in UUIDv4 format
2331
+ * @type {string}
2332
+ * @memberof RefreshMetadataByIDAllOf
2333
+ */
2334
+ 'metadata_id': string;
2335
+ }
2336
+
2337
+ /**
2338
+ * Immutable zkEVM API
2339
+ * Immutable Multi Rollup API
2340
+ *
2341
+ * The version of the OpenAPI document: 1.0.0
2342
+ * Contact: support@immutable.com
2343
+ *
2344
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2345
+ * https://openapi-generator.tech
2346
+ * Do not edit the class manually.
2347
+ */
2348
+
2349
+ /**
2350
+ * @type RefreshableNFTAttributes
2351
+ * @export
2352
+ */
2353
+ type RefreshableNFTAttributes = NFTMetadataRequest;
2354
+
2355
+ /**
2356
+ * Immutable zkEVM API
2357
+ * Immutable Multi Rollup API
2358
+ *
2359
+ * The version of the OpenAPI document: 1.0.0
2360
+ * Contact: support@immutable.com
2361
+ *
2362
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2363
+ * https://openapi-generator.tech
2364
+ * Do not edit the class manually.
2365
+ */
2366
+
2367
+ /**
2368
+ * @type RefreshMetadataByID
2369
+ * @export
2370
+ */
2371
+ type RefreshMetadataByID = RefreshMetadataByIDAllOf & RefreshableNFTAttributes;
2372
+
2373
+ /**
2374
+ * Immutable zkEVM API
2375
+ * Immutable Multi Rollup API
2376
+ *
2377
+ * The version of the OpenAPI document: 1.0.0
2378
+ * Contact: support@immutable.com
2379
+ *
2380
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2381
+ * https://openapi-generator.tech
2382
+ * Do not edit the class manually.
2383
+ */
2384
+
2385
+ /**
2386
+ * Request body for refreshing metadata by id
2387
+ * @export
2388
+ * @interface RefreshMetadataByIDRequest
2389
+ */
2390
+ interface RefreshMetadataByIDRequest {
2391
+ /**
2392
+ *
2393
+ * @type {Array<RefreshMetadataByID>}
2394
+ * @memberof RefreshMetadataByIDRequest
2395
+ */
2396
+ 'metadata'?: Array<RefreshMetadataByID>;
2397
+ }
2398
+
2399
+ /**
2400
+ * Immutable zkEVM API
2401
+ * Immutable Multi Rollup API
2402
+ *
2403
+ * The version of the OpenAPI document: 1.0.0
2404
+ * Contact: support@immutable.com
2405
+ *
2406
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2407
+ * https://openapi-generator.tech
2408
+ * Do not edit the class manually.
2409
+ */
2410
+ /**
2411
+ *
2412
+ * @export
2413
+ * @interface RefreshMetadataByTokenIDAllOf
2414
+ */
2415
+ interface RefreshMetadataByTokenIDAllOf {
2416
+ /**
2417
+ * An `uint256` token id as string
2418
+ * @type {string}
2419
+ * @memberof RefreshMetadataByTokenIDAllOf
2420
+ */
2421
+ 'token_id': string;
2422
+ }
2423
+
2424
+ /**
2425
+ * Immutable zkEVM API
2426
+ * Immutable Multi Rollup API
2427
+ *
2428
+ * The version of the OpenAPI document: 1.0.0
2429
+ * Contact: support@immutable.com
2430
+ *
2431
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2432
+ * https://openapi-generator.tech
2433
+ * Do not edit the class manually.
2434
+ */
2435
+
2436
+ /**
2437
+ * @type RefreshMetadataByTokenID
2438
+ * @export
2439
+ */
2440
+ type RefreshMetadataByTokenID = RefreshMetadataByTokenIDAllOf & RefreshableNFTAttributes;
2441
+
2442
+ /**
2443
+ * Immutable zkEVM API
2444
+ * Immutable Multi Rollup API
2445
+ *
2446
+ * The version of the OpenAPI document: 1.0.0
2447
+ * Contact: support@immutable.com
2448
+ *
2449
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2450
+ * https://openapi-generator.tech
2451
+ * Do not edit the class manually.
2452
+ */
2453
+
2454
+ /**
2455
+ *
2456
+ * @export
2457
+ * @interface RefreshNFTMetadataByTokenIDRequest
2458
+ */
2459
+ interface RefreshNFTMetadataByTokenIDRequest {
2460
+ /**
2461
+ * List of nft metadata to be refreshed
2462
+ * @type {Array<RefreshMetadataByTokenID>}
2463
+ * @memberof RefreshNFTMetadataByTokenIDRequest
2464
+ */
2465
+ 'nft_metadata': Array<RefreshMetadataByTokenID>;
2466
+ }
2467
+
2468
+ /**
2469
+ * Request parameters for getActivity operation in ActivitiesApi.
2470
+ * @export
2471
+ * @interface ActivitiesApiGetActivityRequest
2472
+ */
2473
+ interface ActivitiesApiGetActivityRequest {
2474
+ /**
2475
+ * The name of chain
2476
+ * @type {string}
2477
+ * @memberof ActivitiesApiGetActivity
2478
+ */
2479
+ readonly chainName: string;
2480
+ /**
2481
+ * The id of activity
2482
+ * @type {string}
2483
+ * @memberof ActivitiesApiGetActivity
2484
+ */
2485
+ readonly activityId: string;
2486
+ }
2487
+ /**
2488
+ * Request parameters for listActivities operation in ActivitiesApi.
2489
+ * @export
2490
+ * @interface ActivitiesApiListActivitiesRequest
2491
+ */
2492
+ interface ActivitiesApiListActivitiesRequest {
2493
+ /**
2494
+ * The name of chain
2495
+ * @type {string}
2496
+ * @memberof ActivitiesApiListActivities
2497
+ */
2498
+ readonly chainName: string;
2499
+ /**
2500
+ * The contract address of NFT or ERC20 Token
2501
+ * @type {string}
2502
+ * @memberof ActivitiesApiListActivities
2503
+ */
2504
+ readonly contractAddress?: string;
2505
+ /**
2506
+ * An &#x60;uint256&#x60; token id as string
2507
+ * @type {string}
2508
+ * @memberof ActivitiesApiListActivities
2509
+ */
2510
+ readonly tokenId?: string;
2511
+ /**
2512
+ * The account address activity contains
2513
+ * @type {string}
2514
+ * @memberof ActivitiesApiListActivities
2515
+ */
2516
+ readonly accountAddress?: string;
2517
+ /**
2518
+ * The activity type
2519
+ * @type {ActivityType}
2520
+ * @memberof ActivitiesApiListActivities
2521
+ */
2522
+ readonly activityType?: ActivityType;
2523
+ /**
2524
+ * The transaction hash of activity
2525
+ * @type {string}
2526
+ * @memberof ActivitiesApiListActivities
2527
+ */
2528
+ readonly transactionHash?: string;
2529
+ /**
2530
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2531
+ * @type {string}
2532
+ * @memberof ActivitiesApiListActivities
2533
+ */
2534
+ readonly pageCursor?: string;
2535
+ /**
2536
+ * Maximum number of items to return
2537
+ * @type {number}
2538
+ * @memberof ActivitiesApiListActivities
2539
+ */
2540
+ readonly pageSize?: number;
2541
+ }
2542
+ /**
2543
+ * Request parameters for listActivityHistory operation in ActivitiesApi.
2544
+ * @export
2545
+ * @interface ActivitiesApiListActivityHistoryRequest
2546
+ */
2547
+ interface ActivitiesApiListActivityHistoryRequest {
2548
+ /**
2549
+ * The name of chain
2550
+ * @type {string}
2551
+ * @memberof ActivitiesApiListActivityHistory
2552
+ */
2553
+ readonly chainName: string;
2554
+ /**
2555
+ * From indexed at including given date
2556
+ * @type {string}
2557
+ * @memberof ActivitiesApiListActivityHistory
2558
+ */
2559
+ readonly fromUpdatedAt: string;
2560
+ /**
2561
+ * To indexed at including given date
2562
+ * @type {string}
2563
+ * @memberof ActivitiesApiListActivityHistory
2564
+ */
2565
+ readonly toUpdatedAt?: string;
2566
+ /**
2567
+ * The contract address of the collection
2568
+ * @type {string}
2569
+ * @memberof ActivitiesApiListActivityHistory
2570
+ */
2571
+ readonly contractAddress?: string;
2572
+ /**
2573
+ * The activity type
2574
+ * @type {ActivityType}
2575
+ * @memberof ActivitiesApiListActivityHistory
2576
+ */
2577
+ readonly activityType?: ActivityType;
2578
+ /**
2579
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2580
+ * @type {string}
2581
+ * @memberof ActivitiesApiListActivityHistory
2582
+ */
2583
+ readonly pageCursor?: string;
2584
+ /**
2585
+ * Maximum number of items to return
2586
+ * @type {number}
2587
+ * @memberof ActivitiesApiListActivityHistory
2588
+ */
2589
+ readonly pageSize?: number;
2590
+ }
2591
+
2592
+ /**
2593
+ * Request parameters for listChains operation in ChainsApi.
2594
+ * @export
2595
+ * @interface ChainsApiListChainsRequest
2596
+ */
2597
+ interface ChainsApiListChainsRequest {
2598
+ /**
2599
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2600
+ * @type {string}
2601
+ * @memberof ChainsApiListChains
2602
+ */
2603
+ readonly pageCursor?: string;
2604
+ /**
2605
+ * Maximum number of items to return
2606
+ * @type {number}
2607
+ * @memberof ChainsApiListChains
2608
+ */
2609
+ readonly pageSize?: number;
2610
+ }
2611
+
2612
+ /**
2613
+ * Request parameters for getCollection operation in CollectionsApi.
2614
+ * @export
2615
+ * @interface CollectionsApiGetCollectionRequest
2616
+ */
2617
+ interface CollectionsApiGetCollectionRequest {
2618
+ /**
2619
+ * The address contract
2620
+ * @type {string}
2621
+ * @memberof CollectionsApiGetCollection
2622
+ */
2623
+ readonly contractAddress: string;
2624
+ /**
2625
+ * The name of chain
2626
+ * @type {string}
2627
+ * @memberof CollectionsApiGetCollection
2628
+ */
2629
+ readonly chainName: string;
2630
+ }
2631
+ /**
2632
+ * Request parameters for listCollections operation in CollectionsApi.
2633
+ * @export
2634
+ * @interface CollectionsApiListCollectionsRequest
2635
+ */
2636
+ interface CollectionsApiListCollectionsRequest {
2637
+ /**
2638
+ * The name of chain
2639
+ * @type {string}
2640
+ * @memberof CollectionsApiListCollections
2641
+ */
2642
+ readonly chainName: string;
2643
+ /**
2644
+ * List of contract addresses to filter by
2645
+ * @type {Array<string>}
2646
+ * @memberof CollectionsApiListCollections
2647
+ */
2648
+ readonly contractAddress?: Array<string>;
2649
+ /**
2650
+ * List of verification status to filter by
2651
+ * @type {Array<AssetVerificationStatus>}
2652
+ * @memberof CollectionsApiListCollections
2653
+ */
2654
+ readonly verificationStatus?: Array<AssetVerificationStatus>;
2655
+ /**
2656
+ * Datetime to use as the oldest updated timestamp
2657
+ * @type {string}
2658
+ * @memberof CollectionsApiListCollections
2659
+ */
2660
+ readonly fromUpdatedAt?: string;
2661
+ /**
2662
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2663
+ * @type {string}
2664
+ * @memberof CollectionsApiListCollections
2665
+ */
2666
+ readonly pageCursor?: string;
2667
+ /**
2668
+ * Maximum number of items to return
2669
+ * @type {number}
2670
+ * @memberof CollectionsApiListCollections
2671
+ */
2672
+ readonly pageSize?: number;
2673
+ }
2674
+ /**
2675
+ * Request parameters for listCollectionsByNFTOwner operation in CollectionsApi.
2676
+ * @export
2677
+ * @interface CollectionsApiListCollectionsByNFTOwnerRequest
2678
+ */
2679
+ interface CollectionsApiListCollectionsByNFTOwnerRequest {
2680
+ /**
2681
+ * Account address
2682
+ * @type {string}
2683
+ * @memberof CollectionsApiListCollectionsByNFTOwner
2684
+ */
2685
+ readonly accountAddress: string;
2686
+ /**
2687
+ * The name of chain
2688
+ * @type {string}
2689
+ * @memberof CollectionsApiListCollectionsByNFTOwner
2690
+ */
2691
+ readonly chainName: string;
2692
+ /**
2693
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2694
+ * @type {string}
2695
+ * @memberof CollectionsApiListCollectionsByNFTOwner
2696
+ */
2697
+ readonly pageCursor?: string;
2698
+ /**
2699
+ * Maximum number of items to return
2700
+ * @type {number}
2701
+ * @memberof CollectionsApiListCollectionsByNFTOwner
2702
+ */
2703
+ readonly pageSize?: number;
2704
+ }
2705
+ /**
2706
+ * Request parameters for refreshCollectionMetadata operation in CollectionsApi.
2707
+ * @export
2708
+ * @interface CollectionsApiRefreshCollectionMetadataRequest
2709
+ */
2710
+ interface CollectionsApiRefreshCollectionMetadataRequest {
2711
+ /**
2712
+ * The address contract
2713
+ * @type {string}
2714
+ * @memberof CollectionsApiRefreshCollectionMetadata
2715
+ */
2716
+ readonly contractAddress: string;
2717
+ /**
2718
+ * The name of chain
2719
+ * @type {string}
2720
+ * @memberof CollectionsApiRefreshCollectionMetadata
2721
+ */
2722
+ readonly chainName: string;
2723
+ /**
2724
+ * The request body
2725
+ * @type {RefreshCollectionMetadataRequest}
2726
+ * @memberof CollectionsApiRefreshCollectionMetadata
2727
+ */
2728
+ readonly refreshCollectionMetadataRequest: RefreshCollectionMetadataRequest;
2729
+ }
2730
+
2731
+ /**
2732
+ * Request parameters for getMetadata operation in MetadataApi.
2733
+ * @export
2734
+ * @interface MetadataApiGetMetadataRequest
2735
+ */
2736
+ interface MetadataApiGetMetadataRequest {
2737
+ /**
2738
+ * The name of chain
2739
+ * @type {string}
2740
+ * @memberof MetadataApiGetMetadata
2741
+ */
2742
+ readonly chainName: string;
2743
+ /**
2744
+ * The address of metadata contract
2745
+ * @type {string}
2746
+ * @memberof MetadataApiGetMetadata
2747
+ */
2748
+ readonly contractAddress: string;
2749
+ /**
2750
+ * The id of the metadata
2751
+ * @type {string}
2752
+ * @memberof MetadataApiGetMetadata
2753
+ */
2754
+ readonly metadataId: string;
2755
+ }
2756
+ /**
2757
+ * Request parameters for listMetadata operation in MetadataApi.
2758
+ * @export
2759
+ * @interface MetadataApiListMetadataRequest
2760
+ */
2761
+ interface MetadataApiListMetadataRequest {
2762
+ /**
2763
+ * The name of chain
2764
+ * @type {string}
2765
+ * @memberof MetadataApiListMetadata
2766
+ */
2767
+ readonly chainName: string;
2768
+ /**
2769
+ * The address of metadata contract
2770
+ * @type {string}
2771
+ * @memberof MetadataApiListMetadata
2772
+ */
2773
+ readonly contractAddress: string;
2774
+ /**
2775
+ * Datetime to use as the oldest updated timestamp
2776
+ * @type {string}
2777
+ * @memberof MetadataApiListMetadata
2778
+ */
2779
+ readonly fromUpdatedAt?: string;
2780
+ /**
2781
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2782
+ * @type {string}
2783
+ * @memberof MetadataApiListMetadata
2784
+ */
2785
+ readonly pageCursor?: string;
2786
+ /**
2787
+ * Maximum number of items to return
2788
+ * @type {number}
2789
+ * @memberof MetadataApiListMetadata
2790
+ */
2791
+ readonly pageSize?: number;
2792
+ }
2793
+ /**
2794
+ * Request parameters for listMetadataForChain operation in MetadataApi.
2795
+ * @export
2796
+ * @interface MetadataApiListMetadataForChainRequest
2797
+ */
2798
+ interface MetadataApiListMetadataForChainRequest {
2799
+ /**
2800
+ * The name of chain
2801
+ * @type {string}
2802
+ * @memberof MetadataApiListMetadataForChain
2803
+ */
2804
+ readonly chainName: string;
2805
+ /**
2806
+ * Datetime to use as the oldest updated timestamp
2807
+ * @type {string}
2808
+ * @memberof MetadataApiListMetadataForChain
2809
+ */
2810
+ readonly fromUpdatedAt?: string;
2811
+ /**
2812
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2813
+ * @type {string}
2814
+ * @memberof MetadataApiListMetadataForChain
2815
+ */
2816
+ readonly pageCursor?: string;
2817
+ /**
2818
+ * Maximum number of items to return
2819
+ * @type {number}
2820
+ * @memberof MetadataApiListMetadataForChain
2821
+ */
2822
+ readonly pageSize?: number;
2823
+ }
2824
+ /**
2825
+ * Request parameters for refreshMetadataByID operation in MetadataApi.
2826
+ * @export
2827
+ * @interface MetadataApiRefreshMetadataByIDRequest
2828
+ */
2829
+ interface MetadataApiRefreshMetadataByIDRequest {
2830
+ /**
2831
+ * The name of chain
2832
+ * @type {string}
2833
+ * @memberof MetadataApiRefreshMetadataByID
2834
+ */
2835
+ readonly chainName: string;
2836
+ /**
2837
+ * Contract address
2838
+ * @type {string}
2839
+ * @memberof MetadataApiRefreshMetadataByID
2840
+ */
2841
+ readonly contractAddress: string;
2842
+ /**
2843
+ * NFT Metadata Refresh Request
2844
+ * @type {RefreshMetadataByIDRequest}
2845
+ * @memberof MetadataApiRefreshMetadataByID
2846
+ */
2847
+ readonly refreshMetadataByIDRequest: RefreshMetadataByIDRequest;
2848
+ }
2849
+ /**
2850
+ * Request parameters for refreshNFTMetadataByTokenID operation in MetadataApi.
2851
+ * @export
2852
+ * @interface MetadataApiRefreshNFTMetadataByTokenIDRequest
2853
+ */
2854
+ interface MetadataApiRefreshNFTMetadataByTokenIDRequest {
2855
+ /**
2856
+ * The address of contract
2857
+ * @type {string}
2858
+ * @memberof MetadataApiRefreshNFTMetadataByTokenID
2859
+ */
2860
+ readonly contractAddress: string;
2861
+ /**
2862
+ * The name of chain
2863
+ * @type {string}
2864
+ * @memberof MetadataApiRefreshNFTMetadataByTokenID
2865
+ */
2866
+ readonly chainName: string;
2867
+ /**
2868
+ * the request body
2869
+ * @type {RefreshNFTMetadataByTokenIDRequest}
2870
+ * @memberof MetadataApiRefreshNFTMetadataByTokenID
2871
+ */
2872
+ readonly refreshNFTMetadataByTokenIDRequest: RefreshNFTMetadataByTokenIDRequest;
2873
+ }
2874
+
2875
+ /**
2876
+ * Request parameters for listNFTOwners operation in NftOwnersApi.
2877
+ * @export
2878
+ * @interface NftOwnersApiListNFTOwnersRequest
2879
+ */
2880
+ interface NftOwnersApiListNFTOwnersRequest {
2881
+ /**
2882
+ * The address of contract
2883
+ * @type {string}
2884
+ * @memberof NftOwnersApiListNFTOwners
2885
+ */
2886
+ readonly contractAddress: string;
2887
+ /**
2888
+ * An &#x60;uint256&#x60; token id as string
2889
+ * @type {string}
2890
+ * @memberof NftOwnersApiListNFTOwners
2891
+ */
2892
+ readonly tokenId: string;
2893
+ /**
2894
+ * The name of chain
2895
+ * @type {string}
2896
+ * @memberof NftOwnersApiListNFTOwners
2897
+ */
2898
+ readonly chainName: string;
2899
+ /**
2900
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2901
+ * @type {string}
2902
+ * @memberof NftOwnersApiListNFTOwners
2903
+ */
2904
+ readonly pageCursor?: string;
2905
+ /**
2906
+ * Maximum number of items to return
2907
+ * @type {number}
2908
+ * @memberof NftOwnersApiListNFTOwners
2909
+ */
2910
+ readonly pageSize?: number;
2911
+ }
2912
+ /**
2913
+ * Request parameters for listOwnersByContractAddress operation in NftOwnersApi.
2914
+ * @export
2915
+ * @interface NftOwnersApiListOwnersByContractAddressRequest
2916
+ */
2917
+ interface NftOwnersApiListOwnersByContractAddressRequest {
2918
+ /**
2919
+ * The address of contract
2920
+ * @type {string}
2921
+ * @memberof NftOwnersApiListOwnersByContractAddress
2922
+ */
2923
+ readonly contractAddress: string;
2924
+ /**
2925
+ * The name of chain
2926
+ * @type {string}
2927
+ * @memberof NftOwnersApiListOwnersByContractAddress
2928
+ */
2929
+ readonly chainName: string;
2930
+ /**
2931
+ * List of account addresses to filter by
2932
+ * @type {Array<string>}
2933
+ * @memberof NftOwnersApiListOwnersByContractAddress
2934
+ */
2935
+ readonly accountAddress?: Array<string>;
2936
+ /**
2937
+ * Datetime to use as the oldest updated timestamp
2938
+ * @type {string}
2939
+ * @memberof NftOwnersApiListOwnersByContractAddress
2940
+ */
2941
+ readonly fromUpdatedAt?: string;
2942
+ /**
2943
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2944
+ * @type {string}
2945
+ * @memberof NftOwnersApiListOwnersByContractAddress
2946
+ */
2947
+ readonly pageCursor?: string;
2948
+ /**
2949
+ * Maximum number of items to return
2950
+ * @type {number}
2951
+ * @memberof NftOwnersApiListOwnersByContractAddress
2952
+ */
2953
+ readonly pageSize?: number;
2954
+ }
2955
+
2956
+ /**
2957
+ * Request parameters for createMintRequest operation in NftsApi.
2958
+ * @export
2959
+ * @interface NftsApiCreateMintRequestRequest
2960
+ */
2961
+ interface NftsApiCreateMintRequestRequest {
2962
+ /**
2963
+ * The address of contract
2964
+ * @type {string}
2965
+ * @memberof NftsApiCreateMintRequest
2966
+ */
2967
+ readonly contractAddress: string;
2968
+ /**
2969
+ * The name of chain
2970
+ * @type {string}
2971
+ * @memberof NftsApiCreateMintRequest
2972
+ */
2973
+ readonly chainName: string;
2974
+ /**
2975
+ * Create Mint Request Body
2976
+ * @type {CreateMintRequestRequest}
2977
+ * @memberof NftsApiCreateMintRequest
2978
+ */
2979
+ readonly createMintRequestRequest: CreateMintRequestRequest;
2980
+ }
2981
+ /**
2982
+ * Request parameters for getMintRequest operation in NftsApi.
2983
+ * @export
2984
+ * @interface NftsApiGetMintRequestRequest
2985
+ */
2986
+ interface NftsApiGetMintRequestRequest {
2987
+ /**
2988
+ * The address of contract
2989
+ * @type {string}
2990
+ * @memberof NftsApiGetMintRequest
2991
+ */
2992
+ readonly contractAddress: string;
2993
+ /**
2994
+ * The name of chain
2995
+ * @type {string}
2996
+ * @memberof NftsApiGetMintRequest
2997
+ */
2998
+ readonly chainName: string;
2999
+ /**
3000
+ * The id of the mint request
3001
+ * @type {string}
3002
+ * @memberof NftsApiGetMintRequest
3003
+ */
3004
+ readonly referenceId: string;
3005
+ }
3006
+ /**
3007
+ * Request parameters for getNFT operation in NftsApi.
3008
+ * @export
3009
+ * @interface NftsApiGetNFTRequest
3010
+ */
3011
+ interface NftsApiGetNFTRequest {
3012
+ /**
3013
+ * The address of NFT contract
3014
+ * @type {string}
3015
+ * @memberof NftsApiGetNFT
3016
+ */
3017
+ readonly contractAddress: string;
3018
+ /**
3019
+ * An &#x60;uint256&#x60; token id as string
3020
+ * @type {string}
3021
+ * @memberof NftsApiGetNFT
3022
+ */
3023
+ readonly tokenId: string;
3024
+ /**
3025
+ * The name of chain
3026
+ * @type {string}
3027
+ * @memberof NftsApiGetNFT
3028
+ */
3029
+ readonly chainName: string;
3030
+ }
3031
+ /**
3032
+ * Request parameters for listAllNFTs operation in NftsApi.
3033
+ * @export
3034
+ * @interface NftsApiListAllNFTsRequest
3035
+ */
3036
+ interface NftsApiListAllNFTsRequest {
3037
+ /**
3038
+ * The name of chain
3039
+ * @type {string}
3040
+ * @memberof NftsApiListAllNFTs
3041
+ */
3042
+ readonly chainName: string;
3043
+ /**
3044
+ * Datetime to use as the oldest updated timestamp
3045
+ * @type {string}
3046
+ * @memberof NftsApiListAllNFTs
3047
+ */
3048
+ readonly fromUpdatedAt?: string;
3049
+ /**
3050
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3051
+ * @type {string}
3052
+ * @memberof NftsApiListAllNFTs
3053
+ */
3054
+ readonly pageCursor?: string;
3055
+ /**
3056
+ * Maximum number of items to return
3057
+ * @type {number}
3058
+ * @memberof NftsApiListAllNFTs
3059
+ */
3060
+ readonly pageSize?: number;
3061
+ }
3062
+ /**
3063
+ * Request parameters for listMintRequests operation in NftsApi.
3064
+ * @export
3065
+ * @interface NftsApiListMintRequestsRequest
3066
+ */
3067
+ interface NftsApiListMintRequestsRequest {
3068
+ /**
3069
+ * The address of contract
3070
+ * @type {string}
3071
+ * @memberof NftsApiListMintRequests
3072
+ */
3073
+ readonly contractAddress: string;
3074
+ /**
3075
+ * The name of chain
3076
+ * @type {string}
3077
+ * @memberof NftsApiListMintRequests
3078
+ */
3079
+ readonly chainName: string;
3080
+ /**
3081
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3082
+ * @type {string}
3083
+ * @memberof NftsApiListMintRequests
3084
+ */
3085
+ readonly pageCursor?: string;
3086
+ /**
3087
+ * Maximum number of items to return
3088
+ * @type {number}
3089
+ * @memberof NftsApiListMintRequests
3090
+ */
3091
+ readonly pageSize?: number;
3092
+ /**
3093
+ * The status of the mint request
3094
+ * @type {MintRequestStatus}
3095
+ * @memberof NftsApiListMintRequests
3096
+ */
3097
+ readonly status?: MintRequestStatus;
3098
+ }
3099
+ /**
3100
+ * Request parameters for listNFTs operation in NftsApi.
3101
+ * @export
3102
+ * @interface NftsApiListNFTsRequest
3103
+ */
3104
+ interface NftsApiListNFTsRequest {
3105
+ /**
3106
+ * Contract address
3107
+ * @type {string}
3108
+ * @memberof NftsApiListNFTs
3109
+ */
3110
+ readonly contractAddress: string;
3111
+ /**
3112
+ * The name of chain
3113
+ * @type {string}
3114
+ * @memberof NftsApiListNFTs
3115
+ */
3116
+ readonly chainName: string;
3117
+ /**
3118
+ * List of token IDs to filter by
3119
+ * @type {Array<string>}
3120
+ * @memberof NftsApiListNFTs
3121
+ */
3122
+ readonly tokenId?: Array<string>;
3123
+ /**
3124
+ * Datetime to use as the oldest updated timestamp
3125
+ * @type {string}
3126
+ * @memberof NftsApiListNFTs
3127
+ */
3128
+ readonly fromUpdatedAt?: string;
3129
+ /**
3130
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3131
+ * @type {string}
3132
+ * @memberof NftsApiListNFTs
3133
+ */
3134
+ readonly pageCursor?: string;
3135
+ /**
3136
+ * Maximum number of items to return
3137
+ * @type {number}
3138
+ * @memberof NftsApiListNFTs
3139
+ */
3140
+ readonly pageSize?: number;
3141
+ }
3142
+ /**
3143
+ * Request parameters for listNFTsByAccountAddress operation in NftsApi.
3144
+ * @export
3145
+ * @interface NftsApiListNFTsByAccountAddressRequest
3146
+ */
3147
+ interface NftsApiListNFTsByAccountAddressRequest {
3148
+ /**
3149
+ * Account address
3150
+ * @type {string}
3151
+ * @memberof NftsApiListNFTsByAccountAddress
3152
+ */
3153
+ readonly accountAddress: string;
3154
+ /**
3155
+ * The name of chain
3156
+ * @type {string}
3157
+ * @memberof NftsApiListNFTsByAccountAddress
3158
+ */
3159
+ readonly chainName: string;
3160
+ /**
3161
+ * The address of contract
3162
+ * @type {string}
3163
+ * @memberof NftsApiListNFTsByAccountAddress
3164
+ */
3165
+ readonly contractAddress?: string;
3166
+ /**
3167
+ * Datetime to use as the oldest updated timestamp
3168
+ * @type {string}
3169
+ * @memberof NftsApiListNFTsByAccountAddress
3170
+ */
3171
+ readonly fromUpdatedAt?: string;
3172
+ /**
3173
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3174
+ * @type {string}
3175
+ * @memberof NftsApiListNFTsByAccountAddress
3176
+ */
3177
+ readonly pageCursor?: string;
3178
+ /**
3179
+ * Maximum number of items to return
3180
+ * @type {number}
3181
+ * @memberof NftsApiListNFTsByAccountAddress
3182
+ */
3183
+ readonly pageSize?: number;
3184
+ }
3185
+
3186
+ /**
3187
+ * Request parameters for getERC20Token operation in TokensApi.
3188
+ * @export
3189
+ * @interface TokensApiGetERC20TokenRequest
3190
+ */
3191
+ interface TokensApiGetERC20TokenRequest {
3192
+ /**
3193
+ * The address of contract
3194
+ * @type {string}
3195
+ * @memberof TokensApiGetERC20Token
3196
+ */
3197
+ readonly contractAddress: string;
3198
+ /**
3199
+ * The name of chain
3200
+ * @type {string}
3201
+ * @memberof TokensApiGetERC20Token
3202
+ */
3203
+ readonly chainName: string;
3204
+ }
3205
+ /**
3206
+ * Request parameters for listERC20Tokens operation in TokensApi.
3207
+ * @export
3208
+ * @interface TokensApiListERC20TokensRequest
3209
+ */
3210
+ interface TokensApiListERC20TokensRequest {
3211
+ /**
3212
+ * The name of chain
3213
+ * @type {string}
3214
+ * @memberof TokensApiListERC20Tokens
3215
+ */
3216
+ readonly chainName: string;
3217
+ /**
3218
+ * Datetime to use as the oldest updated timestamp
3219
+ * @type {string}
3220
+ * @memberof TokensApiListERC20Tokens
3221
+ */
3222
+ readonly fromUpdatedAt?: string;
3223
+ /**
3224
+ * List of verification status to filter by
3225
+ * @type {Array<AssetVerificationStatus>}
3226
+ * @memberof TokensApiListERC20Tokens
3227
+ */
3228
+ readonly verificationStatus?: Array<AssetVerificationStatus>;
3229
+ /**
3230
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
3231
+ * @type {string}
3232
+ * @memberof TokensApiListERC20Tokens
3233
+ */
3234
+ readonly pageCursor?: string;
3235
+ /**
3236
+ * Maximum number of items to return
3237
+ * @type {number}
3238
+ * @memberof TokensApiListERC20Tokens
3239
+ */
3240
+ readonly pageSize?: number;
3241
+ }
3242
+
3243
+ declare enum Environment {
3244
+ PRODUCTION = "production",
3245
+ SANDBOX = "sandbox"
3246
+ }
3247
+ declare class ImmutableConfiguration {
3248
+ readonly environment: Environment;
3249
+ readonly rateLimitingKey?: string;
3250
+ readonly apiKey?: string;
3251
+ readonly publishableKey?: string;
3252
+ constructor(options: {
3253
+ environment: Environment;
3254
+ rateLimitingKey?: string;
3255
+ apiKey?: string;
3256
+ publishableKey?: string;
3257
+ });
3258
+ }
3259
+ interface ModuleConfiguration<T> {
3260
+ baseConfig: ImmutableConfiguration;
3261
+ overrides?: T;
3262
+ }
3263
+
3264
+ interface APIConfigurationParams {
3265
+ basePath: string;
3266
+ headers?: Record<string, string>;
3267
+ baseConfig?: ImmutableConfiguration;
3268
+ }
3269
+ interface BlockchainDataModuleConfiguration extends ModuleConfiguration<APIConfigurationParams> {
3270
+ }
3271
+ declare class BlockchainDataConfiguration {
3272
+ readonly apiConfig: Configuration;
3273
+ readonly baseConfig: ImmutableConfiguration;
3274
+ constructor({ baseConfig, overrides }: BlockchainDataModuleConfiguration);
3275
+ }
3276
+
3277
+ declare class BlockchainData {
3278
+ readonly config: BlockchainDataConfiguration;
3279
+ private readonly activities;
3280
+ private readonly chains;
3281
+ private readonly collections;
3282
+ private readonly nfts;
3283
+ private readonly nftOwners;
3284
+ private readonly tokens;
3285
+ private readonly metadata;
3286
+ constructor(moduleConfig: BlockchainDataModuleConfiguration);
3287
+ /**
3288
+ * List all activities
3289
+ * @param request - the request object containing the parameters to be provided in the API request
3290
+ * @returns a promise that resolves with a list of activities
3291
+ * @throws {@link index.APIError}
3292
+ */
3293
+ listActivities(request: ActivitiesApiListActivitiesRequest): Promise<ListActivitiesResult>;
3294
+ /**
3295
+ * List activities sorted by updated_at timestamp ascending, useful for time based data replication
3296
+ * @param request - the request object containing the parameters to be provided in the API request
3297
+ * @returns a promise that resolves with a list of activities
3298
+ * @throws {@link index.APIError}
3299
+ */
3300
+ listActivityHistory(request: ActivitiesApiListActivityHistoryRequest): Promise<ListActivitiesResult>;
3301
+ /**
3302
+ * Get a single activity by ID
3303
+ * @param request - the request object containing the parameters to be provided in the API request
3304
+ * @returns a promise that resolves with a single activity
3305
+ * @throws {@link index.APIError}
3306
+ */
3307
+ getActivity(request: ActivitiesApiGetActivityRequest): Promise<GetActivityResult>;
3308
+ /**
3309
+ * List supported chains
3310
+ * @param request - the request object containing the parameters to be provided in the API request
3311
+ * @returns a promise that resolves with a list of supported chains
3312
+ * @throws {@link index.APIError}
3313
+ */
3314
+ listChains(request: ChainsApiListChainsRequest): Promise<ListChainsResult>;
3315
+ /**
3316
+ * List all collections
3317
+ * @param request - the request object containing the parameters to be provided in the API request
3318
+ * @returns a promise that resolves with a list of collections
3319
+ * @throws {@link index.APIError}
3320
+ */
3321
+ listCollections(request: CollectionsApiListCollectionsRequest): Promise<ListCollectionsResult>;
3322
+ /**
3323
+ * List collections by NFT owner
3324
+ * @param request - the request object containing the parameters to be provided in the API request
3325
+ * @returns a promise that resolves with a list of collections
3326
+ * @throws {@link index.APIError}
3327
+ */
3328
+ listCollectionsByNFTOwner(request: CollectionsApiListCollectionsByNFTOwnerRequest): Promise<ListCollectionsResult>;
3329
+ /**
3330
+ * Get a collection by contract address
3331
+ * @param request - the request object containing the parameters to be provided in the API request
3332
+ * @returns a promise that resolves with a single collection
3333
+ * @throws {@link index.APIError}
3334
+ */
3335
+ getCollection(request: CollectionsApiGetCollectionRequest): Promise<GetCollectionResult>;
3336
+ /**
3337
+ * Get NFT by token ID
3338
+ * @param request - the request object containing the parameters to be provided in the API request
3339
+ * @returns a promise that resolves with a single NFT
3340
+ * @throws {@link index.APIError}
3341
+ */
3342
+ getNFT(request: NftsApiGetNFTRequest): Promise<GetNFTResult>;
3343
+ /**
3344
+ * List NFTs by contract address
3345
+ * @param request - the request object containing the parameters to be provided in the API request
3346
+ * @returns a promise that resolves with a list of NFTs
3347
+ * @throws {@link index.APIError}
3348
+ */
3349
+ listNFTs(request: NftsApiListNFTsRequest): Promise<ListNFTsResult>;
3350
+ /**
3351
+ * List NFTs by account address
3352
+ * @param request - the request object containing the parameters to be provided in the API request
3353
+ * @returns a promise that resolves with a list of NFTs
3354
+ * @throws {@link index.APIError}
3355
+ */
3356
+ listNFTsByAccountAddress(request: NftsApiListNFTsByAccountAddressRequest): Promise<ListNFTsResult>;
3357
+ /**
3358
+ * List All NFTs on a chain
3359
+ * @param request - the request object containing the parameters to be provided in the API request
3360
+ * @returns a promise that resolves with a list of NFTs
3361
+ * @throws {@link index.APIError}
3362
+ */
3363
+ listAllNFTs(request: NftsApiListAllNFTsRequest): Promise<ListNFTsResult>;
3364
+ /**
3365
+ * Create a mint request to mint a set of NFTs for a given collection
3366
+ * @param request - the request object containing the parameters to be provided in the API request
3367
+ * @returns a promise that resolves with the remaining rate limits
3368
+ * @throws {@link index.APIError}
3369
+ */
3370
+ createMintRequest(request: NftsApiCreateMintRequestRequest): Promise<CreateMintRequestResult>;
3371
+ /**
3372
+ * List all mint requests for a given contract address
3373
+ * @param request - the request object containing the parameters to be provided in the API request
3374
+ * @returns a promise that resolves with a list of mint requests
3375
+ * @throws {@link index.APIError}
3376
+ */
3377
+ listMintRequests(request: NftsApiListMintRequestsRequest): Promise<ListMintRequestsResult>;
3378
+ /**
3379
+ * Retrieve the status of a single mint request identified by its reference ID
3380
+ * @param request - the request object containing the parameters to be provided in the API request
3381
+ * @returns a promise that resolves with a single mint request
3382
+ * @throws {@link index.APIError}
3383
+ */
3384
+ getMintRequest(request: NftsApiGetMintRequestRequest): Promise<ListMintRequestsResult>;
3385
+ /**
3386
+ * List NFT owners by token ID
3387
+ * @param request - the request object containing the parameters to be provided in the API request
3388
+ * @returns a promise that resolves with a list of NFT owners
3389
+ * @throws {@link index.APIError}
3390
+ */
3391
+ listNFTOwners(request: NftOwnersApiListNFTOwnersRequest): Promise<ListNFTOwnersResult>;
3392
+ /**
3393
+ * List NFT owners by contract address
3394
+ * @param request - the request object containing the parameters to be provided in the API request
3395
+ * @returns a promise that resolves with a list of NFT owners
3396
+ * @throws {@link index.APIError}
3397
+ */
3398
+ listNFTOwnersByContractAddress(request: NftOwnersApiListOwnersByContractAddressRequest): Promise<ListNFTOwnersResult>;
3399
+ /**
3400
+ * List All NFT owners on a chain
3401
+ * @param request - the request object containing the parameters to be provided in the API request
3402
+ * @returns a promise that resolves with a list of NFT owners
3403
+ * @throws {@link index.APIError}
3404
+ */
3405
+ listAllNFTOwners(request: NftOwnersApiListNFTOwnersRequest): Promise<ListNFTOwnersResult>;
3406
+ /**
3407
+ * List ERC20 Token contracts
3408
+ * @param request - the request object containing the parameters to be provided in the API request
3409
+ * @returns a promise that resolves with a list of ERC20 Tokens
3410
+ * @throws {@link index.APIError}
3411
+ */
3412
+ listTokens(request: TokensApiListERC20TokensRequest): Promise<ListTokensResult>;
3413
+ /**
3414
+ * Get details for an ERC20 Token by contract address
3415
+ * @param request - the request object containing the parameters to be provided in the API request
3416
+ * @returns a promise that resolves with a list of ERC20 Tokens
3417
+ * @throws {@link index.APIError}
3418
+ */
3419
+ getToken(request: TokensApiGetERC20TokenRequest): Promise<GetTokenResult>;
3420
+ /**
3421
+ * Get metadata by ID
3422
+ * @param request - the request object containing the parameters to be provided in the API request
3423
+ * @returns a promise that resolves with a single Metadata
3424
+ * @throws {@link index.APIError}
3425
+ */
3426
+ getMetadata(request: MetadataApiGetMetadataRequest): Promise<GetMetadataResult>;
3427
+ /**
3428
+ * List NFT Metadata by contract address
3429
+ * @param request - the request object containing the parameters to be provided in the API request
3430
+ * @returns a promise that resolves with a list of Metadata
3431
+ * @throws {@link index.APIError}
3432
+ */
3433
+ listNFTMetadataByContractAddress(request: MetadataApiListMetadataRequest): Promise<ListMetadataResult>;
3434
+ /**
3435
+ * List NFT Metadata by chain
3436
+ * @param request - the request object containing the parameters to be provided in the API request
3437
+ * @returns a promise that resolves with a list of Metadata
3438
+ * @throws {@link index.APIError}
3439
+ */
3440
+ listNFTMetadataByChain(request: MetadataApiListMetadataForChainRequest): Promise<ListMetadataResult>;
3441
+ /**
3442
+ * Refresh collection metadata
3443
+ * @param request - the request object containing the parameters to be provided in the API request
3444
+ * @returns a promise that resolves with the updated collection
3445
+ * @throws {@link index.APIError}
3446
+ */
3447
+ refreshCollectionMetadata(request: CollectionsApiRefreshCollectionMetadataRequest): Promise<RefreshCollectionMetadataResult>;
3448
+ /**
3449
+ * Refresh metadata for specific NFTs
3450
+ * @param request - the request object containing the parameters to be provided in the API request
3451
+ * @returns a promise that resolves with the remaining rate limits
3452
+ * @throws {@link index.APIError}
3453
+ */
3454
+ refreshNFTMetadata(request: MetadataApiRefreshNFTMetadataByTokenIDRequest): Promise<MetadataRefreshRateLimitResult>;
3455
+ /**
3456
+ * Refresh metadata by ID. This will refresh metadata for all NFTs that reference the given metadata ID.
3457
+ * @param request - the request object containing the parameters to be provided in the API request
3458
+ * @returns a promise that resolves with the remaining rate limits
3459
+ * @throws {@link index.APIError}
3460
+ */
3461
+ refreshStackedMetadata(request: MetadataApiRefreshMetadataByIDRequest): Promise<MetadataRefreshRateLimitResult>;
3462
+ }
3463
+
3464
+ interface Logger {
3465
+ info: (message: string) => void;
3466
+ error: (message: any) => void;
3467
+ }
3468
+
3469
+ declare const recordMint: (mintingPersistence: MintingPersistence, mintRequest: CreateMintRequest) => Promise<void>;
3470
+ declare const submitMintingRequests: (mintingPersistence: MintingPersistence, blockchainDataSDKClient: BlockchainData, { defaultBatchSize, chainName, maxNumberOfTries, }: {
3471
+ defaultBatchSize?: number | undefined;
3472
+ chainName?: string | undefined;
3473
+ maxNumberOfTries?: number | undefined;
3474
+ }, logger?: Logger) => Promise<never>;
3475
+ type MintRequestEvent = {
3476
+ event_name: string;
3477
+ chain: string;
3478
+ event_id: string;
3479
+ data: {
3480
+ chain: {
3481
+ id: string;
3482
+ name: string;
3483
+ };
3484
+ contract_address: string;
3485
+ owner_address: string;
3486
+ reference_id: string;
3487
+ metadata_id: string;
3488
+ token_id: string | null;
3489
+ status: string;
3490
+ transaction_hash: string | null;
3491
+ activity_id: string | null;
3492
+ error: {
3493
+ code: string;
3494
+ message: string;
3495
+ } | null;
3496
+ created_at: string;
3497
+ updated_at: string;
3498
+ };
3499
+ };
3500
+ declare const processMint: (mintingPersistence: MintingPersistence, event: MintRequestEvent, logger?: Logger) => Promise<void>;
3501
+
3502
+ export { mintingPersistence as mintingPersistencePg, processMint, recordMint, submitMintingRequests };