@imtbl/sdk 1.43.3 → 1.43.4

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