@highlightxyz/sdk 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,29 +1,6 @@
1
1
  export type ClientOptions = {
2
2
  baseUrl: `${string}://${string}` | (string & {});
3
3
  };
4
- export declare enum CollectionType {
5
- OpenEdition = "OpenEdition",
6
- LimitedEdition = "LimitedEdition",
7
- OneOfOne = "OneOfOne",
8
- Series = "Series",
9
- GenerativeSeries = "GenerativeSeries"
10
- }
11
- export declare enum ContractStandard {
12
- Erc721 = "ERC721",
13
- Erc1155 = "ERC1155"
14
- }
15
- export declare enum GenerativeEditionType {
16
- Limited = "Limited",
17
- Open = "Open"
18
- }
19
- export declare enum CaptureSettingsTrigger {
20
- Function = "Function",
21
- Delay = "Delay"
22
- }
23
- export declare enum SelectorType {
24
- Svg = "SVG",
25
- Element = "ELEMENT"
26
- }
27
4
  export declare enum MediaKind {
28
5
  File = "File",
29
6
  Directory = "Directory"
@@ -46,7 +23,8 @@ export declare enum StorageProvider {
46
23
  R2 = "R2",
47
24
  Arweave = "Arweave",
48
25
  S3 = "S3",
49
- Ipfs = "IPFS"
26
+ Ipfs = "IPFS",
27
+ External = "External"
50
28
  }
51
29
  export declare enum StorageRole {
52
30
  Origin = "Origin",
@@ -64,6 +42,7 @@ export type MediaStorageLocation = {
64
42
  provider: StorageProvider;
65
43
  role: StorageRole;
66
44
  reference: string;
45
+ url: string | null;
67
46
  status: LocationStatus;
68
47
  attempts: number;
69
48
  lastError: string | null;
@@ -89,16 +68,61 @@ export type MediaAsset = {
89
68
  path: string | null;
90
69
  uploadedAt: string | null;
91
70
  locations: Array<MediaStorageLocation>;
92
- url: string | null;
93
71
  createdAt: string;
94
72
  updatedAt: string;
95
73
  };
74
+ export declare enum RevealStrategy {
75
+ Noop = "Noop",
76
+ PreAssigned = "PreAssigned",
77
+ Generative = "Generative"
78
+ }
79
+ export declare enum CollectionSource {
80
+ Internal = "Internal",
81
+ External = "External"
82
+ }
83
+ export declare enum CollectionType {
84
+ OpenEdition = "OpenEdition",
85
+ LimitedEdition = "LimitedEdition",
86
+ OneOfOne = "OneOfOne",
87
+ Series = "Series",
88
+ GenerativeSeries = "GenerativeSeries"
89
+ }
90
+ export declare enum ContractStandard {
91
+ Erc721 = "ERC721",
92
+ Erc1155 = "ERC1155"
93
+ }
94
+ export declare enum GenerativeEditionType {
95
+ Limited = "Limited",
96
+ Open = "Open"
97
+ }
98
+ export declare enum CaptureSettingsTrigger {
99
+ Function = "Function",
100
+ Delay = "Delay"
101
+ }
102
+ export declare enum SelectorType {
103
+ Svg = "SVG",
104
+ Element = "ELEMENT"
105
+ }
106
+ export type CollectionCurrencyVolume = {
107
+ currency: string;
108
+ volume: string;
109
+ };
96
110
  export declare enum SaleType {
97
111
  FixedPrice = "FIXED_PRICE",
98
112
  DutchAuction = "DUTCH_AUCTION",
99
113
  RankedAuction = "RANKED_AUCTION",
114
+ EnglishAuction = "ENGLISH_AUCTION",
100
115
  Custom = "CUSTOM"
101
116
  }
117
+ export type SaleCurrency = {
118
+ id: string;
119
+ chainId: number;
120
+ address: string;
121
+ symbol: string;
122
+ decimals: number;
123
+ type: "NATIVE" | "ERC20";
124
+ mintFee: string;
125
+ };
102
126
  export declare enum SaleAccessMode {
103
127
  Public = "PUBLIC",
104
128
  Gated = "GATED"
@@ -107,6 +131,266 @@ export declare enum SaleStatus {
107
131
  Draft = "Draft",
108
132
  Live = "Live"
109
133
  }
134
+ export type SaleStats = {
135
+ minted: number;
136
+ volume: string;
137
+ currency: SaleCurrency;
138
+ };
139
+ export declare enum SaleLifecycle {
140
+ Scheduled = "Scheduled",
141
+ Live = "Live",
142
+ SoldOut = "SoldOut",
143
+ Ended = "Ended",
144
+ Paused = "Paused"
145
+ }
146
+ export type CollectionTrendingItem = {
147
+ rank: number;
148
+ highlightId: string;
149
+ collectionId: string | null;
150
+ name: string;
151
+ imageMedia: MediaAsset | null;
152
+ creator: {
153
+ id: string;
154
+ displayName: string | null;
155
+ primaryAddress: string | null;
156
+ ensName: string | null;
157
+ };
158
+ chainId: number;
159
+ price: string | null;
160
+ currency: SaleCurrency | null;
161
+ mintCount: number;
162
+ };
163
+ export type CollectionTrendingResponse = {
164
+ items: Array<CollectionTrendingItem>;
165
+ };
166
+ export type CollectionFeaturedItem = {
167
+ highlightId: string;
168
+ name: string;
169
+ imageMedia: MediaAsset | null;
170
+ creator: {
171
+ id: string;
172
+ displayName: string | null;
173
+ primaryAddress: string | null;
174
+ ensName: string | null;
175
+ };
176
+ note: string | null;
177
+ };
178
+ export type CollectionFeaturedResponse = {
179
+ items: Array<CollectionFeaturedItem>;
180
+ nextCursor: string | null;
181
+ };
182
+ export type SeriesPreviewEntry = {
183
+ metadataId: number;
184
+ name: string | null;
185
+ description: string | null;
186
+ imageUrl: string | null;
187
+ animationUrl: string | null;
188
+ attributes: Array<{
189
+ traitType: string;
190
+ value: string | number;
191
+ }>;
192
+ };
193
+ export type SeriesPreviewsResponse = {
194
+ items: Array<SeriesPreviewEntry>;
195
+ };
196
+ export type EditionContractExecution = {
197
+ chainId: number;
198
+ to: string | null;
199
+ data: string;
200
+ value: string;
201
+ };
202
+ export type EditionUpdateResponse = {
203
+ collection: {
204
+ highlightId: string;
205
+ collectionId: string | null;
206
+ name: string;
207
+ description: string | null;
208
+ logoMediaId: string;
209
+ logoMedia: MediaAsset;
210
+ baseUriId: string | null;
211
+ royaltyAddress: string | null;
212
+ royaltyAmount: number | null;
213
+ tokenManager: string | null;
214
+ status: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled" | "Archived";
215
+ revealStrategy: RevealStrategy;
216
+ source: CollectionSource;
217
+ type: CollectionType;
218
+ contract: {
219
+ id: string;
220
+ chainId: number;
221
+ type: "GenerativeSeries" | "Series" | "MultipleEditions" | "MultipleEditionsDFS" | "SingleEdition" | "SingleEditionDFS" | "EditionsDFS1155";
222
+ standard: ContractStandard;
223
+ creatorAddress: string;
224
+ name: string;
225
+ address: string | null;
226
+ symbol: string;
227
+ contractUri: string | null;
228
+ status: "Draft" | "Deploying" | "Live";
229
+ createdAt: string;
230
+ updatedAt: string;
231
+ };
232
+ createdAt: string;
233
+ updatedAt: string;
234
+ series: {
235
+ size: number;
236
+ isCollectorsChoice?: boolean;
237
+ assetsMediaId?: string;
238
+ assetsMedia?: MediaAsset | null;
239
+ } | null;
240
+ generative: {
241
+ size: number;
242
+ codeMediaId: string;
243
+ codeMedia: MediaAsset;
244
+ isCurated?: boolean;
245
+ isGpuRendering?: boolean;
246
+ editionType?: GenerativeEditionType;
247
+ allowedHashes?: Array<string>;
248
+ requiredParams?: Array<string>;
249
+ captureSettings?: {
250
+ trigger: CaptureSettingsTrigger;
251
+ delay?: number;
252
+ selector?: string;
253
+ selectorType?: SelectorType;
254
+ viewPortHeight?: number;
255
+ viewPortWidth?: number;
256
+ };
257
+ } | null;
258
+ edition: {
259
+ editionId: string;
260
+ size: number;
261
+ name?: string;
262
+ description?: string;
263
+ imageMediaId?: string;
264
+ animationMediaId?: string;
265
+ imageMedia?: MediaAsset | null;
266
+ animationMedia?: MediaAsset | null;
267
+ attributes?: Array<{
268
+ traitType: string;
269
+ value: string;
270
+ }>;
271
+ } | null;
272
+ account: {
273
+ id: string;
274
+ displayName: string | null;
275
+ primaryAddress: string | null;
276
+ ensName: string | null;
277
+ };
278
+ stats: {
279
+ ownerCount: number;
280
+ tokenCount: number;
281
+ volumeByCurrency: Array<CollectionCurrencyVolume>;
282
+ updatedAt: string;
283
+ } | null;
284
+ sales: Array<{
285
+ id: string;
286
+ collectionId: string;
287
+ name: string | null;
288
+ type: SaleType;
289
+ startAt: string;
290
+ endAt: string | null;
291
+ price: string;
292
+ currency: SaleCurrency;
293
+ maxPerTransaction: number;
294
+ maxPerWallet: number;
295
+ maxTotal: number;
296
+ paymentRecipient: string;
297
+ accessMode: SaleAccessMode;
298
+ gateId: string | null;
299
+ gasSponsored: boolean;
300
+ status: SaleStatus;
301
+ paused: boolean;
302
+ mechanicId: string | null;
303
+ typeConfig: unknown | null;
304
+ vectorId: string | null;
305
+ customMintFee: string | null;
306
+ collectorMessage: string | null;
307
+ createdAt: string;
308
+ updatedAt: string;
309
+ stats: SaleStats | null;
310
+ lifecycle: SaleLifecycle;
311
+ }>;
312
+ };
313
+ contractExecution: EditionContractExecution | null;
314
+ };
315
+ export type RankedAuctionStandingBid = {
316
+ bidId: number;
317
+ bidderAddress: string;
318
+ bidAmount: string;
319
+ won: boolean;
320
+ };
321
+ export type RankedAuctionViewerStanding = {
322
+ address: string;
323
+ numWinningBids: number;
324
+ numClaimed: number;
325
+ tokensLeftToClaim: number;
326
+ };
327
+ export type RankedAuctionStandings = {
328
+ saleId: string;
329
+ settled: boolean;
330
+ clearingBidAmount: string | null;
331
+ currency: SaleCurrency;
332
+ maxWinners: number;
333
+ totalBids: number;
334
+ bids: Array<RankedAuctionStandingBid>;
335
+ viewer: RankedAuctionViewerStanding | null;
336
+ };
337
+ export type EnglishAuctionViewerStanding = {
338
+ address: string;
339
+ isHighestBidder: boolean;
340
+ };
341
+ export type EnglishAuctionStanding = {
342
+ saleId: string;
343
+ state: number;
344
+ live: boolean;
345
+ fulfilled: boolean;
346
+ cancelled: boolean;
347
+ currency: SaleCurrency;
348
+ reservePrice: string;
349
+ highestBidder: string | null;
350
+ highestBidAmount: string;
351
+ preferredNftRecipient: string | null;
352
+ endTime: number;
353
+ tokenId: string | null;
354
+ creatorEarnings: string;
355
+ platformBps: number;
356
+ totalBids: number;
357
+ viewer: EnglishAuctionViewerStanding | null;
358
+ };
359
+ export type EnglishAuctionBidEntry = {
360
+ bidderAddress: string;
361
+ bidAmount: string;
362
+ firstBid: boolean;
363
+ txHash: string;
364
+ blockNumber: number;
365
+ createdAt: string;
366
+ };
367
+ export type EnglishAuctionBidHistory = {
368
+ saleId: string;
369
+ currency: SaleCurrency;
370
+ bids: Array<EnglishAuctionBidEntry>;
371
+ };
372
+ export declare enum TokenStatus {
373
+ PendingReveal = "PendingReveal",
374
+ PendingIndex = "PendingIndex",
375
+ Ready = "Ready",
376
+ FailedReveal = "FailedReveal",
377
+ FailedIndex = "FailedIndex"
378
+ }
379
+ export type TokenAttributeFacet = {
380
+ traitType: string;
381
+ values: Array<{
382
+ value: string;
383
+ count: number;
384
+ }>;
385
+ };
386
+ export type TokenOwner = {
387
+ ownerAddress: string;
388
+ balance: string;
389
+ firstAcquiredAt: string;
390
+ };
391
+ export type TokenOwnersResponse = {
392
+ owners: Array<TokenOwner>;
393
+ };
110
394
  export declare enum GateMatchMode {
111
395
  All = "ALL",
112
396
  Any = "ANY"
@@ -119,6 +403,48 @@ export declare enum GateConditionType {
119
403
  CurrencyBalance = "CURRENCY_BALANCE",
120
404
  FarcasterFollow = "FARCASTER_FOLLOW"
121
405
  }
406
+ export type GateCollectionPreview = {
407
+ source: "highlight" | "external";
408
+ chainId: number;
409
+ contractAddress: string;
410
+ name: string | null;
411
+ symbol: string | null;
412
+ standard: "ERC721" | "ERC1155" | null;
413
+ tokenCount: number | null;
414
+ imageUrl: string | null;
415
+ };
416
+ export type GateAttributesPreview = {
417
+ source: "highlight" | "external";
418
+ attributes: Array<{
419
+ traitType: string;
420
+ values: Array<{
421
+ value: string;
422
+ count: number | null;
423
+ }>;
424
+ }>;
425
+ };
426
+ export type GateTokensPreview = {
427
+ source: "highlight" | "external";
428
+ tokens: Array<{
429
+ tokenId: string;
430
+ name: string | null;
431
+ imageUrl: string | null;
432
+ }>;
433
+ nextCursor: string | null;
434
+ };
435
+ export type GateCurrencyPreview = {
436
+ chainId: number;
437
+ contractAddress: string | null;
438
+ isNative: boolean;
439
+ symbol: string;
440
+ decimals: number;
441
+ };
442
+ export type GateFarcasterUserPreview = {
443
+ fid: number;
444
+ username: string | null;
445
+ displayName: string | null;
446
+ pfpUrl: string | null;
447
+ };
122
448
  export type MediaUploadInstructions = {
123
449
  url: string;
124
450
  method: "PUT";
@@ -134,6 +460,50 @@ export type MediaChildrenList = {
134
460
  items: Array<MediaAsset>;
135
461
  nextCursor: string | null;
136
462
  };
463
+ export declare enum TxOverallStatus {
464
+ Pending = "Pending",
465
+ Finalizing = "Finalizing",
466
+ Ready = "Ready",
467
+ Failed = "Failed"
468
+ }
469
+ export declare enum TxMilestoneKey {
470
+ CollectionLive = "collection:live",
471
+ SaleLive = "sale:live",
472
+ SaleUpdated = "sale:updated",
473
+ BidRecorded = "bid:recorded",
474
+ DutchSynced = "dutch:synced",
475
+ AuctionSynced = "auction:synced",
476
+ EditionUpdated = "edition:updated",
477
+ TokensReady = "tokens:ready"
478
+ }
479
+ export declare enum TxMilestoneStatus {
480
+ Pending = "Pending",
481
+ Done = "Done",
482
+ Failed = "Failed"
483
+ }
484
+ export declare enum TxUnitStatus {
485
+ Pending = "Pending",
486
+ Done = "Done",
487
+ Failed = "Failed"
488
+ }
489
+ export type TxUnit = {
490
+ id: string;
491
+ ref?: string;
492
+ status: TxUnitStatus;
493
+ };
494
+ export type TxMilestone = {
495
+ key: TxMilestoneKey;
496
+ status: TxMilestoneStatus;
497
+ units?: Array<TxUnit>;
498
+ };
499
+ export type TxStatusSnapshot = {
500
+ chainId: number;
501
+ txHash: string;
502
+ initialized: boolean;
503
+ finalized: boolean;
504
+ overall: TxOverallStatus;
505
+ milestones: Array<TxMilestone>;
506
+ };
137
507
  export type ApiKey = {
138
508
  id: string;
139
509
  accountId: string;
@@ -154,15 +524,15 @@ export type ApiKeyCreateResponse = {
154
524
  export type CollectionListData = {
155
525
  body?: never;
156
526
  path?: never;
157
- query: {
527
+ query?: {
158
528
  page?: number;
159
529
  limit?: number;
160
530
  sortBy?: "CREATED_DATE" | "NAME";
161
531
  sortDirection?: "ASC" | "DESC";
162
532
  status?: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled";
163
- blockchains: Array<number>;
164
- testnet: boolean;
165
- types: Array<"OpenEdition" | "LimitedEdition" | "OneOfOne" | "Series" | "GenerativeSeries">;
533
+ blockchains?: Array<number>;
534
+ testnet?: boolean;
535
+ types?: Array<"OpenEdition" | "LimitedEdition" | "OneOfOne" | "Series" | "GenerativeSeries">;
166
536
  };
167
537
  url: "/collection";
168
538
  };
@@ -183,11 +553,14 @@ export type CollectionListResponses = {
183
553
  name: string;
184
554
  description: string | null;
185
555
  logoMediaId: string;
556
+ logoMedia: MediaAsset;
186
557
  baseUriId: string | null;
187
558
  royaltyAddress: string | null;
188
559
  royaltyAmount: number | null;
189
560
  tokenManager: string | null;
190
- status: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled";
561
+ status: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled" | "Archived";
562
+ revealStrategy: RevealStrategy;
563
+ source: CollectionSource;
191
564
  type: CollectionType;
192
565
  contract: {
193
566
  id: string;
@@ -205,17 +578,16 @@ export type CollectionListResponses = {
205
578
  };
206
579
  createdAt: string;
207
580
  updatedAt: string;
208
- archivedAt: string | null;
209
- hidden: boolean | null;
210
- disabled: boolean | null;
211
581
  series: {
212
582
  size: number;
213
583
  isCollectorsChoice?: boolean;
214
584
  assetsMediaId?: string;
585
+ assetsMedia?: MediaAsset | null;
215
586
  } | null;
216
587
  generative: {
217
588
  size: number;
218
589
  codeMediaId: string;
590
+ codeMedia: MediaAsset;
219
591
  isCurated?: boolean;
220
592
  isGpuRendering?: boolean;
221
593
  editionType?: GenerativeEditionType;
@@ -231,6 +603,7 @@ export type CollectionListResponses = {
231
603
  };
232
604
  } | null;
233
605
  edition: {
606
+ editionId: string;
234
607
  size: number;
235
608
  name?: string;
236
609
  description?: string;
@@ -250,10 +623,9 @@ export type CollectionListResponses = {
250
623
  ensName: string | null;
251
624
  };
252
625
  stats: {
253
- volume: string;
254
- volumeUsd: string | null;
255
626
  ownerCount: number;
256
627
  tokenCount: number;
628
+ volumeByCurrency: Array<CollectionCurrencyVolume>;
257
629
  updatedAt: string;
258
630
  } | null;
259
631
  sales: Array<{
@@ -264,7 +636,7 @@ export type CollectionListResponses = {
264
636
  startAt: string;
265
637
  endAt: string | null;
266
638
  price: string;
267
- currency: string;
639
+ currency: SaleCurrency;
268
640
  maxPerTransaction: number;
269
641
  maxPerWallet: number;
270
642
  maxTotal: number;
@@ -281,6 +653,8 @@ export type CollectionListResponses = {
281
653
  collectorMessage: string | null;
282
654
  createdAt: string;
283
655
  updatedAt: string;
656
+ stats: SaleStats | null;
657
+ lifecycle: SaleLifecycle;
284
658
  }>;
285
659
  }>;
286
660
  pageInfo: {
@@ -346,11 +720,14 @@ export type CollectionCreateResponses = {
346
720
  name: string;
347
721
  description: string | null;
348
722
  logoMediaId: string;
723
+ logoMedia: MediaAsset;
349
724
  baseUriId: string | null;
350
725
  royaltyAddress: string | null;
351
726
  royaltyAmount: number | null;
352
727
  tokenManager: string | null;
353
- status: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled";
728
+ status: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled" | "Archived";
729
+ revealStrategy: RevealStrategy;
730
+ source: CollectionSource;
354
731
  type: CollectionType;
355
732
  contract: {
356
733
  id: string;
@@ -368,17 +745,16 @@ export type CollectionCreateResponses = {
368
745
  };
369
746
  createdAt: string;
370
747
  updatedAt: string;
371
- archivedAt: string | null;
372
- hidden: boolean | null;
373
- disabled: boolean | null;
374
748
  series: {
375
749
  size: number;
376
750
  isCollectorsChoice?: boolean;
377
751
  assetsMediaId?: string;
752
+ assetsMedia?: MediaAsset | null;
378
753
  } | null;
379
754
  generative: {
380
755
  size: number;
381
756
  codeMediaId: string;
757
+ codeMedia: MediaAsset;
382
758
  isCurated?: boolean;
383
759
  isGpuRendering?: boolean;
384
760
  editionType?: GenerativeEditionType;
@@ -394,6 +770,7 @@ export type CollectionCreateResponses = {
394
770
  };
395
771
  } | null;
396
772
  edition: {
773
+ editionId: string;
397
774
  size: number;
398
775
  name?: string;
399
776
  description?: string;
@@ -413,10 +790,9 @@ export type CollectionCreateResponses = {
413
790
  ensName: string | null;
414
791
  };
415
792
  stats: {
416
- volume: string;
417
- volumeUsd: string | null;
418
793
  ownerCount: number;
419
794
  tokenCount: number;
795
+ volumeByCurrency: Array<CollectionCurrencyVolume>;
420
796
  updatedAt: string;
421
797
  } | null;
422
798
  sales: Array<{
@@ -427,7 +803,7 @@ export type CollectionCreateResponses = {
427
803
  startAt: string;
428
804
  endAt: string | null;
429
805
  price: string;
430
- currency: string;
806
+ currency: SaleCurrency;
431
807
  maxPerTransaction: number;
432
808
  maxPerWallet: number;
433
809
  maxTotal: number;
@@ -444,14 +820,61 @@ export type CollectionCreateResponses = {
444
820
  collectorMessage: string | null;
445
821
  createdAt: string;
446
822
  updatedAt: string;
823
+ stats: SaleStats | null;
824
+ lifecycle: SaleLifecycle;
447
825
  }>;
448
826
  };
449
827
  };
450
828
  export type CollectionCreateResponse = CollectionCreateResponses[keyof CollectionCreateResponses];
829
+ export type CollectionTrendingData = {
830
+ body?: never;
831
+ path?: never;
832
+ query?: {
833
+ window?: "24h" | "7d" | "28d";
834
+ chainId?: number;
835
+ limit?: number;
836
+ };
837
+ url: "/collection/trending";
838
+ };
839
+ export type CollectionTrendingErrors = {
840
+ /**
841
+ * Invalid request
842
+ */
843
+ 400: unknown;
844
+ };
845
+ export type CollectionTrendingResponses = {
846
+ /**
847
+ * Ranked trending collections
848
+ */
849
+ 200: CollectionTrendingResponse;
850
+ };
851
+ export type CollectionTrendingResponse2 = CollectionTrendingResponses[keyof CollectionTrendingResponses];
852
+ export type CollectionFeaturedData = {
853
+ body?: never;
854
+ path?: never;
855
+ query?: {
856
+ limit?: number;
857
+ cursor?: string;
858
+ };
859
+ url: "/collection/featured";
860
+ };
861
+ export type CollectionFeaturedErrors = {
862
+ /**
863
+ * Invalid request
864
+ */
865
+ 400: unknown;
866
+ };
867
+ export type CollectionFeaturedResponses = {
868
+ /**
869
+ * Curated featured collections
870
+ */
871
+ 200: CollectionFeaturedResponse;
872
+ };
873
+ export type CollectionFeaturedResponse2 = CollectionFeaturedResponses[keyof CollectionFeaturedResponses];
451
874
  export type CollectionGetData = {
452
875
  body?: never;
453
876
  path: {
454
- highlightId: string;
877
+ highlightId: string | string;
455
878
  };
456
879
  query?: never;
457
880
  url: "/collection/{highlightId}";
@@ -476,11 +899,14 @@ export type CollectionGetResponses = {
476
899
  name: string;
477
900
  description: string | null;
478
901
  logoMediaId: string;
902
+ logoMedia: MediaAsset;
479
903
  baseUriId: string | null;
480
904
  royaltyAddress: string | null;
481
905
  royaltyAmount: number | null;
482
906
  tokenManager: string | null;
483
- status: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled";
907
+ status: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled" | "Archived";
908
+ revealStrategy: RevealStrategy;
909
+ source: CollectionSource;
484
910
  type: CollectionType;
485
911
  contract: {
486
912
  id: string;
@@ -498,17 +924,16 @@ export type CollectionGetResponses = {
498
924
  };
499
925
  createdAt: string;
500
926
  updatedAt: string;
501
- archivedAt: string | null;
502
- hidden: boolean | null;
503
- disabled: boolean | null;
504
927
  series: {
505
928
  size: number;
506
929
  isCollectorsChoice?: boolean;
507
930
  assetsMediaId?: string;
931
+ assetsMedia?: MediaAsset | null;
508
932
  } | null;
509
933
  generative: {
510
934
  size: number;
511
935
  codeMediaId: string;
936
+ codeMedia: MediaAsset;
512
937
  isCurated?: boolean;
513
938
  isGpuRendering?: boolean;
514
939
  editionType?: GenerativeEditionType;
@@ -524,6 +949,7 @@ export type CollectionGetResponses = {
524
949
  };
525
950
  } | null;
526
951
  edition: {
952
+ editionId: string;
527
953
  size: number;
528
954
  name?: string;
529
955
  description?: string;
@@ -543,10 +969,9 @@ export type CollectionGetResponses = {
543
969
  ensName: string | null;
544
970
  };
545
971
  stats: {
546
- volume: string;
547
- volumeUsd: string | null;
548
972
  ownerCount: number;
549
973
  tokenCount: number;
974
+ volumeByCurrency: Array<CollectionCurrencyVolume>;
550
975
  updatedAt: string;
551
976
  } | null;
552
977
  sales: Array<{
@@ -557,7 +982,7 @@ export type CollectionGetResponses = {
557
982
  startAt: string;
558
983
  endAt: string | null;
559
984
  price: string;
560
- currency: string;
985
+ currency: SaleCurrency;
561
986
  maxPerTransaction: number;
562
987
  maxPerWallet: number;
563
988
  maxTotal: number;
@@ -574,10 +999,39 @@ export type CollectionGetResponses = {
574
999
  collectorMessage: string | null;
575
1000
  createdAt: string;
576
1001
  updatedAt: string;
1002
+ stats: SaleStats | null;
1003
+ lifecycle: SaleLifecycle;
577
1004
  }>;
578
1005
  };
579
1006
  };
580
1007
  export type CollectionGetResponse = CollectionGetResponses[keyof CollectionGetResponses];
1008
+ export type CollectionListPreviewsData = {
1009
+ body?: never;
1010
+ path: {
1011
+ highlightId: string;
1012
+ };
1013
+ query?: {
1014
+ limit?: number;
1015
+ };
1016
+ url: "/collection/{highlightId}/previews";
1017
+ };
1018
+ export type CollectionListPreviewsErrors = {
1019
+ /**
1020
+ * Forbidden
1021
+ */
1022
+ 403: unknown;
1023
+ /**
1024
+ * Not found
1025
+ */
1026
+ 404: unknown;
1027
+ };
1028
+ export type CollectionListPreviewsResponses = {
1029
+ /**
1030
+ * Series previews
1031
+ */
1032
+ 200: SeriesPreviewsResponse;
1033
+ };
1034
+ export type CollectionListPreviewsResponse = CollectionListPreviewsResponses[keyof CollectionListPreviewsResponses];
581
1035
  export type CollectionFinalizeBaseUriData = {
582
1036
  body?: never;
583
1037
  path: {
@@ -618,11 +1072,14 @@ export type CollectionFinalizeBaseUriResponses = {
618
1072
  name: string;
619
1073
  description: string | null;
620
1074
  logoMediaId: string;
1075
+ logoMedia: MediaAsset;
621
1076
  baseUriId: string | null;
622
1077
  royaltyAddress: string | null;
623
1078
  royaltyAmount: number | null;
624
1079
  tokenManager: string | null;
625
- status: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled";
1080
+ status: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled" | "Archived";
1081
+ revealStrategy: RevealStrategy;
1082
+ source: CollectionSource;
626
1083
  type: CollectionType;
627
1084
  contract: {
628
1085
  id: string;
@@ -640,17 +1097,16 @@ export type CollectionFinalizeBaseUriResponses = {
640
1097
  };
641
1098
  createdAt: string;
642
1099
  updatedAt: string;
643
- archivedAt: string | null;
644
- hidden: boolean | null;
645
- disabled: boolean | null;
646
1100
  series: {
647
1101
  size: number;
648
1102
  isCollectorsChoice?: boolean;
649
1103
  assetsMediaId?: string;
1104
+ assetsMedia?: MediaAsset | null;
650
1105
  } | null;
651
1106
  generative: {
652
1107
  size: number;
653
1108
  codeMediaId: string;
1109
+ codeMedia: MediaAsset;
654
1110
  isCurated?: boolean;
655
1111
  isGpuRendering?: boolean;
656
1112
  editionType?: GenerativeEditionType;
@@ -666,6 +1122,7 @@ export type CollectionFinalizeBaseUriResponses = {
666
1122
  };
667
1123
  } | null;
668
1124
  edition: {
1125
+ editionId: string;
669
1126
  size: number;
670
1127
  name?: string;
671
1128
  description?: string;
@@ -685,10 +1142,9 @@ export type CollectionFinalizeBaseUriResponses = {
685
1142
  ensName: string | null;
686
1143
  };
687
1144
  stats: {
688
- volume: string;
689
- volumeUsd: string | null;
690
1145
  ownerCount: number;
691
1146
  tokenCount: number;
1147
+ volumeByCurrency: Array<CollectionCurrencyVolume>;
692
1148
  updatedAt: string;
693
1149
  } | null;
694
1150
  sales: Array<{
@@ -699,7 +1155,7 @@ export type CollectionFinalizeBaseUriResponses = {
699
1155
  startAt: string;
700
1156
  endAt: string | null;
701
1157
  price: string;
702
- currency: string;
1158
+ currency: SaleCurrency;
703
1159
  maxPerTransaction: number;
704
1160
  maxPerWallet: number;
705
1161
  maxTotal: number;
@@ -716,6 +1172,8 @@ export type CollectionFinalizeBaseUriResponses = {
716
1172
  collectorMessage: string | null;
717
1173
  createdAt: string;
718
1174
  updatedAt: string;
1175
+ stats: SaleStats | null;
1176
+ lifecycle: SaleLifecycle;
719
1177
  }>;
720
1178
  };
721
1179
  };
@@ -774,11 +1232,14 @@ export type CollectionUpdateGenerativeDetailsResponses = {
774
1232
  name: string;
775
1233
  description: string | null;
776
1234
  logoMediaId: string;
1235
+ logoMedia: MediaAsset;
777
1236
  baseUriId: string | null;
778
1237
  royaltyAddress: string | null;
779
1238
  royaltyAmount: number | null;
780
1239
  tokenManager: string | null;
781
- status: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled";
1240
+ status: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled" | "Archived";
1241
+ revealStrategy: RevealStrategy;
1242
+ source: CollectionSource;
782
1243
  type: CollectionType;
783
1244
  contract: {
784
1245
  id: string;
@@ -796,17 +1257,16 @@ export type CollectionUpdateGenerativeDetailsResponses = {
796
1257
  };
797
1258
  createdAt: string;
798
1259
  updatedAt: string;
799
- archivedAt: string | null;
800
- hidden: boolean | null;
801
- disabled: boolean | null;
802
1260
  series: {
803
1261
  size: number;
804
1262
  isCollectorsChoice?: boolean;
805
1263
  assetsMediaId?: string;
1264
+ assetsMedia?: MediaAsset | null;
806
1265
  } | null;
807
1266
  generative: {
808
1267
  size: number;
809
1268
  codeMediaId: string;
1269
+ codeMedia: MediaAsset;
810
1270
  isCurated?: boolean;
811
1271
  isGpuRendering?: boolean;
812
1272
  editionType?: GenerativeEditionType;
@@ -822,6 +1282,7 @@ export type CollectionUpdateGenerativeDetailsResponses = {
822
1282
  };
823
1283
  } | null;
824
1284
  edition: {
1285
+ editionId: string;
825
1286
  size: number;
826
1287
  name?: string;
827
1288
  description?: string;
@@ -841,10 +1302,9 @@ export type CollectionUpdateGenerativeDetailsResponses = {
841
1302
  ensName: string | null;
842
1303
  };
843
1304
  stats: {
844
- volume: string;
845
- volumeUsd: string | null;
846
1305
  ownerCount: number;
847
1306
  tokenCount: number;
1307
+ volumeByCurrency: Array<CollectionCurrencyVolume>;
848
1308
  updatedAt: string;
849
1309
  } | null;
850
1310
  sales: Array<{
@@ -855,7 +1315,7 @@ export type CollectionUpdateGenerativeDetailsResponses = {
855
1315
  startAt: string;
856
1316
  endAt: string | null;
857
1317
  price: string;
858
- currency: string;
1318
+ currency: SaleCurrency;
859
1319
  maxPerTransaction: number;
860
1320
  maxPerWallet: number;
861
1321
  maxTotal: number;
@@ -872,6 +1332,8 @@ export type CollectionUpdateGenerativeDetailsResponses = {
872
1332
  collectorMessage: string | null;
873
1333
  createdAt: string;
874
1334
  updatedAt: string;
1335
+ stats: SaleStats | null;
1336
+ lifecycle: SaleLifecycle;
875
1337
  }>;
876
1338
  };
877
1339
  };
@@ -918,11 +1380,14 @@ export type CollectionUpdateSeriesDetailsResponses = {
918
1380
  name: string;
919
1381
  description: string | null;
920
1382
  logoMediaId: string;
1383
+ logoMedia: MediaAsset;
921
1384
  baseUriId: string | null;
922
1385
  royaltyAddress: string | null;
923
1386
  royaltyAmount: number | null;
924
1387
  tokenManager: string | null;
925
- status: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled";
1388
+ status: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled" | "Archived";
1389
+ revealStrategy: RevealStrategy;
1390
+ source: CollectionSource;
926
1391
  type: CollectionType;
927
1392
  contract: {
928
1393
  id: string;
@@ -940,17 +1405,16 @@ export type CollectionUpdateSeriesDetailsResponses = {
940
1405
  };
941
1406
  createdAt: string;
942
1407
  updatedAt: string;
943
- archivedAt: string | null;
944
- hidden: boolean | null;
945
- disabled: boolean | null;
946
1408
  series: {
947
1409
  size: number;
948
1410
  isCollectorsChoice?: boolean;
949
1411
  assetsMediaId?: string;
1412
+ assetsMedia?: MediaAsset | null;
950
1413
  } | null;
951
1414
  generative: {
952
1415
  size: number;
953
1416
  codeMediaId: string;
1417
+ codeMedia: MediaAsset;
954
1418
  isCurated?: boolean;
955
1419
  isGpuRendering?: boolean;
956
1420
  editionType?: GenerativeEditionType;
@@ -966,6 +1430,7 @@ export type CollectionUpdateSeriesDetailsResponses = {
966
1430
  };
967
1431
  } | null;
968
1432
  edition: {
1433
+ editionId: string;
969
1434
  size: number;
970
1435
  name?: string;
971
1436
  description?: string;
@@ -985,10 +1450,9 @@ export type CollectionUpdateSeriesDetailsResponses = {
985
1450
  ensName: string | null;
986
1451
  };
987
1452
  stats: {
988
- volume: string;
989
- volumeUsd: string | null;
990
1453
  ownerCount: number;
991
1454
  tokenCount: number;
1455
+ volumeByCurrency: Array<CollectionCurrencyVolume>;
992
1456
  updatedAt: string;
993
1457
  } | null;
994
1458
  sales: Array<{
@@ -999,7 +1463,7 @@ export type CollectionUpdateSeriesDetailsResponses = {
999
1463
  startAt: string;
1000
1464
  endAt: string | null;
1001
1465
  price: string;
1002
- currency: string;
1466
+ currency: SaleCurrency;
1003
1467
  maxPerTransaction: number;
1004
1468
  maxPerWallet: number;
1005
1469
  maxTotal: number;
@@ -1016,6 +1480,8 @@ export type CollectionUpdateSeriesDetailsResponses = {
1016
1480
  collectorMessage: string | null;
1017
1481
  createdAt: string;
1018
1482
  updatedAt: string;
1483
+ stats: SaleStats | null;
1484
+ lifecycle: SaleLifecycle;
1019
1485
  }>;
1020
1486
  };
1021
1487
  };
@@ -1057,117 +1523,16 @@ export type CollectionUpdateEditionDetailsErrors = {
1057
1523
  * Not found
1058
1524
  */
1059
1525
  404: unknown;
1526
+ /**
1527
+ * Metadata archive provider unavailable
1528
+ */
1529
+ 503: unknown;
1060
1530
  };
1061
1531
  export type CollectionUpdateEditionDetailsResponses = {
1062
1532
  /**
1063
- * Updated edition draft details
1533
+ * Updated edition details (draft) or a transaction to sign (live)
1064
1534
  */
1065
- 200: {
1066
- highlightId: string;
1067
- collectionId: string | null;
1068
- name: string;
1069
- description: string | null;
1070
- logoMediaId: string;
1071
- baseUriId: string | null;
1072
- royaltyAddress: string | null;
1073
- royaltyAmount: number | null;
1074
- tokenManager: string | null;
1075
- status: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled";
1076
- type: CollectionType;
1077
- contract: {
1078
- id: string;
1079
- chainId: number;
1080
- type: "GenerativeSeries" | "Series" | "MultipleEditions" | "MultipleEditionsDFS" | "SingleEdition" | "SingleEditionDFS" | "EditionsDFS1155";
1081
- standard: ContractStandard;
1082
- creatorAddress: string;
1083
- name: string;
1084
- address: string | null;
1085
- symbol: string;
1086
- contractUri: string | null;
1087
- status: "Draft" | "Deploying" | "Live";
1088
- createdAt: string;
1089
- updatedAt: string;
1090
- };
1091
- createdAt: string;
1092
- updatedAt: string;
1093
- archivedAt: string | null;
1094
- hidden: boolean | null;
1095
- disabled: boolean | null;
1096
- series: {
1097
- size: number;
1098
- isCollectorsChoice?: boolean;
1099
- assetsMediaId?: string;
1100
- } | null;
1101
- generative: {
1102
- size: number;
1103
- codeMediaId: string;
1104
- isCurated?: boolean;
1105
- isGpuRendering?: boolean;
1106
- editionType?: GenerativeEditionType;
1107
- allowedHashes?: Array<string>;
1108
- requiredParams?: Array<string>;
1109
- captureSettings?: {
1110
- trigger: CaptureSettingsTrigger;
1111
- delay?: number;
1112
- selector?: string;
1113
- selectorType?: SelectorType;
1114
- viewPortHeight?: number;
1115
- viewPortWidth?: number;
1116
- };
1117
- } | null;
1118
- edition: {
1119
- size: number;
1120
- name?: string;
1121
- description?: string;
1122
- imageMediaId?: string;
1123
- animationMediaId?: string;
1124
- imageMedia?: MediaAsset | null;
1125
- animationMedia?: MediaAsset | null;
1126
- attributes?: Array<{
1127
- traitType: string;
1128
- value: string;
1129
- }>;
1130
- } | null;
1131
- account: {
1132
- id: string;
1133
- displayName: string | null;
1134
- primaryAddress: string | null;
1135
- ensName: string | null;
1136
- };
1137
- stats: {
1138
- volume: string;
1139
- volumeUsd: string | null;
1140
- ownerCount: number;
1141
- tokenCount: number;
1142
- updatedAt: string;
1143
- } | null;
1144
- sales: Array<{
1145
- id: string;
1146
- collectionId: string;
1147
- name: string | null;
1148
- type: SaleType;
1149
- startAt: string;
1150
- endAt: string | null;
1151
- price: string;
1152
- currency: string;
1153
- maxPerTransaction: number;
1154
- maxPerWallet: number;
1155
- maxTotal: number;
1156
- paymentRecipient: string;
1157
- accessMode: SaleAccessMode;
1158
- gateId: string | null;
1159
- gasSponsored: boolean;
1160
- status: SaleStatus;
1161
- paused: boolean;
1162
- mechanicId: string | null;
1163
- typeConfig: unknown | null;
1164
- vectorId: string | null;
1165
- customMintFee: string | null;
1166
- collectorMessage: string | null;
1167
- createdAt: string;
1168
- updatedAt: string;
1169
- }>;
1170
- };
1535
+ 200: EditionUpdateResponse;
1171
1536
  };
1172
1537
  export type CollectionUpdateEditionDetailsResponse = CollectionUpdateEditionDetailsResponses[keyof CollectionUpdateEditionDetailsResponses];
1173
1538
  export type CollectionGetSalesData = {
@@ -1204,7 +1569,7 @@ export type CollectionGetSalesResponses = {
1204
1569
  startAt: string;
1205
1570
  endAt: string | null;
1206
1571
  price: string;
1207
- currency: string;
1572
+ currency: SaleCurrency;
1208
1573
  maxPerTransaction: number;
1209
1574
  maxPerWallet: number;
1210
1575
  maxTotal: number;
@@ -1221,6 +1586,8 @@ export type CollectionGetSalesResponses = {
1221
1586
  collectorMessage: string | null;
1222
1587
  createdAt: string;
1223
1588
  updatedAt: string;
1589
+ stats: SaleStats | null;
1590
+ lifecycle: SaleLifecycle;
1224
1591
  }>;
1225
1592
  };
1226
1593
  export type CollectionGetSalesResponse = CollectionGetSalesResponses[keyof CollectionGetSalesResponses];
@@ -1425,6 +1792,7 @@ export type CollectionBidSaleData = {
1425
1792
  saleId: string;
1426
1793
  bidAmount: string;
1427
1794
  bidId?: number;
1795
+ preferredNftRecipient?: string;
1428
1796
  };
1429
1797
  path: {
1430
1798
  highlightId: string;
@@ -1448,7 +1816,202 @@ export type CollectionBidSaleErrors = {
1448
1816
  };
1449
1817
  export type CollectionBidSaleResponses = {
1450
1818
  /**
1451
- * Bid transaction configuration
1819
+ * Bid transaction configuration
1820
+ */
1821
+ 200: {
1822
+ chainId: number;
1823
+ to: string | null;
1824
+ data: string;
1825
+ value: string;
1826
+ };
1827
+ };
1828
+ export type CollectionBidSaleResponse = CollectionBidSaleResponses[keyof CollectionBidSaleResponses];
1829
+ export type CollectionReclaimBidData = {
1830
+ body: {
1831
+ saleId: string;
1832
+ bidId: number;
1833
+ };
1834
+ path: {
1835
+ highlightId: string;
1836
+ };
1837
+ query?: never;
1838
+ url: "/collection/{highlightId}/sales/reclaim";
1839
+ };
1840
+ export type CollectionReclaimBidErrors = {
1841
+ /**
1842
+ * Invalid request
1843
+ */
1844
+ 400: unknown;
1845
+ /**
1846
+ * Unauthorized
1847
+ */
1848
+ 401: unknown;
1849
+ /**
1850
+ * Not found
1851
+ */
1852
+ 404: unknown;
1853
+ /**
1854
+ * Internal server error
1855
+ */
1856
+ 500: unknown;
1857
+ };
1858
+ export type CollectionReclaimBidResponses = {
1859
+ /**
1860
+ * Reclaim transaction configuration
1861
+ */
1862
+ 200: {
1863
+ chainId: number;
1864
+ to: string | null;
1865
+ data: string;
1866
+ value: string;
1867
+ };
1868
+ };
1869
+ export type CollectionReclaimBidResponse = CollectionReclaimBidResponses[keyof CollectionReclaimBidResponses];
1870
+ export type CollectionClaimAuctionEarningsData = {
1871
+ body: {
1872
+ saleId: string;
1873
+ };
1874
+ path: {
1875
+ highlightId: string;
1876
+ };
1877
+ query?: never;
1878
+ url: "/collection/{highlightId}/sales/earnings";
1879
+ };
1880
+ export type CollectionClaimAuctionEarningsErrors = {
1881
+ /**
1882
+ * Invalid request
1883
+ */
1884
+ 400: unknown;
1885
+ /**
1886
+ * Unauthorized
1887
+ */
1888
+ 401: unknown;
1889
+ /**
1890
+ * Not found
1891
+ */
1892
+ 404: unknown;
1893
+ /**
1894
+ * Already claimed
1895
+ */
1896
+ 409: unknown;
1897
+ /**
1898
+ * Internal server error
1899
+ */
1900
+ 500: unknown;
1901
+ };
1902
+ export type CollectionClaimAuctionEarningsResponses = {
1903
+ /**
1904
+ * Earnings withdrawal transaction configuration
1905
+ */
1906
+ 200: {
1907
+ chainId: number;
1908
+ to: string | null;
1909
+ data: string;
1910
+ value: string;
1911
+ };
1912
+ };
1913
+ export type CollectionClaimAuctionEarningsResponse = CollectionClaimAuctionEarningsResponses[keyof CollectionClaimAuctionEarningsResponses];
1914
+ export type CollectionRankedAuctionStandingsData = {
1915
+ body?: never;
1916
+ path: {
1917
+ highlightId: string;
1918
+ saleId: string;
1919
+ };
1920
+ query?: never;
1921
+ url: "/collection/{highlightId}/sales/{saleId}/standings";
1922
+ };
1923
+ export type CollectionRankedAuctionStandingsErrors = {
1924
+ /**
1925
+ * Invalid request
1926
+ */
1927
+ 400: unknown;
1928
+ /**
1929
+ * Not found
1930
+ */
1931
+ 404: unknown;
1932
+ };
1933
+ export type CollectionRankedAuctionStandingsResponses = {
1934
+ /**
1935
+ * Ranked auction standings
1936
+ */
1937
+ 200: RankedAuctionStandings;
1938
+ };
1939
+ export type CollectionRankedAuctionStandingsResponse = CollectionRankedAuctionStandingsResponses[keyof CollectionRankedAuctionStandingsResponses];
1940
+ export type CollectionFulfillEnglishAuctionData = {
1941
+ body: {
1942
+ saleId: string;
1943
+ };
1944
+ path: {
1945
+ highlightId: string;
1946
+ };
1947
+ query?: never;
1948
+ url: "/collection/{highlightId}/sales/auction/fulfill";
1949
+ };
1950
+ export type CollectionFulfillEnglishAuctionErrors = {
1951
+ /**
1952
+ * Invalid request
1953
+ */
1954
+ 400: unknown;
1955
+ /**
1956
+ * Unauthorized
1957
+ */
1958
+ 401: unknown;
1959
+ /**
1960
+ * Not found
1961
+ */
1962
+ 404: unknown;
1963
+ /**
1964
+ * Internal server error
1965
+ */
1966
+ 500: unknown;
1967
+ };
1968
+ export type CollectionFulfillEnglishAuctionResponses = {
1969
+ /**
1970
+ * Fulfill transaction configuration
1971
+ */
1972
+ 200: {
1973
+ chainId: number;
1974
+ to: string | null;
1975
+ data: string;
1976
+ value: string;
1977
+ };
1978
+ };
1979
+ export type CollectionFulfillEnglishAuctionResponse = CollectionFulfillEnglishAuctionResponses[keyof CollectionFulfillEnglishAuctionResponses];
1980
+ export type CollectionCancelEnglishAuctionData = {
1981
+ body: {
1982
+ saleId: string;
1983
+ };
1984
+ path: {
1985
+ highlightId: string;
1986
+ };
1987
+ query?: never;
1988
+ url: "/collection/{highlightId}/sales/auction/cancel";
1989
+ };
1990
+ export type CollectionCancelEnglishAuctionErrors = {
1991
+ /**
1992
+ * Invalid request
1993
+ */
1994
+ 400: unknown;
1995
+ /**
1996
+ * Unauthorized
1997
+ */
1998
+ 401: unknown;
1999
+ /**
2000
+ * Forbidden
2001
+ */
2002
+ 403: unknown;
2003
+ /**
2004
+ * Not found
2005
+ */
2006
+ 404: unknown;
2007
+ /**
2008
+ * Internal server error
2009
+ */
2010
+ 500: unknown;
2011
+ };
2012
+ export type CollectionCancelEnglishAuctionResponses = {
2013
+ /**
2014
+ * Cancel transaction configuration
1452
2015
  */
1453
2016
  200: {
1454
2017
  chainId: number;
@@ -1457,83 +2020,59 @@ export type CollectionBidSaleResponses = {
1457
2020
  value: string;
1458
2021
  };
1459
2022
  };
1460
- export type CollectionBidSaleResponse = CollectionBidSaleResponses[keyof CollectionBidSaleResponses];
1461
- export type CollectionConfirmBidData = {
1462
- body: {
1463
- saleId: string;
1464
- txHash: string;
1465
- };
2023
+ export type CollectionCancelEnglishAuctionResponse = CollectionCancelEnglishAuctionResponses[keyof CollectionCancelEnglishAuctionResponses];
2024
+ export type CollectionEnglishAuctionStandingData = {
2025
+ body?: never;
1466
2026
  path: {
1467
2027
  highlightId: string;
2028
+ saleId: string;
1468
2029
  };
1469
2030
  query?: never;
1470
- url: "/collection/{highlightId}/sales/bid/confirm";
2031
+ url: "/collection/{highlightId}/sales/{saleId}/auction";
1471
2032
  };
1472
- export type CollectionConfirmBidErrors = {
2033
+ export type CollectionEnglishAuctionStandingErrors = {
1473
2034
  /**
1474
2035
  * Invalid request
1475
2036
  */
1476
2037
  400: unknown;
1477
- /**
1478
- * Unauthorized
1479
- */
1480
- 401: unknown;
1481
2038
  /**
1482
2039
  * Not found
1483
2040
  */
1484
2041
  404: unknown;
1485
- /**
1486
- * Internal server error
1487
- */
1488
- 500: unknown;
1489
2042
  };
1490
- export type CollectionConfirmBidResponses = {
2043
+ export type CollectionEnglishAuctionStandingResponses = {
1491
2044
  /**
1492
- * Bid recorded
2045
+ * English auction standing
1493
2046
  */
1494
- 200: {
1495
- recorded: boolean;
1496
- };
2047
+ 200: EnglishAuctionStanding;
1497
2048
  };
1498
- export type CollectionConfirmBidResponse = CollectionConfirmBidResponses[keyof CollectionConfirmBidResponses];
1499
- export type CollectionConfirmSaleData = {
1500
- body: {
1501
- txHash: string;
1502
- };
2049
+ export type CollectionEnglishAuctionStandingResponse = CollectionEnglishAuctionStandingResponses[keyof CollectionEnglishAuctionStandingResponses];
2050
+ export type CollectionEnglishAuctionBidsData = {
2051
+ body?: never;
1503
2052
  path: {
1504
2053
  highlightId: string;
1505
2054
  saleId: string;
1506
2055
  };
1507
2056
  query?: never;
1508
- url: "/collection/{highlightId}/sales/{saleId}/confirm";
2057
+ url: "/collection/{highlightId}/sales/{saleId}/auction/bids";
1509
2058
  };
1510
- export type CollectionConfirmSaleErrors = {
2059
+ export type CollectionEnglishAuctionBidsErrors = {
1511
2060
  /**
1512
2061
  * Invalid request
1513
2062
  */
1514
2063
  400: unknown;
1515
- /**
1516
- * Unauthorized
1517
- */
1518
- 401: unknown;
1519
- /**
1520
- * Forbidden
1521
- */
1522
- 403: unknown;
1523
2064
  /**
1524
2065
  * Not found
1525
2066
  */
1526
2067
  404: unknown;
1527
2068
  };
1528
- export type CollectionConfirmSaleResponses = {
2069
+ export type CollectionEnglishAuctionBidsResponses = {
1529
2070
  /**
1530
- * Sale confirmed
2071
+ * English auction bid history
1531
2072
  */
1532
- 200: {
1533
- confirmed: boolean;
1534
- };
2073
+ 200: EnglishAuctionBidHistory;
1535
2074
  };
1536
- export type CollectionConfirmSaleResponse = CollectionConfirmSaleResponses[keyof CollectionConfirmSaleResponses];
2075
+ export type CollectionEnglishAuctionBidsResponse = CollectionEnglishAuctionBidsResponses[keyof CollectionEnglishAuctionBidsResponses];
1537
2076
  export type CollectionDeployData = {
1538
2077
  body?: never;
1539
2078
  path: {
@@ -1632,19 +2171,17 @@ export type CollectionDeployStatusResponses = {
1632
2171
  };
1633
2172
  };
1634
2173
  export type CollectionDeployStatusResponse = CollectionDeployStatusResponses[keyof CollectionDeployStatusResponses];
1635
- export type CollectionDeployConfirmData = {
1636
- body: {
1637
- txHash: string;
1638
- };
2174
+ export type CollectionDeployCancelData = {
2175
+ body?: never;
1639
2176
  path: {
1640
2177
  highlightId: string;
1641
2178
  };
1642
2179
  query?: never;
1643
- url: "/collection/{highlightId}/deploy/confirm";
2180
+ url: "/collection/{highlightId}/deploy/cancel";
1644
2181
  };
1645
- export type CollectionDeployConfirmErrors = {
2182
+ export type CollectionDeployCancelErrors = {
1646
2183
  /**
1647
- * Invalid request
2184
+ * Deployment cannot be cancelled from its current state
1648
2185
  */
1649
2186
  400: unknown;
1650
2187
  /**
@@ -1660,31 +2197,16 @@ export type CollectionDeployConfirmErrors = {
1660
2197
  */
1661
2198
  404: unknown;
1662
2199
  };
1663
- export type CollectionDeployConfirmResponses = {
2200
+ export type CollectionDeployCancelResponses = {
1664
2201
  /**
1665
- * Transaction confirmed
2202
+ * Deployment cancelled
1666
2203
  */
1667
2204
  200: {
1668
- status: "Pending" | "InProgress" | "Completed" | "Failed";
1669
- currentStep: "Validate" | "UploadMetadata" | "UploadCode" | "GenerateTransaction" | "AwaitTransaction" | "RecordTransaction";
1670
- steps: Array<{
1671
- step: string;
1672
- status: string;
1673
- error?: string;
1674
- }>;
1675
- contractConfig: {
1676
- chainId: number;
1677
- to: string | null;
1678
- data: string;
1679
- value: string;
1680
- } | null;
1681
- txHash: string | null;
1682
- error: string | null;
1683
- deploymentId: string;
2205
+ cancelled: boolean;
1684
2206
  highlightId: string;
1685
2207
  };
1686
2208
  };
1687
- export type CollectionDeployConfirmResponse = CollectionDeployConfirmResponses[keyof CollectionDeployConfirmResponses];
2209
+ export type CollectionDeployCancelResponse = CollectionDeployCancelResponses[keyof CollectionDeployCancelResponses];
1688
2210
  export type TokenListData = {
1689
2211
  body?: never;
1690
2212
  path: {
@@ -1697,10 +2219,18 @@ export type TokenListData = {
1697
2219
  order?: "asc" | "desc";
1698
2220
  ownerAddress?: string;
1699
2221
  search?: string;
2222
+ /**
2223
+ * Trait filter as a JSON-encoded array of { traitType, values }. AND across entries, OR within a trait's values. Example: [{"traitType":"Background","values":["Blue","Red"]}].
2224
+ */
2225
+ attributes?: string;
1700
2226
  };
1701
2227
  url: "/collection/{highlightId}/tokens";
1702
2228
  };
1703
2229
  export type TokenListErrors = {
2230
+ /**
2231
+ * Malformed attributes filter
2232
+ */
2233
+ 400: unknown;
1704
2234
  /**
1705
2235
  * Collection not found or not public
1706
2236
  */
@@ -1715,6 +2245,7 @@ export type TokenListResponses = {
1715
2245
  id: string;
1716
2246
  collectionId: string;
1717
2247
  tokenId: string;
2248
+ status: TokenStatus;
1718
2249
  name: string | null;
1719
2250
  description: string | null;
1720
2251
  externalUrl: string | null;
@@ -1727,7 +2258,9 @@ export type TokenListResponses = {
1727
2258
  [key: string]: unknown;
1728
2259
  } | null;
1729
2260
  imageMediaId: string | null;
2261
+ imageMedia: MediaAsset | null;
1730
2262
  animationMediaId: string | null;
2263
+ animationMedia: MediaAsset | null;
1731
2264
  mintedAt: string | null;
1732
2265
  createdAt: string;
1733
2266
  updatedAt: string;
@@ -1743,6 +2276,29 @@ export type TokenListResponses = {
1743
2276
  };
1744
2277
  };
1745
2278
  export type TokenListResponse = TokenListResponses[keyof TokenListResponses];
2279
+ export type TokenAttributeFacetsData = {
2280
+ body?: never;
2281
+ path: {
2282
+ highlightId: string;
2283
+ };
2284
+ query?: never;
2285
+ url: "/collection/{highlightId}/tokens/attributes";
2286
+ };
2287
+ export type TokenAttributeFacetsErrors = {
2288
+ /**
2289
+ * Collection not found or not public
2290
+ */
2291
+ 404: unknown;
2292
+ };
2293
+ export type TokenAttributeFacetsResponses = {
2294
+ /**
2295
+ * Attribute facets
2296
+ */
2297
+ 200: {
2298
+ facets: Array<TokenAttributeFacet>;
2299
+ };
2300
+ };
2301
+ export type TokenAttributeFacetsResponse = TokenAttributeFacetsResponses[keyof TokenAttributeFacetsResponses];
1746
2302
  export type TokenGetData = {
1747
2303
  body?: never;
1748
2304
  path: {
@@ -1766,6 +2322,7 @@ export type TokenGetResponses = {
1766
2322
  id: string;
1767
2323
  collectionId: string;
1768
2324
  tokenId: string;
2325
+ status: TokenStatus;
1769
2326
  name: string | null;
1770
2327
  description: string | null;
1771
2328
  externalUrl: string | null;
@@ -1778,13 +2335,37 @@ export type TokenGetResponses = {
1778
2335
  [key: string]: unknown;
1779
2336
  } | null;
1780
2337
  imageMediaId: string | null;
2338
+ imageMedia: MediaAsset | null;
1781
2339
  animationMediaId: string | null;
2340
+ animationMedia: MediaAsset | null;
1782
2341
  mintedAt: string | null;
1783
2342
  createdAt: string;
1784
2343
  updatedAt: string;
1785
2344
  };
1786
2345
  };
1787
2346
  export type TokenGetResponse = TokenGetResponses[keyof TokenGetResponses];
2347
+ export type TokenListOwnersData = {
2348
+ body?: never;
2349
+ path: {
2350
+ highlightId: string;
2351
+ tokenId: string;
2352
+ };
2353
+ query?: never;
2354
+ url: "/collection/{highlightId}/tokens/{tokenId}/owners";
2355
+ };
2356
+ export type TokenListOwnersErrors = {
2357
+ /**
2358
+ * Token or collection not found
2359
+ */
2360
+ 404: unknown;
2361
+ };
2362
+ export type TokenListOwnersResponses = {
2363
+ /**
2364
+ * Token owners
2365
+ */
2366
+ 200: TokenOwnersResponse;
2367
+ };
2368
+ export type TokenListOwnersResponse = TokenListOwnersResponses[keyof TokenListOwnersResponses];
1788
2369
  export type ConfigChainsData = {
1789
2370
  body?: never;
1790
2371
  path?: never;
@@ -1802,11 +2383,6 @@ export type ConfigChainsResponses = {
1802
2383
  network: string;
1803
2384
  testnet: boolean;
1804
2385
  mintFee: string;
1805
- wrappedCurrency: {
1806
- address: string;
1807
- decimals: number;
1808
- symbol: string;
1809
- } | null;
1810
2386
  supportedFeatures: Array<string>;
1811
2387
  supportedCurrencies: Array<{
1812
2388
  address: string;
@@ -2004,6 +2580,9 @@ export type GateCreateData = {
2004
2580
  type: "FARCASTER_FOLLOW";
2005
2581
  config: {
2006
2582
  fid: number;
2583
+ username?: string;
2584
+ displayName?: string;
2585
+ pfpUrl?: string;
2007
2586
  };
2008
2587
  }>;
2009
2588
  };
@@ -2158,6 +2737,9 @@ export type GateUpdateData = {
2158
2737
  type: "FARCASTER_FOLLOW";
2159
2738
  config: {
2160
2739
  fid: number;
2740
+ username?: string;
2741
+ displayName?: string;
2742
+ pfpUrl?: string;
2161
2743
  };
2162
2744
  }>;
2163
2745
  };
@@ -2206,6 +2788,198 @@ export type GateUpdateResponses = {
2206
2788
  };
2207
2789
  };
2208
2790
  export type GateUpdateResponse = GateUpdateResponses[keyof GateUpdateResponses];
2791
+ export type GatePreviewCollectionData = {
2792
+ body?: never;
2793
+ path: {
2794
+ chainId: number;
2795
+ address: string;
2796
+ };
2797
+ query?: never;
2798
+ url: "/gate/preview/collection/{chainId}/{address}";
2799
+ };
2800
+ export type GatePreviewCollectionErrors = {
2801
+ /**
2802
+ * Unsupported chain
2803
+ */
2804
+ 400: unknown;
2805
+ /**
2806
+ * Unauthorized
2807
+ */
2808
+ 401: unknown;
2809
+ /**
2810
+ * No contract found at this address
2811
+ */
2812
+ 404: unknown;
2813
+ /**
2814
+ * NFT data provider not configured
2815
+ */
2816
+ 500: unknown;
2817
+ };
2818
+ export type GatePreviewCollectionResponses = {
2819
+ /**
2820
+ * Collection preview
2821
+ */
2822
+ 200: GateCollectionPreview;
2823
+ };
2824
+ export type GatePreviewCollectionResponse = GatePreviewCollectionResponses[keyof GatePreviewCollectionResponses];
2825
+ export type GatePreviewAttributesData = {
2826
+ body?: never;
2827
+ path: {
2828
+ chainId: number;
2829
+ address: string;
2830
+ };
2831
+ query?: never;
2832
+ url: "/gate/preview/collection/{chainId}/{address}/attributes";
2833
+ };
2834
+ export type GatePreviewAttributesErrors = {
2835
+ /**
2836
+ * Unsupported chain
2837
+ */
2838
+ 400: unknown;
2839
+ /**
2840
+ * Unauthorized
2841
+ */
2842
+ 401: unknown;
2843
+ /**
2844
+ * NFT data provider not configured
2845
+ */
2846
+ 500: unknown;
2847
+ };
2848
+ export type GatePreviewAttributesResponses = {
2849
+ /**
2850
+ * Attribute facets
2851
+ */
2852
+ 200: GateAttributesPreview;
2853
+ };
2854
+ export type GatePreviewAttributesResponse = GatePreviewAttributesResponses[keyof GatePreviewAttributesResponses];
2855
+ export type GatePreviewTokensData = {
2856
+ body?: never;
2857
+ path: {
2858
+ chainId: number;
2859
+ address: string;
2860
+ };
2861
+ query?: {
2862
+ cursor?: string;
2863
+ limit?: number;
2864
+ };
2865
+ url: "/gate/preview/collection/{chainId}/{address}/tokens";
2866
+ };
2867
+ export type GatePreviewTokensErrors = {
2868
+ /**
2869
+ * Unsupported chain
2870
+ */
2871
+ 400: unknown;
2872
+ /**
2873
+ * Unauthorized
2874
+ */
2875
+ 401: unknown;
2876
+ /**
2877
+ * NFT data provider not configured
2878
+ */
2879
+ 500: unknown;
2880
+ };
2881
+ export type GatePreviewTokensResponses = {
2882
+ /**
2883
+ * Token page
2884
+ */
2885
+ 200: GateTokensPreview;
2886
+ };
2887
+ export type GatePreviewTokensResponse = GatePreviewTokensResponses[keyof GatePreviewTokensResponses];
2888
+ export type GatePreviewTokenData = {
2889
+ body?: never;
2890
+ path: {
2891
+ chainId: number;
2892
+ address: string;
2893
+ tokenId: string;
2894
+ };
2895
+ query?: never;
2896
+ url: "/gate/preview/collection/{chainId}/{address}/token/{tokenId}";
2897
+ };
2898
+ export type GatePreviewTokenErrors = {
2899
+ /**
2900
+ * Unsupported chain
2901
+ */
2902
+ 400: unknown;
2903
+ /**
2904
+ * Unauthorized
2905
+ */
2906
+ 401: unknown;
2907
+ /**
2908
+ * Token not found
2909
+ */
2910
+ 404: unknown;
2911
+ /**
2912
+ * NFT data provider not configured
2913
+ */
2914
+ 500: unknown;
2915
+ };
2916
+ export type GatePreviewTokenResponses = {
2917
+ /**
2918
+ * Token preview
2919
+ */
2920
+ 200: {
2921
+ tokenId: string;
2922
+ name: string | null;
2923
+ imageUrl: string | null;
2924
+ };
2925
+ };
2926
+ export type GatePreviewTokenResponse = GatePreviewTokenResponses[keyof GatePreviewTokenResponses];
2927
+ export type GatePreviewCurrencyData = {
2928
+ body?: never;
2929
+ path: {
2930
+ chainId: number;
2931
+ };
2932
+ query?: {
2933
+ contractAddress?: string;
2934
+ };
2935
+ url: "/gate/preview/currency/{chainId}";
2936
+ };
2937
+ export type GatePreviewCurrencyErrors = {
2938
+ /**
2939
+ * Unauthorized
2940
+ */
2941
+ 401: unknown;
2942
+ /**
2943
+ * Address is not a readable ERC-20
2944
+ */
2945
+ 404: unknown;
2946
+ };
2947
+ export type GatePreviewCurrencyResponses = {
2948
+ /**
2949
+ * Currency preview
2950
+ */
2951
+ 200: GateCurrencyPreview;
2952
+ };
2953
+ export type GatePreviewCurrencyResponse = GatePreviewCurrencyResponses[keyof GatePreviewCurrencyResponses];
2954
+ export type GatePreviewFarcasterData = {
2955
+ body?: never;
2956
+ path?: never;
2957
+ query: {
2958
+ query: string;
2959
+ };
2960
+ url: "/gate/preview/farcaster/user";
2961
+ };
2962
+ export type GatePreviewFarcasterErrors = {
2963
+ /**
2964
+ * Unauthorized
2965
+ */
2966
+ 401: unknown;
2967
+ /**
2968
+ * No Farcaster user found
2969
+ */
2970
+ 404: unknown;
2971
+ /**
2972
+ * Farcaster provider not configured
2973
+ */
2974
+ 500: unknown;
2975
+ };
2976
+ export type GatePreviewFarcasterResponses = {
2977
+ /**
2978
+ * Farcaster user
2979
+ */
2980
+ 200: GateFarcasterUserPreview;
2981
+ };
2982
+ export type GatePreviewFarcasterResponse = GatePreviewFarcasterResponses[keyof GatePreviewFarcasterResponses];
2209
2983
  export type PostIndexerChainsByChainIdActivateData = {
2210
2984
  body?: never;
2211
2985
  path: {
@@ -2802,6 +3576,50 @@ export type MediaGetChildResponses = {
2802
3576
  200: MediaAsset;
2803
3577
  };
2804
3578
  export type MediaGetChildResponse = MediaGetChildResponses[keyof MediaGetChildResponses];
3579
+ export type TxStatusData = {
3580
+ body?: never;
3581
+ path: {
3582
+ chainId: number;
3583
+ txHash: string;
3584
+ };
3585
+ query?: never;
3586
+ url: "/tx/{chainId}/{txHash}";
3587
+ };
3588
+ export type TxStatusErrors = {
3589
+ /**
3590
+ * Unauthorized
3591
+ */
3592
+ 401: unknown;
3593
+ };
3594
+ export type TxStatusResponses = {
3595
+ /**
3596
+ * Current transaction status snapshot
3597
+ */
3598
+ 200: TxStatusSnapshot;
3599
+ };
3600
+ export type TxStatusResponse = TxStatusResponses[keyof TxStatusResponses];
3601
+ export type TxSubmitData = {
3602
+ body?: never;
3603
+ path: {
3604
+ chainId: number;
3605
+ txHash: string;
3606
+ };
3607
+ query?: never;
3608
+ url: "/tx/{chainId}/{txHash}";
3609
+ };
3610
+ export type TxSubmitErrors = {
3611
+ /**
3612
+ * Unauthorized
3613
+ */
3614
+ 401: unknown;
3615
+ };
3616
+ export type TxSubmitResponses = {
3617
+ /**
3618
+ * Transaction accepted for processing
3619
+ */
3620
+ 202: TxStatusSnapshot;
3621
+ };
3622
+ export type TxSubmitResponse = TxSubmitResponses[keyof TxSubmitResponses];
2805
3623
  export type UserSiweNonceData = {
2806
3624
  body?: never;
2807
3625
  path?: never;