dcl-catalyst-client 22.0.1-38482794215.commit-a4a4e71 → 22.0.1-38602312773.commit-5d9befe

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.
@@ -2,37 +2,211 @@
2
2
  * Generated by orval v6.20.0 🍺
3
3
  * Do not edit manually.
4
4
  * API Specification for the Decentraland Catalyst Server (BETA)
5
- * A Catalyst is a Server that runs different services. These services currently work as the backbone for Decentraland and work in a decentralized network. The current specification details the following services: <br/><br/>- Archipelago <br/>- Content Server <br/>- Lambdas Service <br/> <br/>WARNING: We are working to close the version 1.0 of the Catalyst Protocol defined by this API. So far this is what we have and it's public but we are still working on refinement and during this process we may decided to deprecate or change some of the endpoints.
5
+ * A Catalyst is a Server that runs different services. These services currently work as the backbone for Decentraland and work in a decentralized network. The current specification details the following services: <br/><br/>- Content Server <br/>- Lambdas Service <br/>- Explorer <br/> <br/>WARNING: We are working to close the version 1.0 of the Catalyst Protocol defined by this API. So far this is what we have and it's public but we are still working on refinement and during this process we may decided to deprecate or change some of the endpoints.
6
6
  * OpenAPI spec version: 1.0
7
7
  */
