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