8
- export type GetParcelOperators400 = {
9
- error?: string;
8
+ export type GetExplorerEmotesCollectionTypeItem = (typeof GetExplorerEmotesCollectionTypeItem)[keyof typeof GetExplorerEmotesCollectionTypeItem];
9
+ export declare const GetExplorerEmotesCollectionTypeItem: {
10
+ readonly 'on-chain': "on-chain";
10
11
  };
11
- export type ValidateSignature200 = {
12
- [key: string]: any;
12
+ export type GetExplorerEmotesParams = {
13
+ /**
14
+ * Only return emotes of the given collection type. `on-chain` is the only type. Any other value is rejected with a 400.
15
+ */
16
+ collectionType?: GetExplorerEmotesCollectionTypeItem[];
17
+ /**
18
+ * Only return elements of the given category (case-insensitive). Repeat the parameter to match any of several categories.
19
+ */
20
+ category?: CategoryParameter;
21
+ /**
22
+ * Only return elements whose name contains this text (case-insensitive).
23
+ */
24
+ name?: NameParameter;
25
+ /**
26
+ * Only return elements of this rarity. Elements without rarity are excluded. Any other value is rejected with a 400.
27
+ */
28
+ rarity?: RarityParameter;
29
+ /**
30
+ * Field to sort by. `rarity` sorts by rarity tier, `name` alphabetically and `date` by transfer date (most recent transfer for `DESC`, oldest for `ASC`). Elements without the field, such as base or third-party wearables for `rarity` and `date`, go last with `DESC` and first with `ASC`. Ties are broken by URN.
31
+ */
32
+ orderBy?: OrderByParameter;
33
+ /**
34
+ * Sort direction. Defaults to `ASC` when `orderBy` is `name` and to `DESC` otherwise.
35
+ */
36
+ direction?: DirectionParameter;
37
+ /**
38
+ * Number of the requested page, starting at 1.
39
+ */
40
+ pageNum?: PageNumParameter;
41
+ /**
42
+ * Number of elements per page. Values above 1000 are rejected with a 400.
43
+ */
44
+ pageSize?: PageSizeParameter;
45
+ /**
46
+ * When `true`, each element is returned in its trimmed form: a reduced entity with only the fields needed to render the backpack. Otherwise the full form is returned.
47
+ */
48
+ trimmed?: TrimmedParameter;
49
+ /**
50
+ * When `true` together with `trimmed`, adds the number of owned copies as `amount` to each trimmed element. Ignored without `trimmed`.
51
+ */
52
+ includeAmount?: IncludeAmountParameter;
13
53
  };
14
- export type ValidateSignatureBody = {
15
- [key: string]: any;
54
+ export type GetExplorerWearablesNetwork = (typeof GetExplorerWearablesNetwork)[keyof typeof GetExplorerWearablesNetwork];
55
+ export declare const GetExplorerWearablesNetwork: {
56
+ readonly ETHEREUM: "ETHEREUM";
57
+ readonly MATIC: "MATIC";
58
+ };
59
+ export type GetExplorerWearablesCollectionTypeItem = (typeof GetExplorerWearablesCollectionTypeItem)[keyof typeof GetExplorerWearablesCollectionTypeItem];
60
+ export declare const GetExplorerWearablesCollectionTypeItem: {
61
+ readonly 'base-wearable': "base-wearable";
62
+ readonly 'on-chain': "on-chain";
63
+ readonly 'third-party': "third-party";
64
+ };
65
+ export type GetExplorerWearablesParams = {
66
+ /**
67
+ * Only return wearables of the given collection types. Repeat the parameter to request several. Defaults to all types. Any other value is rejected with a 400.
68
+ */
69
+ collectionType?: GetExplorerWearablesCollectionTypeItem[];
70
+ /**
71
+ * Only return third-party wearables from the given third-party collections, identified by their URN (`urn:decentraland:{network}:collections-thirdparty:{thirdPartyName}`; any further segments are ignored). Repeat the parameter to request several. Values that are not third-party URNs are ignored. Defaults to all owned third-party wearables.
72
+ */
73
+ thirdPartyCollectionId?: string[];
74
+ /**
75
+ * When `true`, only return on-chain smart wearables. Base and third-party wearables are excluded.
76
+ */
77
+ isSmartWearable?: boolean;
78
+ /**
79
+ * Only return on-chain wearables from this network. Base and third-party wearables are excluded. Any other value is ignored.
80
+ */
81
+ network?: GetExplorerWearablesNetwork;
82
+ /**
83
+ * Only return elements of the given category (case-insensitive). Repeat the parameter to match any of several categories.
84
+ */
85
+ category?: CategoryParameter;
86
+ /**
87
+ * Only return elements whose name contains this text (case-insensitive).
88
+ */
89
+ name?: NameParameter;
90
+ /**
91
+ * Only return elements of this rarity. Elements without rarity are excluded. Any other value is rejected with a 400.
92
+ */
93
+ rarity?: RarityParameter;
94
+ /**
95
+ * Field to sort by. `rarity` sorts by rarity tier, `name` alphabetically and `date` by transfer date (most recent transfer for `DESC`, oldest for `ASC`). Elements without the field, such as base or third-party wearables for `rarity` and `date`, go last with `DESC` and first with `ASC`. Ties are broken by URN.
96
+ */
97
+ orderBy?: OrderByParameter;
98
+ /**
99
+ * Sort direction. Defaults to `ASC` when `orderBy` is `name` and to `DESC` otherwise.
100
+ */
101
+ direction?: DirectionParameter;
102
+ /**
103
+ * Number of the requested page, starting at 1.
104
+ */
105
+ pageNum?: PageNumParameter;
106
+ /**
107
+ * Number of elements per page. Values above 1000 are rejected with a 400.
108
+ */
109
+ pageSize?: PageSizeParameter;
110
+ /**
111
+ * When `true`, each element is returned in its trimmed form: a reduced entity with only the fields needed to render the backpack. Otherwise the full form is returned.
112
+ */
113
+ trimmed?: TrimmedParameter;
114
+ /**
115
+ * When `true` together with `trimmed`, adds the number of owned copies as `amount` to each trimmed element. Ignored without `trimmed`.
116
+ */
117
+ includeAmount?: IncludeAmountParameter;
118
+ };
119
+ export type ValidateSignature400 = SchemaValidationError | LambdasError;
120
+ export type GetNftsCollections200CollectionsItem = {
121
+ id: string;
122
+ name: string;
123
+ };
124
+ export type GetNftsCollections200 = {
125
+ collections: GetNftsCollections200CollectionsItem[];
126
+ };
127
+ export type GetEmotesByOwner200Item = {
128
+ /** Number of tokens of this item owned by the address */
129
+ amount: number;
130
+ /** Present only when `includeDefinitions` is set */
131
+ definition?: EmoteDefinition;
132
+ urn: string;
133
+ };
134
+ export type GetEmotesByOwnerIncludeDefinitions = (typeof GetEmotesByOwnerIncludeDefinitions)[keyof typeof GetEmotesByOwnerIncludeDefinitions];
135
+ export declare const GetEmotesByOwnerIncludeDefinitions: {
136
+ readonly true: "true";
137
+ };
138
+ export type GetEmotesByOwnerParams = {
139
+ /**
140
+ * Third party collection URN. Only the third party part of the URN (the first five segments) is used.
141
+ */
142
+ collectionId?: string;
143
+ /**
144
+ * Presence flag: when present with any value (even `false`), each element is extended with its emote definition. Omit it to disable.
145
+ */
146
+ includeDefinitions?: GetEmotesByOwnerIncludeDefinitions;
147
+ };
148
+ export type GetWearablesByOwner200Item = {
149
+ /** Number of tokens of this item owned by the address */
150
+ amount: number;
151
+ /** Present only when `includeDefinitions` is set */
152
+ definition?: WearableDefinition;
153
+ urn: string;
154
+ };
155
+ export type GetWearablesByOwnerIncludeDefinitions = (typeof GetWearablesByOwnerIncludeDefinitions)[keyof typeof GetWearablesByOwnerIncludeDefinitions];
156
+ export declare const GetWearablesByOwnerIncludeDefinitions: {
157
+ readonly true: "true";
158
+ };
159
+ export type GetWearablesByOwnerParams = {
160
+ /**
161
+ * Third party collection URN. Only the third party part of the URN (the first five segments) is used.
162
+ */
163
+ collectionId?: string;
164
+ /**
165
+ * Presence flag: when present with any value (even `false`), each element is extended with its wearable definition. Omit it to disable.
166
+ */
167
+ includeDefinitions?: GetWearablesByOwnerIncludeDefinitions;
168
+ };
169
+ export type SearchEmotesParams = {
170
+ /**
171
+ * Collection URN to search in. Can be repeated up to 500 times.
172
+ */
173
+ collectionId?: string[];
174
+ /**
175
+ * Emote URN to retrieve. Can be repeated up to 500 times.
176
+ */
177
+ emoteId?: string[];
178
+ /**
179
+ * Text to search for in the emotes. Case-insensitive, at least 3 characters.
180
+ */
181
+ textSearch?: string;
182
+ /**
183
+ * Maximum number of emotes to return. Values that are not a number between 1 and 500 fall back to 500.
184
+ */
185
+ limit?: number;
186
+ /**
187
+ * URN of the last emote of the previous page. Only emotes with a greater URN are returned.
188
+ */
189
+ lastId?: string;
16
190
  };
17
191
  export type SearchWearablesParams = {
18
192
  /**
19
- * Lis of URNs that identify the collection. Maximum amount of ids allowed is 500.
193
+ * Collection URN to search in. Can be repeated up to 500 times.
20
194
  */
21
195
  collectionId?: string[];
22
196
  /**
23
- * List of wearables URNs to search. Maximum amount of ids allowed is 500.
197
+ * Wearable URN to retrieve. Can be repeated up to 500 times.
24
198
  */
25
199
  wearableId?: string[];
26
200
  /**
27
- * Search text
201
+ * Text to search for in the wearables. Case-insensitive, at least 3 characters.
28
202
  */
29
203
  textSearch?: string;
30
204
  /**
31
- * Limit the quantity of results that will be returned by the request. You can only request up to 500 results.
205
+ * Maximum number of wearables to return. Values that are not a number between 1 and 500 fall back to 500.
32
206
  */
33
207
  limit?: number;
34
208
  /**
35
- * The result will always be ordered by the local timestamp fields but in case of timestamp collisions, you can use the lastId field to filter the result
209
+ * URN of the last wearable of the previous page. Only wearables with a greater URN are returned.
36
210
  */
37
211
  lastId?: string;
38
212
  };
@@ -42,15 +216,23 @@ export type GetThirdPartyCollection200 = {
42
216
  pageSize: number;
43
217
  totalAmount: number;
44
218
  };
219
+ export type GetThirdPartyCollectionIncludeDefinitions = (typeof GetThirdPartyCollectionIncludeDefinitions)[keyof typeof GetThirdPartyCollectionIncludeDefinitions];
220
+ export declare const GetThirdPartyCollectionIncludeDefinitions: {
221
+ readonly true: "true";
222
+ };
45
223
  export type GetThirdPartyCollectionParams = {
224
+ /**
225
+ * Presence flag: when present with any value (even `false`), each element is extended with its wearable definition. Omit it to disable.
226
+ */
227
+ includeDefinitions?: GetThirdPartyCollectionIncludeDefinitions;
46
228
  /**
47
229
  * The number of the requested page.
48
230
  */
49
- pageNum?: string;
231
+ pageNum?: number;
50
232
  /**
51
233
  * The size of the requested page.
52
234
  */
53
- pageSize?: string;
235
+ pageSize?: number;
54
236
  };
55
237
  export type GetThirdPartyWearables200 = {
56
238
  elements: ThirdPartyWearable[];
@@ -58,38 +240,78 @@ export type GetThirdPartyWearables200 = {
58
240
  pageSize: number;
59
241
  totalAmount: number;
60
242
  };
243
+ export type GetThirdPartyWearablesDirection = (typeof GetThirdPartyWearablesDirection)[keyof typeof GetThirdPartyWearablesDirection];
244
+ export declare const GetThirdPartyWearablesDirection: {
245
+ readonly ASC: "ASC";
246
+ readonly DESC: "DESC";
247
+ };
248
+ export type GetThirdPartyWearablesOrderBy = (typeof GetThirdPartyWearablesOrderBy)[keyof typeof GetThirdPartyWearablesOrderBy];
249
+ export declare const GetThirdPartyWearablesOrderBy: {
250
+ readonly name: "name";
251
+ };
252
+ export type GetThirdPartyWearablesIncludeDefinitions = (typeof GetThirdPartyWearablesIncludeDefinitions)[keyof typeof GetThirdPartyWearablesIncludeDefinitions];
253
+ export declare const GetThirdPartyWearablesIncludeDefinitions: {
254
+ readonly true: "true";
255
+ };
61
256
  export type GetThirdPartyWearablesParams = {
257
+ /**
258
+ * Presence flag: when present with any value (even `false`), each element is extended with its wearable definition. Omit it to disable.
259
+ */
260
+ includeDefinitions?: GetThirdPartyWearablesIncludeDefinitions;
261
+ /**
262
+ * Only return wearables of these categories. Can be repeated.
263
+ */
264
+ category?: string[];
265
+ /**
266
+ * Only return wearables whose name contains this text. Case-insensitive.
267
+ */
268
+ name?: string;
269
+ /**
270
+ * Field to sort by.
271
+ */
272
+ orderBy?: GetThirdPartyWearablesOrderBy;
273
+ /**
274
+ * Sort direction.
275
+ */
276
+ direction?: GetThirdPartyWearablesDirection;
62
277
  /**
63
278
  * The number of the requested page.
64
279
  */
65
- pageNum?: string;
280
+ pageNum?: number;
66
281
  /**
67
282
  * The size of the requested page.
68
283
  */
69
- pageSize?: string;
284
+ pageSize?: number;
70
285
  };
71
- export type GetParcelPermissions400 = {
72
- error?: string;
286
+ export type GetLandsPermissionsParams = {
287
+ /**
288
+ * The number of the requested page.
289
+ */
290
+ pageNum?: number;
291
+ /**
292
+ * The size of the requested page.
293
+ */
294
+ pageSize?: number;
73
295
  };
74
296
  export type GetLandsParams = {
75
297
  /**
76
- * The number of the requested page. It needs `pageSize` to be present to enable a paginated response.
298
+ * The number of the requested page.
77
299
  */
78
- pageNum?: string;
300
+ pageNum?: number;
79
301
  /**
80
- * The size of the requested page. It needs `pageNum` to be present to enable a paginated response.
302
+ * The size of the requested page.
81
303
  */
82
- pageSize?: string;
304
+ pageSize?: number;
83
305
  };
84
306
  export type GetNamesParams = {
85
307
  /**
86
- * The number of the requested page. It needs `pageSize` to be present to enable a paginated response.
308
+ * The number of the requested page.
87
309
  */
88
- pageNum?: string;
310
+ pageNum?: number;
89
311
  /**
90
- * The size of the requested page. It needs `pageNum` to be present to enable a paginated response.
312
+ * The size of the requested page.
91
313
  */
92
- pageSize?: string;
314
+ pageSize?: number;
93
315
  };
94
316
  export type GetEmotes200 = {
95
317
  elements: Emote[];
@@ -97,23 +319,62 @@ export type GetEmotes200 = {
97
319
  pageSize: number;
98
320
  totalAmount: number;
99
321
  };
322
+ export type GetEmotesDirection = (typeof GetEmotesDirection)[keyof typeof GetEmotesDirection];
323
+ export declare const GetEmotesDirection: {
324
+ readonly ASC: "ASC";
325
+ readonly DESC: "DESC";
326
+ };
327
+ export type GetEmotesOrderBy = (typeof GetEmotesOrderBy)[keyof typeof GetEmotesOrderBy];
328
+ export declare const GetEmotesOrderBy: {
329
+ readonly rarity: "rarity";
330
+ readonly name: "name";
331
+ readonly date: "date";
332
+ };
333
+ export type GetEmotesIncludeDefinitions = (typeof GetEmotesIncludeDefinitions)[keyof typeof GetEmotesIncludeDefinitions];
334
+ export declare const GetEmotesIncludeDefinitions: {
335
+ readonly true: "true";
336
+ };
337
+ export type GetEmotesIncludeEntities = (typeof GetEmotesIncludeEntities)[keyof typeof GetEmotesIncludeEntities];
338
+ export declare const GetEmotesIncludeEntities: {
339
+ readonly true: "true";
340
+ };
100
341
  export type GetEmotesParams = {
101
342
  /**
102
- * Third Party collection Id to filter emotes, if this param is not sent then the 3rd parties emotes are not shown. If it is sent, only the 3rd parties emotes are shown.
343
+ * Presence flag: when present with any value (even `false`), each element is extended with its content server entity. Omit it to disable. Cannot be combined with `includeDefinitions`.
103
344
  */
104
- collectionId?: string;
345
+ includeEntities?: GetEmotesIncludeEntities;
346
+ /**
347
+ * Presence flag: when present with any value (even `false`), each element is extended with its emote definition. Omit it to disable. Cannot be combined with `includeEntities`.
348
+ */
349
+ includeDefinitions?: GetEmotesIncludeDefinitions;
350
+ /**
351
+ * Only return emotes of this category. Case-insensitive.
352
+ */
353
+ category?: string;
354
+ /**
355
+ * Only return emotes of this rarity. Case-insensitive.
356
+ */
357
+ rarity?: string;
358
+ /**
359
+ * Only return emotes whose name contains this text. Case-insensitive.
360
+ */
361
+ name?: string;
362
+ /**
363
+ * Field to sort by. `date` is the transfer date of the tokens.
364
+ */
365
+ orderBy?: GetEmotesOrderBy;
105
366
  /**
106
- * If present, response will be extended with the entity data.
367
+ * Sort direction. Defaults to `ASC` when sorting by `name` and to `DESC` otherwise.
107
368
  */
108
- includeEntities?: boolean;
369
+ direction?: GetEmotesDirection;
109
370
  /**
110
371
  * The number of the requested page.
111
372
  */
112
- pageNum?: string;
373
+ pageNum?: number;
113
374
  /**
114
- * The size of the requested page
375
+ * The size of the requested page.
115
376
  */
116
- pageSize?: string;
377
+ pageSize?: number;
117
378
  };
118
379
  export type GetWearables200 = {
119
380
  elements: Wearable[];
@@ -121,34 +382,152 @@ export type GetWearables200 = {
121
382
  pageSize: number;
122
383
  totalAmount: number;
123
384
  };
385
+ export type GetWearablesDirection = (typeof GetWearablesDirection)[keyof typeof GetWearablesDirection];
386
+ export declare const GetWearablesDirection: {
387
+ readonly ASC: "ASC";
388
+ readonly DESC: "DESC";
389
+ };
390
+ export type GetWearablesOrderBy = (typeof GetWearablesOrderBy)[keyof typeof GetWearablesOrderBy];
391
+ export declare const GetWearablesOrderBy: {
392
+ readonly rarity: "rarity";
393
+ readonly name: "name";
394
+ readonly date: "date";
395
+ };
396
+ export type GetWearablesIncludeDefinitions = (typeof GetWearablesIncludeDefinitions)[keyof typeof GetWearablesIncludeDefinitions];
397
+ export declare const GetWearablesIncludeDefinitions: {
398
+ readonly true: "true";
399
+ };
400
+ export type GetWearablesIncludeEntities = (typeof GetWearablesIncludeEntities)[keyof typeof GetWearablesIncludeEntities];
401
+ export declare const GetWearablesIncludeEntities: {
402
+ readonly true: "true";
403
+ };
124
404
  export type GetWearablesParams = {
125
405
  /**
126
- * If present, response will be extended with the entity data.
406
+ * Presence flag: when present with any value (even `false`), each element is extended with its content server entity. Omit it to disable. Cannot be combined with `includeDefinitions`.
127
407
  */
128
- includeEntities?: boolean;
408
+ includeEntities?: GetWearablesIncludeEntities;
129
409
  /**
130
- * If present, response will include the third-party wearables owned by the address. They will appear before other wearables if the response is paginated.
410
+ * Presence flag: when present with any value (even `false`), each element is extended with its wearable definition. Omit it to disable. Cannot be combined with `includeEntities`.
131
411
  */
132
- includeThirdParty?: boolean;
412
+ includeDefinitions?: GetWearablesIncludeDefinitions;
133
413
  /**
134
- * The number of the requested page.
414
+ * Only return wearables of this category. Case-insensitive.
135
415
  */
136
- pageNum?: string;
416
+ category?: string;
137
417
  /**
138
- * The size of the requested page.
418
+ * Only return wearables of this rarity. Case-insensitive.
139
419
  */
140
- pageSize?: string;
420
+ rarity?: string;
421
+ /**
422
+ * Only return wearables whose name contains this text. Case-insensitive.
423
+ */
424
+ name?: string;
141
425
  /**
142
- * Determines the field to be sort by. By default it will be by `transferredAt`. Possible values: `transferredAt` and `rarity`.
426
+ * Field to sort by. `date` is the transfer date of the tokens.
143
427
  */
144
- orderBy?: string;
428
+ orderBy?: GetWearablesOrderBy;
429
+ /**
430
+ * Sort direction. Defaults to `ASC` when sorting by `name` and to `DESC` otherwise.
431
+ */
432
+ direction?: GetWearablesDirection;
433
+ /**
434
+ * The number of the requested page.
435
+ */
436
+ pageNum?: number;
437
+ /**
438
+ * The size of the requested page.
439
+ */
440
+ pageSize?: number;
145
441
  };
146
442
  export type GetCollections200CollectionsItem = {
147
443
  id: string;
148
444
  name: string;
149
445
  };
150
446
  export type GetCollections200 = {
151
- collections?: GetCollections200CollectionsItem[];
447
+ collections: GetCollections200CollectionsItem[];
448
+ };
449
+ export type GetEntitiesByTypeParams = {
450
+ /**
451
+ * Pointer of the entities to return. Repeat the parameter to request several pointers.
452
+ */
453
+ pointer?: string[];
454
+ /**
455
+ * Id of the entities to return. Repeat the parameter to request several ids.
456
+ */
457
+ id?: string[];
458
+ /**
459
+ * Comma separated list of the fields to include, among `content`, `pointers` and `metadata`. All of them are included by default; omitted `content` and `pointers` are returned empty.
460
+ */
461
+ fields?: string;
462
+ };
463
+ export type GetDeploymentsSortingOrder = (typeof GetDeploymentsSortingOrder)[keyof typeof GetDeploymentsSortingOrder];
464
+ export declare const GetDeploymentsSortingOrder: {
465
+ readonly ASC: "ASC";
466
+ readonly DESC: "DESC";
467
+ };
468
+ export type GetDeploymentsSortingField = (typeof GetDeploymentsSortingField)[keyof typeof GetDeploymentsSortingField];
469
+ export declare const GetDeploymentsSortingField: {
470
+ readonly local_timestamp: "local_timestamp";
471
+ readonly entity_timestamp: "entity_timestamp";
472
+ };
473
+ export type GetDeploymentsEntityTypeItem = (typeof GetDeploymentsEntityTypeItem)[keyof typeof GetDeploymentsEntityTypeItem];
474
+ export declare const GetDeploymentsEntityTypeItem: {
475
+ readonly scene: "scene";
476
+ readonly profile: "profile";
477
+ readonly wearable: "wearable";
478
+ readonly emote: "emote";
479
+ readonly store: "store";
480
+ readonly outfits: "outfits";
481
+ };
482
+ export type GetDeploymentsParams = {
483
+ /**
484
+ * Minimum timestamp (in milliseconds) of the deployments to return. It applies to the field set in `sortingField`, local timestamp by default.
485
+ */
486
+ from?: number;
487
+ /**
488
+ * Maximum timestamp (in milliseconds) of the deployments to return. It applies to the field set in `sortingField`, local timestamp by default.
489
+ */
490
+ to?: number;
491
+ /**
492
+ * Type of the entities to return. Repeat the parameter to filter by several types.
493
+ */
494
+ entityType?: GetDeploymentsEntityTypeItem[];
495
+ /**
496
+ * Id of the entities to return. Repeat the parameter to filter by several ids.
497
+ */
498
+ entityId?: string[];
499
+ /**
500
+ * Return deployments affecting any of these pointers. Repeat the parameter to filter by several pointers.
501
+ */
502
+ pointer?: string[];
503
+ /**
504
+ * When `true`, only active deployments (not overwritten by a newer one) are returned
505
+ */
506
+ onlyCurrentlyPointed?: boolean;
507
+ /**
508
+ * Comma separated list of the optional fields to include in each deployment, among `pointers`, `content`, `metadata` and `auditInfo`. Defaults to `pointers,content,metadata`.
509
+ */
510
+ fields?: string;
511
+ /**
512
+ * Field used to order the deployments.
513
+ */
514
+ sortingField?: GetDeploymentsSortingField;
515
+ /**
516
+ * Order of the deployments
517
+ */
518
+ sortingOrder?: GetDeploymentsSortingOrder;
519
+ /**
520
+ * Id of the last entity of the previous page, used together with `from` or `to` to paginate
521
+ */
522
+ lastId?: string;
523
+ /**
524
+ * Number of deployments to skip. It can't be higher than 5000; use the `next` field of the pagination to go further.
525
+ */
526
+ offset?: number;
527
+ /**
528
+ * Page size. Values out of range fall back to 500.
529
+ */
530
+ limit?: number;
152
531
  };
153
532
  export type GetPointerChangesSortingOrder = (typeof GetPointerChangesSortingOrder)[keyof typeof GetPointerChangesSortingOrder];
154
533
  export declare const GetPointerChangesSortingOrder: {
@@ -160,19 +539,22 @@ export declare const GetPointerChangesSortingField: {
160
539
  readonly local_timestamp: "local_timestamp";
161
540
  readonly entity_timestamp: "entity_timestamp";
162
541
  };
163
- export type GetPointerChangesEntityType = (typeof GetPointerChangesEntityType)[keyof typeof GetPointerChangesEntityType];
164
- export declare const GetPointerChangesEntityType: {
542
+ export type GetPointerChangesEntityTypeItem = (typeof GetPointerChangesEntityTypeItem)[keyof typeof GetPointerChangesEntityTypeItem];
543
+ export declare const GetPointerChangesEntityTypeItem: {
165
544
  readonly scene: "scene";
166
545
  readonly profile: "profile";
167
546
  readonly wearable: "wearable";
547
+ readonly emote: "emote";
548
+ readonly store: "store";
549
+ readonly outfits: "outfits";
168
550
  };
169
551
  export type GetPointerChangesParams = {
170
552
  /**
171
- * Acts as a filter in the collection of deployments, this value is the minimum value of local timestamp that any deployment in the collection will have.
553
+ * Minimum timestamp (in milliseconds) of the deployments to return. It applies to the field set in `sortingField`, local timestamp by default.
172
554
  */
173
555
  from?: number;
174
556
  /**
175
- * Acts as a filter in the collection of deployments, this value is the maximum value of local timestamp that any deployment in the collection will have.
557
+ * Maximum timestamp (in milliseconds) of the deployments to return. It applies to the field set in `sortingField`, local timestamp by default.
176
558
  */
177
559
  to?: number;
178
560
  /**
@@ -180,13 +562,17 @@ export type GetPointerChangesParams = {
180
562
  */
181
563
  lastId?: string;
182
564
  /**
183
- * The deployments are a paginated collection, this parameter corresponds to the limit for each page. The default value is 500.
565
+ * Number of deployments to skip. It can't be higher than 5000; use the `next` field of the pagination to go further.
566
+ */
567
+ offset?: number;
568
+ /**
569
+ * The deployments are a paginated collection, this parameter corresponds to the limit for each page. Values out of range fall back to 500.
184
570
  */
185
571
  limit?: number;
186
572
  /**
187
- * The type of entities that will be shown in the collection, many values can be sent. Valid values are: profile, scene and wearable.
573
+ * The type of entities that will be shown in the collection. Repeat the parameter to filter by several types.
188
574
  */
189
- entityType?: GetPointerChangesEntityType;
575
+ entityType?: GetPointerChangesEntityTypeItem[];
190
576
  /**
191
577
  * This value is used as the field to order all the deployments in the collection. If no parameter is sent, then the default field to order with will be local_timestamp.
192
578
  */
@@ -196,10 +582,29 @@ export type GetPointerChangesParams = {
196
582
  */
197
583
  sortingOrder?: GetPointerChangesSortingOrder;
198
584
  };
585
+ export type GetFailedDeploymentsParams = {
586
+ /**
587
+ * Number of failed deployments to skip
588
+ */
589
+ offset?: number;
590
+ /**
591
+ * Maximum number of failed deployments to return
592
+ */
593
+ limit?: number;
594
+ };
595
+ export type GetActiveEntities400DataItem = {
596
+ [key: string]: any;
597
+ };
598
+ export type GetActiveEntities400 = {
599
+ /** Schema validation errors */
600
+ data?: GetActiveEntities400DataItem[];
601
+ message: string;
602
+ ok: boolean;
603
+ };
199
604
  export type GetActiveEntitiesBody = {
200
- /** Entities must be filtered by pointer (pointers) XOR entityId. Use this parameter if you want to retrieve an entity of the specified type with this entityId. */
605
+ /** Entities must be filtered by pointer (pointers) XOR entityId. Use this parameter if you want to retrieve the active entities with these entityIds. */
201
606
  ids?: string[];
202
- /** Entities must be filtered by pointer XOR entityId (ids). Use this parameter if you want to retrieve an entity of the specified type with this pointer. */
607
+ /** Entities must be filtered by pointer XOR entityId (ids). Use this parameter if you want to retrieve the active entities on these pointers. */
203
608
  pointers?: string[];
204
609
  };
205
610
  export type GetEntitiesByPointerPrefix200 = {
@@ -208,81 +613,257 @@ export type GetEntitiesByPointerPrefix200 = {
208
613
  };
209
614
  export type GetEntitiesByPointerPrefixParams = {
210
615
  /**
211
- * Page size (max 1000)
616
+ * Page size
212
617
  */
213
618
  pageSize?: number;
214
619
  /**
215
- * Page number (default: 1)
620
+ * Page number, starting at 1
216
621
  */
217
- pageNumber?: number;
622
+ pageNum?: number;
218
623
  };
624
+ export type PostEntity503 = Error | Errors;
625
+ export type PostEntity429 = Error | Errors;
219
626
  export type PostEntity400 = Error | Errors;
627
+ export type PostEntity202 = {
628
+ missing: string[];
629
+ };
220
630
  export type PostEntity200 = {
221
631
  creationTimestamp: number;
222
632
  };
223
633
  export type PostEntityBody = {
224
634
  authChain?: string;
225
635
  entityId?: string;
636
+ /**
637
+ * Ignored. The signer is taken from `authChain`.
638
+ * @deprecated
639
+ */
226
640
  ethAddress?: string;
227
641
  files?: Blob[];
642
+ /** Marks the request as one batch of a partial deployment when set to the literal string `true`; any other value makes it a regular deployment. Send it together with the `partial=true` query parameter. The entity file (the multipart file keyed by `entityId`) is required on the first batch. Only the signer who started the upload may add batches, and may omit the entity file on later ones while the upload is live. */
643
+ partial?: string;
644
+ /**
645
+ * Ignored. The signature is taken from `authChain`.
646
+ * @deprecated
647
+ */
228
648
  signature?: string;
229
649
  };
650
+ export type PostEntityParams = {
651
+ /**
652
+ * Declares the request as a partial deployment batch before its body is read when set to the literal string `true`; any other value is ignored. It must be accompanied by the `partial` form field set to `true`, otherwise the request is rejected with `400`. Batches that omit it are still accepted, but a source that has spent its daily quota of regular deployments is rejected with `429` before its body is read unless this parameter is present.
653
+ */
654
+ partial?: string;
655
+ };
230
656
  export type GetAvailableContentParams = {
231
657
  /**
232
- * Hash of the content file
658
+ * Hash of the content file. Repeat the parameter to check several files (up to 1000).
233
659
  */
234
660
  cid: string[];
235
661
  };
236
662
  export type GetEntityIdsByHashId404 = {
237
663
  error: string;
238
664
  };
665
+ export type HeadContentFileParams = {
666
+ /**
667
+ * When present (with any value), the `Content-Type` header is detected from the file contents. Otherwise it is `application/octet-stream`.
668
+ */
669
+ includeMimeType?: string;
670
+ };
671
+ export type GetContentFileParams = {
672
+ /**
673
+ * When present (with any value), the `Content-Type` header is detected from the file contents. Otherwise it is `application/octet-stream`.
674
+ */
675
+ includeMimeType?: string;
676
+ };
239
677
  export type GetChallenge200 = {
240
678
  challengeText: string;
241
679
  };
242
- export type PeersPeersItem = {
243
- address?: string;
244
- id?: string;
245
- lastPing?: number;
246
- parcel?: number[];
247
- position?: number[];
248
- };
249
- export interface Peers {
250
- ok?: boolean;
251
- peers?: PeersPeersItem[];
252
- }
253
- export type IslandIdPeersItem = {
254
- address?: string;
255
- id?: string;
256
- lastPing?: number;
257
- parcel?: number[];
258
- position?: number[];
259
- preferedIslandId?: string;
260
- };
261
- export interface IslandId {
262
- center?: number[];
263
- id?: string;
264
- maxPeers?: number;
265
- peers?: IslandIdPeersItem[];
266
- radius?: number;
267
- }
268
- export type IslandsIslandsItemPeersItem = {
269
- address?: string;
270
- id?: string;
271
- lastPing?: number;
272
- parcel?: number[];
273
- position?: number[];
274
- preferedIslandId?: string;
275
- };
276
- export type IslandsIslandsItem = {
277
- center?: number[];
278
- id?: string;
279
- maxPeers?: number;
280
- peers?: IslandsIslandsItemPeersItem[];
281
- radius?: number;
282
- };
283
- export interface Islands {
284
- islands?: IslandsIslandsItem[];
285
- ok?: boolean;
680
+ /**
681
+ * When `true` together with `trimmed`, adds the number of owned copies as `amount` to each trimmed element. Ignored without `trimmed`.
682
+ */
683
+ export type IncludeAmountParameter = boolean;
684
+ /**
685
+ * When `true`, each element is returned in its trimmed form: a reduced entity with only the fields needed to render the backpack. Otherwise the full form is returned.
686
+ */
687
+ export type TrimmedParameter = boolean;
688
+ /**
689
+ * Number of elements per page. Values above 1000 are rejected with a 400.
690
+ */
691
+ export type PageSizeParameter = number;
692
+ /**
693
+ * Number of the requested page, starting at 1.
694
+ */
695
+ export type PageNumParameter = number;
696
+ export type DirectionParameter = (typeof DirectionParameter)[keyof typeof DirectionParameter];
697
+ export declare const DirectionParameter: {
698
+ readonly ASC: "ASC";
699
+ readonly DESC: "DESC";
700
+ };
701
+ export type OrderByParameter = (typeof OrderByParameter)[keyof typeof OrderByParameter];
702
+ export declare const OrderByParameter: {
703
+ readonly rarity: "rarity";
704
+ readonly name: "name";
705
+ readonly date: "date";
706
+ };
707
+ export type RarityParameter = (typeof RarityParameter)[keyof typeof RarityParameter];
708
+ export declare const RarityParameter: {
709
+ readonly common: "common";
710
+ readonly uncommon: "uncommon";
711
+ readonly rare: "rare";
712
+ readonly epic: "epic";
713
+ readonly legendary: "legendary";
714
+ readonly exotic: "exotic";
715
+ readonly mythic: "mythic";
716
+ readonly unique: "unique";
717
+ };
718
+ /**
719
+ * Only return elements whose name contains this text (case-insensitive).
720
+ */
721
+ export type NameParameter = string;
722
+ /**
723
+ * Only return elements of the given category (case-insensitive). Repeat the parameter to match any of several categories.
724
+ */
725
+ export type CategoryParameter = string[];
726
+ export type EmotesExplorerElementsItem = ExplorerEmote | ExplorerEmoteTrimmed;
727
+ export interface EmotesExplorer {
728
+ /** Full elements by default, trimmed elements when `trimmed` is set. */
729
+ elements: EmotesExplorerElementsItem[];
730
+ pageNum: number;
731
+ pageSize: number;
732
+ /** Number of elements matching the filters across all pages. */
733
+ totalAmount: number;
734
+ }
735
+ export type ExplorerEmoteTrimmedEntityMetadataData = {
736
+ /** Absent for emotes without ADR-74 emote data. */
737
+ category?: string;
738
+ representations: ExplorerTrimmedRepresentation[];
739
+ };
740
+ export type ExplorerEmoteTrimmedEntityMetadata = {
741
+ data: ExplorerEmoteTrimmedEntityMetadataData;
742
+ /** Item URN. */
743
+ id: string;
744
+ name: string;
745
+ rarity?: string;
746
+ };
747
+ export type ExplorerEmoteTrimmedEntity = {
748
+ /** Entity id. */
749
+ id: string;
750
+ individualData: ExplorerIndividualData[];
751
+ metadata: ExplorerEmoteTrimmedEntityMetadata;
752
+ /** Content hash of the thumbnail file. */
753
+ thumbnail?: string;
754
+ };
755
+ /**
756
+ * Trimmed form of an owned emote, returned when `trimmed` is set.
757
+ */
758
+ export interface ExplorerEmoteTrimmed {
759
+ /** Number of owned copies. Only present when `includeAmount` is set. */
760
+ amount?: number;
761
+ entity: ExplorerEmoteTrimmedEntity;
762
+ }
763
+ export type ExplorerEmoteType = (typeof ExplorerEmoteType)[keyof typeof ExplorerEmoteType];
764
+ export declare const ExplorerEmoteType: {
765
+ readonly 'on-chain': "on-chain";
766
+ };
767
+ export type WearablesExplorerElementsItem = ExplorerWearable | ExplorerWearableTrimmed;
768
+ export interface WearablesExplorer {
769
+ /** Full elements by default, trimmed elements when `trimmed` is set. */
770
+ elements: WearablesExplorerElementsItem[];
771
+ pageNum: number;
772
+ pageSize: number;
773
+ /** Number of elements matching the filters across all pages. */
774
+ totalAmount: number;
775
+ }
776
+ export interface ExplorerTrimmedRepresentation {
777
+ bodyShapes: string[];
778
+ }
779
+ export type ExplorerWearableTrimmedEntityMetadataData = {
780
+ category: string;
781
+ representations: ExplorerTrimmedRepresentation[];
782
+ };
783
+ export type ExplorerWearableTrimmedEntityMetadata = {
784
+ data: ExplorerWearableTrimmedEntityMetadataData;
785
+ /** Item URN. */
786
+ id: string;
787
+ isSmart: boolean;
788
+ name: string;
789
+ /** Absent when the entity metadata has no rarity, as with base wearables. */
790
+ rarity?: string;
791
+ };
792
+ export type ExplorerWearableType = (typeof ExplorerWearableType)[keyof typeof ExplorerWearableType];
793
+ export declare const ExplorerWearableType: {
794
+ readonly 'base-wearable': "base-wearable";
795
+ readonly 'on-chain': "on-chain";
796
+ readonly 'third-party': "third-party";
797
+ };
798
+ /**
799
+ * Only present for on-chain wearables.
800
+ */
801
+ export type ExplorerWearableItemType = (typeof ExplorerWearableItemType)[keyof typeof ExplorerWearableItemType];
802
+ export declare const ExplorerWearableItemType: {
803
+ readonly wearable_v1: "wearable_v1";
804
+ readonly wearable_v2: "wearable_v2";
805
+ readonly smart_wearable_v1: "smart_wearable_v1";
806
+ };
807
+ /**
808
+ * One owned copy of the item. Base wearables only carry `id`; third-party wearables may add `tokenId`; on-chain items carry all fields.
809
+ */
810
+ export interface ExplorerIndividualData {
811
+ /** Identifier of the owned copy (the item URN followed by the token id for on-chain items). */
812
+ id: string;
813
+ /** Price paid, in wei, as a string. */
814
+ price?: string;
815
+ tokenId?: string;
816
+ /** Unix timestamp, in seconds, of the transfer to the current owner, as a string. */
817
+ transferredAt?: string;
818
+ }
819
+ /**
820
+ * An emote owned by the address, grouped by URN.
821
+ */
822
+ export interface ExplorerEmote {
823
+ /** Number of owned copies. */
824
+ amount: number;
825
+ category: string;
826
+ entity: Entity;
827
+ individualData: ExplorerIndividualData[];
828
+ /** Present when the item source reports it. */
829
+ itemType?: string;
830
+ name: string;
831
+ rarity: string;
832
+ type: ExplorerEmoteType;
833
+ urn: string;
834
+ }
835
+ export type ExplorerWearableTrimmedEntity = {
836
+ /** Entity id. */
837
+ id: string;
838
+ individualData: ExplorerIndividualData[];
839
+ metadata: ExplorerWearableTrimmedEntityMetadata;
840
+ /** Content hash of the thumbnail file. */
841
+ thumbnail?: string;
842
+ };
843
+ /**
844
+ * Trimmed form of an owned wearable, returned when `trimmed` is set.
845
+ */
846
+ export interface ExplorerWearableTrimmed {
847
+ /** Number of owned copies. Only present when `includeAmount` is set. */
848
+ amount?: number;
849
+ entity: ExplorerWearableTrimmedEntity;
850
+ }
851
+ /**
852
+ * A wearable owned by the address, grouped by URN.
853
+ */
854
+ export interface ExplorerWearable {
855
+ /** Number of owned copies. */
856
+ amount: number;
857
+ category: string;
858
+ entity: Entity;
859
+ individualData: ExplorerIndividualData[];
860
+ /** Only present for on-chain wearables. */
861
+ itemType?: ExplorerWearableItemType;
862
+ name: string;
863
+ /** Only present for on-chain wearables. */
864
+ rarity?: string;
865
+ type: ExplorerWearableType;
866
+ urn: string;
286
867
  }
287
868
  export type ThirdPartyIntegrationsDataItem = {
288
869
  description?: string;
@@ -292,20 +873,30 @@ export type ThirdPartyIntegrationsDataItem = {
292
873
  export interface ThirdPartyIntegrations {
293
874
  data: ThirdPartyIntegrationsDataItem[];
294
875
  }
295
- export type ProfileAvatarsItemNameColor = {
296
- b: number;
297
- g: number;
298
- r: number;
299
- };
300
876
  export type ProfileAvatarsItem = {
301
877
  avatar?: ProfileAvatarsItemAvatar;
878
+ birthdate?: number;
879
+ blocked?: string[];
880
+ country?: string;
302
881
  description?: string;
303
882
  email?: string;
883
+ employmentStatus?: string;
304
884
  ethAddress?: string;
885
+ gender?: string;
305
886
  hasClaimedName?: boolean;
887
+ hasConnectedWeb3?: boolean;
888
+ hobbies?: string;
306
889
  interests?: string[];
890
+ language?: string;
891
+ links?: ProfileAvatarsItemLinksItem[];
892
+ muted?: string[];
307
893
  name?: string;
308
894
  nameColor?: ProfileAvatarsItemNameColor;
895
+ profession?: string;
896
+ pronouns?: string;
897
+ realName?: string;
898
+ relationshipStatus?: string;
899
+ sexualOrientation?: string;
309
900
  tutorialStep?: number;
310
901
  unclaimedName?: string;
311
902
  userId?: string;
@@ -315,6 +906,15 @@ export interface Profile {
315
906
  avatars?: ProfileAvatarsItem[];
316
907
  timestamp?: number;
317
908
  }
909
+ export type ProfileAvatarsItemNameColor = {
910
+ b: number;
911
+ g: number;
912
+ r: number;
913
+ };
914
+ export type ProfileAvatarsItemLinksItem = {
915
+ title: string;
916
+ url: string;
917
+ };
318
918
  export type ProfileAvatarsItemAvatarSnapshots = {
319
919
  body?: string;
320
920
  face?: string;
@@ -339,6 +939,17 @@ export type ProfileAvatarsItemAvatarHairColor = {
339
939
  export type ProfileAvatarsItemAvatarHair = {
340
940
  color?: ProfileAvatarsItemAvatarHairColor;
341
941
  };
942
+ export type ProfileAvatarsItemAvatar = {
943
+ bodyShape?: string;
944
+ emotes?: ProfileAvatarsItemAvatarEmotesItem[];
945
+ eyes?: ProfileAvatarsItemAvatarEyes;
946
+ /** Wearable categories rendered even when hidden by other wearables */
947
+ forceRender?: string[];
948
+ hair?: ProfileAvatarsItemAvatarHair;
949
+ skin?: ProfileAvatarsItemAvatarSkin;
950
+ snapshots?: ProfileAvatarsItemAvatarSnapshots;
951
+ wearables?: string[];
952
+ };
342
953
  export type ProfileAvatarsItemAvatarEyesColor = {
343
954
  a?: number;
344
955
  b?: number;
@@ -352,54 +963,52 @@ export type ProfileAvatarsItemAvatarEmotesItem = {
352
963
  slot?: number;
353
964
  urn?: string;
354
965
  };
355
- export type ProfileAvatarsItemAvatar = {
356
- bodyShape?: string;
357
- emotes?: ProfileAvatarsItemAvatarEmotesItem[];
358
- eyes?: ProfileAvatarsItemAvatarEyes;
359
- hair?: ProfileAvatarsItemAvatarHair;
360
- skin?: ProfileAvatarsItemAvatarSkin;
361
- snapshots?: ProfileAvatarsItemAvatarSnapshots;
362
- wearables?: string[];
363
- };
364
966
  export interface PostProfiles {
365
- ids?: string[];
967
+ ids: string[];
366
968
  }
367
969
  export interface ParcelOperators {
368
- address: string;
369
970
  approvedForAll: string[];
370
971
  operator: string | null;
972
+ owner: string;
371
973
  updateManagers: string[];
372
974
  updateOperator: string | null;
373
975
  }
374
- export type RealmsItem = {
375
- layer?: string;
376
- maxUsers?: number;
377
- serverName?: string;
378
- url?: string;
379
- userParcels?: number[][];
380
- usersCount?: number;
381
- };
382
- export type Realms = RealmsItem[];
383
- export type HotScenesItemRealmsItem = {
384
- layer?: string;
385
- maxUsers?: number;
386
- serverName?: string;
387
- url?: string;
388
- userParcels?: number[][];
389
- usersCount?: number;
390
- };
391
- export type HotScenesItem = {
392
- baseCoords?: number[];
393
- creator?: string;
394
- description?: string;
395
- id?: string;
396
- name?: string;
397
- parcels?: number[][];
398
- realms?: HotScenesItemRealmsItem[];
399
- thumbnail?: string;
400
- usersTotalCount?: number;
976
+ export type SchemaValidationErrorDataItem = {
977
+ [key: string]: any;
401
978
  };
402
- export type HotScenes = HotScenesItem[];
979
+ export interface SchemaValidationError {
980
+ /** JSON schema validation errors */
981
+ data?: SchemaValidationErrorDataItem[];
982
+ message: string;
983
+ ok: boolean;
984
+ }
985
+ export interface ValidateSignatureResponse {
986
+ /** Reason the validation failed */
987
+ error?: string;
988
+ /** Address of the first link of the chain. Present only when the signature is valid. */
989
+ ownerAddress?: string;
990
+ valid: boolean;
991
+ }
992
+ export type ValidateSignatureRequestAuthChainItemType = (typeof ValidateSignatureRequestAuthChainItemType)[keyof typeof ValidateSignatureRequestAuthChainItemType];
993
+ export declare const ValidateSignatureRequestAuthChainItemType: {
994
+ readonly SIGNER: "SIGNER";
995
+ readonly ECDSA_EPHEMERAL: "ECDSA_EPHEMERAL";
996
+ readonly ECDSA_SIGNED_ENTITY: "ECDSA_SIGNED_ENTITY";
997
+ readonly ECDSA_EIP_1654_EPHEMERAL: "ECDSA_EIP_1654_EPHEMERAL";
998
+ readonly ECDSA_EIP_1654_SIGNED_ENTITY: "ECDSA_EIP_1654_SIGNED_ENTITY";
999
+ };
1000
+ export type ValidateSignatureRequestAuthChainItem = {
1001
+ payload: string;
1002
+ /** Required for every link except `SIGNER`, which takes an empty string or null */
1003
+ signature?: string | null;
1004
+ type: ValidateSignatureRequestAuthChainItemType;
1005
+ };
1006
+ export interface ValidateSignatureRequest {
1007
+ authChain: ValidateSignatureRequestAuthChainItem[];
1008
+ signedMessage?: string;
1009
+ /** Legacy alternative to `signedMessage`, used only when `signedMessage` is absent */
1010
+ timestamp?: string;
1011
+ }
403
1012
  export type DenylistedUsernames = string[];
404
1013
  export type Pois = string[];
405
1014
  export type ServersItem = {
@@ -408,77 +1017,83 @@ export type ServersItem = {
408
1017
  owner: string;
409
1018
  };
410
1019
  export type Servers = ServersItem[];
411
- export type WearablesWearablesItemI18nItem = {
412
- code?: string;
413
- text?: string;
414
- };
415
- export type WearablesWearablesItem = {
416
- collectionAddress?: string;
417
- createdAt?: number;
418
- data?: WearablesWearablesItemData;
419
- description?: string;
420
- i18n?: WearablesWearablesItemI18nItem[];
421
- id?: string;
422
- image?: string;
423
- rarity?: string;
424
- thumbnail?: string;
425
- updatedAt?: number;
426
- };
427
- export type WearablesWearablesItemDataRepresentationsItemOverrideReplacesItem = {
428
- [key: string]: any;
429
- };
430
- export type WearablesWearablesItemDataRepresentationsItemOverrideHidesItem = {
431
- [key: string]: any;
432
- };
433
- export type WearablesWearablesItemDataRepresentationsItemContentsItem = {
434
- key?: string;
435
- url?: string;
436
- };
437
- export type WearablesWearablesItemDataRepresentationsItem = {
438
- bodyShapes?: string[];
439
- contents?: WearablesWearablesItemDataRepresentationsItemContentsItem[];
440
- mainFile?: string;
441
- overrideHides?: WearablesWearablesItemDataRepresentationsItemOverrideHidesItem[];
442
- overrideReplaces?: WearablesWearablesItemDataRepresentationsItemOverrideReplacesItem[];
443
- };
444
- export type WearablesWearablesItemData = {
445
- category?: string;
446
- hides?: string[];
447
- replaces?: string[];
448
- representations?: WearablesWearablesItemDataRepresentationsItem[];
449
- tags?: string[];
450
- };
451
- export type WearablesPagination = {
452
- limit?: number;
1020
+ export interface NameOwner {
1021
+ /** Ethereum address of the owner of the name */
1022
+ owner: string;
1023
+ }
1024
+ export interface CatalogPagination {
1025
+ /** The `lastId` received in the request, if any */
1026
+ lastId?: string;
1027
+ limit: number;
1028
+ /** Query string to request the next page. Absent on the last page. */
453
1029
  next?: string;
454
- };
455
- export type WearablesFilters = {
1030
+ }
1031
+ /**
1032
+ * Filters applied to the search, lowercased
1033
+ */
1034
+ export interface CatalogFilters {
1035
+ collectionIds?: string[];
1036
+ itemIds?: string[];
456
1037
  textSearch?: string;
457
- };
1038
+ }
1039
+ export interface Emotes {
1040
+ emotes: EmoteDefinition[];
1041
+ filters: CatalogFilters;
1042
+ pagination: CatalogPagination;
1043
+ }
458
1044
  export interface Wearables {
459
- filters?: WearablesFilters;
460
- pagination?: WearablesPagination;
461
- wearables?: WearablesWearablesItem[];
1045
+ filters: CatalogFilters;
1046
+ pagination: CatalogPagination;
1047
+ wearables: WearableDefinition[];
462
1048
  }
463
1049
  export type ThirdPartyWearableIndividualDataItem = {
464
- id?: string;
1050
+ id: string;
1051
+ tokenId?: string;
465
1052
  };
1053
+ export interface ThirdPartyWearable {
1054
+ amount: number;
1055
+ category: string;
1056
+ /** Present only when `includeDefinitions` is set */
1057
+ definition?: WearableDefinition;
1058
+ entity: Entity;
1059
+ individualData: ThirdPartyWearableIndividualDataItem[];
1060
+ name: string;
1061
+ urn: string;
1062
+ }
466
1063
  export interface ParcelPermissions {
467
- address: boolean;
468
1064
  approvedForAll: boolean;
469
1065
  operator: boolean;
1066
+ owner: boolean;
470
1067
  updateManager: boolean;
471
1068
  updateOperator: boolean;
472
1069
  }
1070
+ export type LandsPermissionsPaginatedElementsItem = {
1071
+ /** Parcel id in the LAND subgraph */
1072
+ id: string;
1073
+ owner: string;
1074
+ updateOperator: string;
1075
+ x: string;
1076
+ y: string;
1077
+ };
1078
+ export interface LandsPermissionsPaginated {
1079
+ elements: LandsPermissionsPaginatedElementsItem[];
1080
+ pageNum: number;
1081
+ pageSize: number;
1082
+ totalAmount: number;
1083
+ }
473
1084
  export type LandsPaginatedElementsItem = {
1085
+ /** `parcel` or `estate` */
474
1086
  category: string;
475
1087
  contractAddress: string;
476
1088
  description?: string;
477
1089
  image?: string;
478
1090
  name?: string;
1091
+ /** Price in wei of the active order, if any */
479
1092
  price?: string;
480
1093
  tokenId: string;
1094
+ /** Present only for parcels */
481
1095
  x?: string;
1096
+ /** Present only for parcels */
482
1097
  y?: string;
483
1098
  };
484
1099
  export interface LandsPaginated {
@@ -490,6 +1105,7 @@ export interface LandsPaginated {
490
1105
  export type NamesPaginatedElementsItem = {
491
1106
  contractAddress: string;
492
1107
  name: string;
1108
+ /** Price in wei of the active order, if any */
493
1109
  price?: string;
494
1110
  tokenId: string;
495
1111
  };
@@ -499,67 +1115,223 @@ export interface NamesPaginated {
499
1115
  pageSize: number;
500
1116
  totalAmount: number;
501
1117
  }
502
- export interface Emote {
503
- amount?: number;
1118
+ export type EmoteDefinitionEmoteDataADR74RepresentationsItem = {
1119
+ bodyShapes: string[];
1120
+ contents: ItemContents;
1121
+ mainFile: string;
1122
+ };
1123
+ export type EmoteDefinitionEmoteDataADR74 = {
504
1124
  category: string;
505
- entity?: Entity;
506
- urn: string;
507
- }
1125
+ loop: boolean;
1126
+ representations: EmoteDefinitionEmoteDataADR74RepresentationsItem[];
1127
+ tags: string[];
1128
+ };
508
1129
  export interface LambdasError {
509
1130
  error: string;
510
1131
  message: string;
511
1132
  }
512
- export type WearableIndividualDataItem = {
513
- id?: string;
514
- price?: string;
515
- tokenId?: string;
516
- transferredAt?: string;
517
- };
518
1133
  export interface Wearable {
519
- amount?: number;
1134
+ /** Number of tokens of this item owned by the address */
1135
+ amount: number;
520
1136
  category: string;
1137
+ /** Present only when `includeDefinitions` is set */
1138
+ definition?: WearableDefinition;
1139
+ /** Present only when `includeEntities` is set */
521
1140
  entity?: Entity;
522
- individualData?: WearableIndividualDataItem[];
1141
+ individualData: ItemIndividualData;
523
1142
  name: string;
524
1143
  rarity: string;
525
1144
  urn: string;
526
1145
  }
1146
+ export type WearableDefinitionData = {
1147
+ category: string;
1148
+ hides: string[];
1149
+ removesDefaultHiding?: string[];
1150
+ replaces: string[];
1151
+ representations: WearableDefinitionDataRepresentationsItem[];
1152
+ tags: string[];
1153
+ };
1154
+ export interface ItemMetrics {
1155
+ bodies?: number;
1156
+ entities?: number;
1157
+ materials?: number;
1158
+ meshes?: number;
1159
+ textures?: number;
1160
+ triangles?: number;
1161
+ }
1162
+ /**
1163
+ * Emote metadata with its file references resolved to content server URLs
1164
+ */
1165
+ export interface EmoteDefinition {
1166
+ collectionAddress?: string;
1167
+ description: string;
1168
+ emoteDataADR74: EmoteDefinitionEmoteDataADR74;
1169
+ i18n: ItemI18n;
1170
+ id: string;
1171
+ image: string;
1172
+ metrics?: ItemMetrics;
1173
+ name: string;
1174
+ rarity?: string;
1175
+ thumbnail: string;
1176
+ }
1177
+ export interface Emote {
1178
+ /** Number of tokens of this item owned by the address */
1179
+ amount: number;
1180
+ category: string;
1181
+ /** Present only when `includeDefinitions` is set */
1182
+ definition?: EmoteDefinition;
1183
+ /** Present only when `includeEntities` is set */
1184
+ entity?: Entity;
1185
+ individualData: ItemIndividualData;
1186
+ name: string;
1187
+ rarity: string;
1188
+ urn: string;
1189
+ }
1190
+ /**
1191
+ * Wearable metadata with its file references resolved to content server URLs
1192
+ */
1193
+ export interface WearableDefinition {
1194
+ collectionAddress?: string;
1195
+ data: WearableDefinitionData;
1196
+ description: string;
1197
+ i18n: ItemI18n;
1198
+ id: string;
1199
+ image: string;
1200
+ metrics?: ItemMetrics;
1201
+ name: string;
1202
+ rarity?: string;
1203
+ thumbnail: string;
1204
+ }
1205
+ export type ItemContentsItem = {
1206
+ key: string;
1207
+ url: string;
1208
+ };
1209
+ /**
1210
+ * Files of the representation, with their absolute content server URL
1211
+ */
1212
+ export type ItemContents = ItemContentsItem[];
1213
+ export type WearableDefinitionDataRepresentationsItem = {
1214
+ bodyShapes: string[];
1215
+ contents: ItemContents;
1216
+ mainFile: string;
1217
+ overrideHides: string[];
1218
+ overrideReplaces: string[];
1219
+ };
1220
+ export type ItemI18nItem = {
1221
+ code: string;
1222
+ text: string;
1223
+ };
1224
+ export type ItemI18n = ItemI18nItem[];
1225
+ export type ItemIndividualDataItem = {
1226
+ /** Item URN followed by `:<tokenId>` */
1227
+ id: string;
1228
+ /** Price in wei, sent as a string */
1229
+ price: string;
1230
+ tokenId: string;
1231
+ /** Unix timestamp in seconds, sent as a string */
1232
+ transferredAt: string;
1233
+ };
1234
+ /**
1235
+ * One entry per owned token
1236
+ */
1237
+ export type ItemIndividualData = ItemIndividualDataItem[];
527
1238
  export type Erc721AttributesItem = {
528
1239
  trait_type?: string;
529
1240
  value?: string;
530
1241
  };
531
1242
  export interface Erc721 {
532
- attributes?: Erc721AttributesItem[];
533
- description?: string;
534
- id?: string;
1243
+ attributes: Erc721AttributesItem[];
1244
+ description: string;
1245
+ /** URN of the item */
1246
+ id: string;
1247
+ /** URL of the item image, if it has one */
535
1248
  image?: string;
536
- language?: string;
1249
+ language: string;
537
1250
  name?: string;
1251
+ /** URL of the item thumbnail, if it has one */
538
1252
  thumbnail?: string;
539
1253
  }
1254
+ export interface LambdasInternalError {
1255
+ error: string;
1256
+ }
540
1257
  export interface StatusLambdas {
541
- commitHash?: string;
542
- currentTime?: number;
543
- version?: string;
1258
+ commitHash: string;
1259
+ /** Server time in milliseconds since epoch */
1260
+ currentTime: number;
1261
+ version: string;
544
1262
  }
545
- export type StatusContentSynchronizationStatusOtherServersItem = {
546
- address: string;
547
- connectionState: string;
548
- lastDeploymentTimestamp: number;
1263
+ export type DeploymentsPagination = {
1264
+ lastId?: string;
1265
+ limit: number;
1266
+ /** Whether there are more deployments after this page */
1267
+ moreData: boolean;
1268
+ /** Query string to request the next page, present when `moreData` is true */
1269
+ next?: string;
1270
+ offset: number;
1271
+ };
1272
+ /**
1273
+ * Filters applied to the request
1274
+ */
1275
+ export type DeploymentsFilters = {
1276
+ entityIds?: string[];
1277
+ entityTypes?: string[];
1278
+ from?: number;
1279
+ onlyCurrentlyPointed?: boolean;
1280
+ pointers?: string[];
1281
+ to?: number;
1282
+ };
1283
+ /**
1284
+ * Present when `metadata` is in `fields` and the entity has metadata
1285
+ */
1286
+ export type DeploymentsDeploymentsItemMetadata = {
1287
+ [key: string]: any;
1288
+ };
1289
+ export type DeploymentsDeploymentsItemContentItem = {
1290
+ hash: string;
1291
+ /** File name */
1292
+ key: string;
1293
+ };
1294
+ /**
1295
+ * Present when `auditInfo` is in `fields`
1296
+ */
1297
+ export type DeploymentsDeploymentsItemAuditInfo = {
1298
+ authChain: AuthChain;
1299
+ localTimestamp: number;
1300
+ version: string;
1301
+ };
1302
+ export type DeploymentsDeploymentsItem = {
1303
+ /** Present when `auditInfo` is in `fields` */
1304
+ auditInfo?: DeploymentsDeploymentsItemAuditInfo;
1305
+ /** Present when `content` is in `fields` */
1306
+ content?: DeploymentsDeploymentsItemContentItem[];
1307
+ /** Address of the deployer */
1308
+ deployedBy: string;
1309
+ entityId: string;
1310
+ entityTimestamp: number;
1311
+ entityType: string;
1312
+ entityVersion: string;
1313
+ /** Timestamp at which this server stored the deployment */
1314
+ localTimestamp: number;
1315
+ /** Present when `metadata` is in `fields` and the entity has metadata */
1316
+ metadata?: DeploymentsDeploymentsItemMetadata;
1317
+ /** Present when `pointers` is in `fields` */
1318
+ pointers?: string[];
549
1319
  };
1320
+ export interface Deployments {
1321
+ deployments: DeploymentsDeploymentsItem[];
1322
+ /** Filters applied to the request */
1323
+ filters: DeploymentsFilters;
1324
+ pagination: DeploymentsPagination;
1325
+ }
550
1326
  export type StatusContentSynchronizationStatus = {
1327
+ /** Timestamp of the last time the list of servers was refreshed from the DAO (0 if it hasn't happened yet) */
551
1328
  lastSyncWithDAO: number;
552
- lastSyncWithOtherServers?: number;
553
- otherServers?: StatusContentSynchronizationStatusOtherServersItem[];
1329
+ /** `Bootstrapping` while the server is catching up with the rest of the network, during which it rejects new deployments; `Syncing` afterwards */
554
1330
  synchronizationState: string;
555
1331
  };
556
1332
  export interface StatusContent {
557
1333
  commitHash: string;
558
- currentTime?: number;
559
1334
  ethNetwork: string;
560
- historySize?: number;
561
- lastImmutableTime?: number;
562
- name?: string;
563
1335
  synchronizationStatus: StatusContentSynchronizationStatus;
564
1336
  version: string;
565
1337
  }
@@ -575,22 +1347,52 @@ export type SnapshotsItem = {
575
1347
  timeRange: SnapshotsItemTimeRange;
576
1348
  };
577
1349
  export type Snapshots = SnapshotsItem[];
1350
+ export type PointerChangesPagination = {
1351
+ limit: number;
1352
+ /** Whether there are more deployments after this page */
1353
+ moreData: boolean;
1354
+ /** Query string to request the next page, present when `moreData` is true */
1355
+ next?: string;
1356
+ offset: number;
1357
+ };
1358
+ /**
1359
+ * Filters applied to the request
1360
+ */
1361
+ export type PointerChangesFilters = {
1362
+ entityTypes?: string[];
1363
+ from?: number;
1364
+ includeAuthChain?: boolean;
1365
+ to?: number;
1366
+ };
578
1367
  export type PointerChangesDeltasItem = {
579
1368
  authChain: AuthChain;
1369
+ deployerAddress?: string;
1370
+ deploymentId?: number;
580
1371
  entityId: string;
1372
+ entityTimestamp: number;
581
1373
  entityType: string;
582
1374
  localTimestamp: number;
583
1375
  pointers: string[];
1376
+ version?: string;
584
1377
  };
585
1378
  export interface PointerChanges {
586
1379
  deltas: PointerChangesDeltasItem[];
1380
+ /** Filters applied to the request */
1381
+ filters?: PointerChangesFilters;
1382
+ pagination?: PointerChangesPagination;
587
1383
  }
588
1384
  export type FailedDeploymentsItem = {
1385
+ authChain: AuthChain;
589
1386
  entityId: string;
590
1387
  entityType: string;
591
1388
  errorDescription: string;
592
- failedDeploymentsRepo?: string;
1389
+ failureTimestamp: number;
1390
+ /** Timestamp after which the deployment will be retried */
1391
+ nextRetryAt?: number;
593
1392
  reason: string;
1393
+ retryCount?: number;
1394
+ /** Hash of the snapshot the entity was found in, when it was synchronized from a snapshot */
1395
+ snapshotHash?: string;
594
1396
  };
595
1397
  export type FailedDeployments = FailedDeploymentsItem[];
596
1398
  export type EntityMetadata = {
@@ -609,14 +1411,6 @@ export interface Entity {
609
1411
  type: string;
610
1412
  version: string;
611
1413
  }
612
- export interface ThirdPartyWearable {
613
- amount?: number;
614
- category: string;
615
- entity: Entity;
616
- individualData?: ThirdPartyWearableIndividualDataItem[];
617
- name: string;
618
- urn: string;
619
- }
620
1414
  export interface Errors {
621
1415
  errors: string[];
622
1416
  }
@@ -636,23 +1430,9 @@ export type AuthChainItem = {
636
1430
  export type AuthChain = AuthChainItem[];
637
1431
  export interface AuditResponse {
638
1432
  authChain: AuthChain;
639
- denylistedContent?: string[];
640
- isDenylisted?: boolean;
641
1433
  localTimestamp: number;
642
- overwrittenBy?: string;
643
1434
  version: string;
644
1435
  }
645
- export type StatsParcelsParcelsItemParcel = {
646
- x?: number;
647
- y?: number;
648
- };
649
- export type StatsParcelsParcelsItem = {
650
- parcel?: StatsParcelsParcelsItemParcel;
651
- peersCount?: number;
652
- };
653
- export interface StatsParcels {
654
- parcels?: StatsParcelsParcelsItem[];
655
- }
656
1436
  export type AboutLambdas = {
657
1437
  commitHash?: string;
658
1438
  healthy: boolean;