@3dverse/api 0.10.0 → 0.10.1

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.
@@ -53,118 +53,6 @@ export type User = {
53
53
  /** The user registration date */
54
54
  registered_at: string;
55
55
  };
56
- export type AssetList = {
57
- action_maps?: Array<{
58
- /** Asset unique identifier */
59
- asset_id: string;
60
- name: string;
61
- }>;
62
- animation_graphs?: Array<{
63
- /** Asset unique identifier */
64
- asset_id: string;
65
- name: string;
66
- }>;
67
- animation_sequences?: Array<{
68
- /** Asset unique identifier */
69
- asset_id: string;
70
- name: string;
71
- }>;
72
- animation_sets?: Array<{
73
- /** Asset unique identifier */
74
- asset_id: string;
75
- name: string;
76
- }>;
77
- animations?: Array<{
78
- /** Asset unique identifier */
79
- asset_id: string;
80
- name: string;
81
- }>;
82
- collision_geometries?: Array<{
83
- /** Asset unique identifier */
84
- asset_id: string;
85
- name: string;
86
- }>;
87
- cubemaps?: Array<{
88
- /** Asset unique identifier */
89
- asset_id: string;
90
- name: string;
91
- }>;
92
- event_maps?: Array<{
93
- /** Asset unique identifier */
94
- asset_id: string;
95
- name: string;
96
- }>;
97
- materials?: Array<{
98
- /** Asset unique identifier */
99
- asset_id: string;
100
- name: string;
101
- }>;
102
- meshes?: Array<{
103
- /** Asset unique identifier */
104
- asset_id: string;
105
- name: string;
106
- }>;
107
- modules?: Array<{
108
- /** Asset unique identifier */
109
- asset_id: string;
110
- name: string;
111
- }>;
112
- point_clouds?: Array<{
113
- /** Asset unique identifier */
114
- asset_id: string;
115
- name: string;
116
- }>;
117
- render_graphs?: Array<{
118
- /** Asset unique identifier */
119
- asset_id: string;
120
- name: string;
121
- }>;
122
- scenes?: Array<{
123
- /** Asset unique identifier */
124
- asset_id: string;
125
- name: string;
126
- }>;
127
- scripts?: Array<{
128
- /** Asset unique identifier */
129
- asset_id: string;
130
- name: string;
131
- }>;
132
- shader_contexts?: Array<{
133
- /** Asset unique identifier */
134
- asset_id: string;
135
- name: string;
136
- }>;
137
- shaders?: Array<{
138
- /** Asset unique identifier */
139
- asset_id: string;
140
- name: string;
141
- }>;
142
- skeletons?: Array<{
143
- /** Asset unique identifier */
144
- asset_id: string;
145
- name: string;
146
- }>;
147
- sounds?: Array<{
148
- /** Asset unique identifier */
149
- asset_id: string;
150
- name: string;
151
- }>;
152
- textures?: Array<{
153
- /** Asset unique identifier */
154
- asset_id: string;
155
- name: string;
156
- }>;
157
- textures_3d?: Array<{
158
- /** Asset unique identifier */
159
- asset_id: string;
160
- name: string;
161
- }>;
162
- volume_materials?: Array<{
163
- /** Asset unique identifier */
164
- asset_id: string;
165
- name: string;
166
- }>;
167
- };
168
56
  /** The user token object only supplies a user token for validation when connecting to a session. */
169
57
  export type Token = {
170
58
  user_token: string;
@@ -204,7 +92,7 @@ export type UploadTaskId = string;
204
92
  /** Folder unique identifier */
205
93
  export type FolderId = string;
206
94
  export type ConversionProgress = number;
207
- /** Asset unique identifier */
95
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
208
96
  export type AssetId = string;
209
97
  /** Source file unique identifier */
210
98
  export type SourceFileId = string;
@@ -281,6 +169,12 @@ export type AssetListFilters = {
281
169
  asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_3d' | 'volume_material'>;
282
170
  /** Look for assets associated with or without libraries */
283
171
  library?: Array<string> | string | 'exclude';
172
+ /**
173
+ * The assets shared at these scopes, an asset's widest: `environment`, the folder's assets shared no further;
174
+ * `platform`, those shared with the platform, the folder's and those of any other environment. The folder's
175
+ * assets alone when absent.
176
+ */
177
+ sharing_scopes?: Array<'environment' | 'platform'>;
284
178
  /** Look for assets associated with or without source files */
285
179
  source_file?: Array<string> | string | 'exclude';
286
180
  };
@@ -295,7 +189,119 @@ export type AssetsCount = {
295
189
  /** Total number of assets in target folder of specific type. */
296
190
  [asset_type: string]: number;
297
191
  };
298
- export type AssetTypeCreatable = 'action_map' | 'animation_graph' | 'animation_sequence' | 'cubemap' | 'event_map' | 'material' | 'module' | 'render_graph' | 'scene' | 'script' | 'shader' | 'volume_material';
192
+ export type AssetList = {
193
+ action_maps?: Array<{
194
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
195
+ asset_id: string;
196
+ name: string;
197
+ }>;
198
+ animation_graphs?: Array<{
199
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
200
+ asset_id: string;
201
+ name: string;
202
+ }>;
203
+ animation_sequences?: Array<{
204
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
205
+ asset_id: string;
206
+ name: string;
207
+ }>;
208
+ animation_sets?: Array<{
209
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
210
+ asset_id: string;
211
+ name: string;
212
+ }>;
213
+ animations?: Array<{
214
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
215
+ asset_id: string;
216
+ name: string;
217
+ }>;
218
+ collision_geometries?: Array<{
219
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
220
+ asset_id: string;
221
+ name: string;
222
+ }>;
223
+ cubemaps?: Array<{
224
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
225
+ asset_id: string;
226
+ name: string;
227
+ }>;
228
+ event_maps?: Array<{
229
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
230
+ asset_id: string;
231
+ name: string;
232
+ }>;
233
+ materials?: Array<{
234
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
235
+ asset_id: string;
236
+ name: string;
237
+ }>;
238
+ meshes?: Array<{
239
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
240
+ asset_id: string;
241
+ name: string;
242
+ }>;
243
+ modules?: Array<{
244
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
245
+ asset_id: string;
246
+ name: string;
247
+ }>;
248
+ point_clouds?: Array<{
249
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
250
+ asset_id: string;
251
+ name: string;
252
+ }>;
253
+ render_graphs?: Array<{
254
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
255
+ asset_id: string;
256
+ name: string;
257
+ }>;
258
+ scenes?: Array<{
259
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
260
+ asset_id: string;
261
+ name: string;
262
+ }>;
263
+ scripts?: Array<{
264
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
265
+ asset_id: string;
266
+ name: string;
267
+ }>;
268
+ shader_contexts?: Array<{
269
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
270
+ asset_id: string;
271
+ name: string;
272
+ }>;
273
+ shaders?: Array<{
274
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
275
+ asset_id: string;
276
+ name: string;
277
+ }>;
278
+ skeletons?: Array<{
279
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
280
+ asset_id: string;
281
+ name: string;
282
+ }>;
283
+ sounds?: Array<{
284
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
285
+ asset_id: string;
286
+ name: string;
287
+ }>;
288
+ textures?: Array<{
289
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
290
+ asset_id: string;
291
+ name: string;
292
+ }>;
293
+ textures_3d?: Array<{
294
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
295
+ asset_id: string;
296
+ name: string;
297
+ }>;
298
+ volume_materials?: Array<{
299
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
300
+ asset_id: string;
301
+ name: string;
302
+ }>;
303
+ };
304
+ export type AssetTypeCreatable = 'action_map' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'cubemap' | 'event_map' | 'material' | 'module' | 'render_graph' | 'scene' | 'script' | 'shader' | 'volume_material';
299
305
  /** Asset description */
300
306
  export type BasicAssetDescription = {
301
307
  uuid?: AssetId;
@@ -303,7 +309,7 @@ export type BasicAssetDescription = {
303
309
  };
304
310
  export type AssetType = 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_3d' | 'volume_material';
305
311
  export type AssetItem = {
306
- /** Asset unique identifier */
312
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
307
313
  asset_id: string;
308
314
  name: string;
309
315
  };
@@ -376,11 +382,13 @@ export type Session = {
376
382
  };
377
383
  /**
378
384
  * - `draft`: the plan is being reviewed, and expires unless confirmed.
379
- * - `queued`: confirmed, waiting for a content service to fill the copies: never leased yet, or its lease expired.
380
385
  * - `running`: confirmed, and leased to a content service filling the copies.
386
+ * - `queued`: running, but its lease expired, its filling having crashed or stalled: for a content service to grab,
387
+ * with `grabDuplicationRequest`.
388
+ * - `completed`: its copies filled, and moved into their folders. Kept for a few minutes, for a caller following it.
381
389
  * - `failed`: given up, with its error. Its copies are deleted.
382
390
  */
383
- export type DuplicationRequestState = 'draft' | 'queued' | 'running' | 'failed';
391
+ export type DuplicationRequestState = 'draft' | 'queued' | 'running' | 'completed' | 'failed';
384
392
  export type DuplicationRequestSummary = {
385
393
  /** How many copies the request makes, the excluded ones left out */
386
394
  asset_count: number;
@@ -396,20 +404,22 @@ export type DuplicationRequestSummary = {
396
404
  /** The size of the payloads to copy, in bytes */
397
405
  payload_size: number;
398
406
  roots: Array<{
399
- /** Asset unique identifier */
407
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
400
408
  asset_id: string;
401
409
  asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_3d' | 'volume_material';
402
- /** Asset unique identifier */
410
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
403
411
  duplicated_from: string;
404
412
  name: string;
405
413
  }>;
406
414
  /**
407
415
  * - `draft`: the plan is being reviewed, and expires unless confirmed.
408
- * - `queued`: confirmed, waiting for a content service to fill the copies: never leased yet, or its lease expired.
409
416
  * - `running`: confirmed, and leased to a content service filling the copies.
417
+ * - `queued`: running, but its lease expired, its filling having crashed or stalled: for a content service to grab,
418
+ * with `grabDuplicationRequest`.
419
+ * - `completed`: its copies filled, and moved into their folders. Kept for a few minutes, for a caller following it.
410
420
  * - `failed`: given up, with its error. Its copies are deleted.
411
421
  */
412
- state: 'draft' | 'queued' | 'running' | 'failed';
422
+ state: 'draft' | 'queued' | 'running' | 'completed' | 'failed';
413
423
  /** User unique identifier */
414
424
  user_id: string;
415
425
  };
@@ -422,19 +432,20 @@ export type DuplicationFolderByType = {
422
432
  folder_id: string;
423
433
  };
424
434
  /**
425
- * A plan duplicating assets: the copies, created in the graph but in no folder until the request completes, each
426
- * `DUPLICATED_FROM` its source. The content service fills them, from their sources, then completes the request.
435
+ * A plan duplicating assets: the copies, planned in a draft, then created in the graph once confirmed, in no folder
436
+ * until the request completes, each `DUPLICATED_FROM` its source. The content service fills them, from their sources,
437
+ * then completes the request.
427
438
  */
428
439
  export type DuplicationRequest = {
429
440
  asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_3d' | 'volume_material'>;
430
- /** The copies, sorted by id. A failed request has none left. */
441
+ /** The copies, sorted by id. A completed or failed request has none left. */
431
442
  assets: Array<{
432
443
  /** The id of the copy */
433
444
  asset_id: string;
434
445
  asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_3d' | 'volume_material';
435
446
  /** What it depends on, copies and sources alike */
436
447
  dependencies: Array<{
437
- /** Asset unique identifier */
448
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
438
449
  asset_id: string;
439
450
  count: number;
440
451
  }>;
@@ -467,7 +478,7 @@ export type DuplicationRequest = {
467
478
  duplication_request_id: string;
468
479
  /** Why a failed request failed */
469
480
  error?: string;
470
- /** When a draft, or a failed request, is deleted */
481
+ /** When a draft, a completed request or a failed one is deleted */
471
482
  expires_at?: string;
472
483
  folders_by_type: Array<{
473
484
  asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_3d' | 'volume_material';
@@ -480,18 +491,20 @@ export type DuplicationRequest = {
480
491
  lease_token?: string;
481
492
  /**
482
493
  * - `draft`: the plan is being reviewed, and expires unless confirmed.
483
- * - `queued`: confirmed, waiting for a content service to fill the copies: never leased yet, or its lease expired.
484
494
  * - `running`: confirmed, and leased to a content service filling the copies.
495
+ * - `queued`: running, but its lease expired, its filling having crashed or stalled: for a content service to grab,
496
+ * with `grabDuplicationRequest`.
497
+ * - `completed`: its copies filled, and moved into their folders. Kept for a few minutes, for a caller following it.
485
498
  * - `failed`: given up, with its error. Its copies are deleted.
486
499
  */
487
- state: 'draft' | 'queued' | 'running' | 'failed';
500
+ state: 'draft' | 'queued' | 'running' | 'completed' | 'failed';
488
501
  /** The user duplicating the assets */
489
502
  user_id: string;
490
503
  };
491
504
  export type AssetDuplicationResult = {
492
505
  /** List of created assets */
493
506
  created_assets: Array<{
494
- /** Asset unique identifier */
507
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
495
508
  asset_id: string;
496
509
  asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_3d' | 'volume_material';
497
510
  /** Folder unique identifier */
@@ -501,7 +514,7 @@ export type AssetDuplicationResult = {
501
514
  duplication_request_id?: string;
502
515
  /** Map of source asset ids to copied asset ids */
503
516
  source_to_copy_asset_id_map: {
504
- /** Asset unique identifier */
517
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
505
518
  [source_asset_id: string]: string;
506
519
  };
507
520
  };
@@ -715,17 +728,32 @@ export type Pipeline = {
715
728
  user_id: string;
716
729
  };
717
730
  export type AssetContainer = 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_3d' | 'volume_materials';
718
- /** Generic details of an asset */
731
+ /** An error the gateway raised, or one of the services it calls answered */
732
+ export type ServiceError = {
733
+ /** The error's code, unique in the service, e.g. 1010 for UploadTaskNotFound */
734
+ errorCode: number;
735
+ /** The response's status code */
736
+ httpCode: number;
737
+ /** What went wrong, for a human */
738
+ message: string;
739
+ /** Details specific to each error, e.g. the ids it concerns, or the reason of a refusal */
740
+ [_additionalproperties_: string]: any;
741
+ };
742
+ /** An asset as platform-management holds it, where it is included, and how it was edited */
719
743
  export type AssetDetails = {
744
+ asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_3d' | 'volume_materials';
745
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
720
746
  asset_id: string;
747
+ asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_3d' | 'volume_material';
721
748
  contributors?: Array<{
722
749
  contribution_count: number;
723
- /**
724
- * This object represents a user in a 3dverse project.
725
- * This object contains group and task information about the user.
726
- * The user object lets you create or update user tokens that identify the useron the 3dverse platform.
727
- */
750
+ /** A user of an environment: a registered user, an account's user, or the environment's tenant. */
728
751
  user: {
752
+ /**
753
+ * Set for a deleted user, kept as the creator of what it created, under a placeholder username. Its own
754
+ * operations answer UserNotFound.
755
+ */
756
+ deleted?: true;
729
757
  /** The user registration date */
730
758
  registered_at: string;
731
759
  /** User unique identifier */
@@ -734,27 +762,45 @@ export type AssetDetails = {
734
762
  username: string;
735
763
  };
736
764
  }>;
765
+ /** When the asset was created, absent when unknown */
737
766
  created_at?: string;
738
- /**
739
- * This object represents a user in a 3dverse project.
740
- * This object contains group and task information about the user.
741
- * The user object lets you create or update user tokens that identify the useron the 3dverse platform.
742
- */
767
+ /** The user who created the asset, absent when unknown */
743
768
  created_by?: {
744
- /** The user registration date */
745
- registered_at: string;
769
+ /**
770
+ * Set for a deleted user, kept as the creator of what it created, under a placeholder username. Its own
771
+ * operations answer UserNotFound.
772
+ */
773
+ deleted?: true;
746
774
  /** User unique identifier */
747
775
  user_id: string;
748
- /** The username that will be displayed in monitoring tools. */
776
+ /** The username of the user */
749
777
  username: string;
750
778
  };
751
- last_edited_at?: string;
779
+ /** Unique identifier of an environment */
780
+ environment_id: string;
781
+ environment_slug: string;
782
+ /** Folder unique identifier */
783
+ folder_id: string;
752
784
  /**
753
- * This object represents a user in a 3dverse project.
754
- * This object contains group and task information about the user.
755
- * The user object lets you create or update user tokens that identify the useron the 3dverse platform.
785
+ * The path to the asset's folder from its root folder, the root first, the folder itself left out: empty for an
786
+ * asset in a root folder.
756
787
  */
788
+ folder_path: Array<{
789
+ /** Folder unique identifier */
790
+ folder_id: string;
791
+ /** Folder name */
792
+ name: string;
793
+ }>;
794
+ /** Whether the content service stores a thumbnail of the asset */
795
+ has_thumbnail: boolean;
796
+ last_edited_at?: string;
797
+ /** A user of an environment: a registered user, an account's user, or the environment's tenant. */
757
798
  last_edited_by?: {
799
+ /**
800
+ * Set for a deleted user, kept as the creator of what it created, under a placeholder username. Its own
801
+ * operations answer UserNotFound.
802
+ */
803
+ deleted?: true;
758
804
  /** The user registration date */
759
805
  registered_at: string;
760
806
  /** User unique identifier */
@@ -762,8 +808,17 @@ export type AssetDetails = {
762
808
  /** The username that will be displayed in monitoring tools. */
763
809
  username: string;
764
810
  };
811
+ /** The library exporting the asset, if any */
812
+ library_id?: string;
765
813
  name: string;
766
- type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_3d' | 'volume_material';
814
+ /** Unique identifier of an organization */
815
+ organization_id: string;
816
+ organization_slug: string;
817
+ /** Unique identifier of a project */
818
+ project_id: string;
819
+ project_slug: string;
820
+ /** The source file the asset was imported from, if any */
821
+ source_file_id?: string;
767
822
  };
768
823
  export type AssetDescription = {
769
824
  actions: {
@@ -955,6 +1010,8 @@ export type AssetDescription = {
955
1010
  durationInMs: number;
956
1011
  /** Name of the asset */
957
1012
  name: string;
1013
+ /** The size in byte of the compiled animation sequence library */
1014
+ payloadSize?: number;
958
1015
  /** The array of track UUIDs at play in this animation sequence */
959
1016
  trackUUIDs: Array<string>;
960
1017
  /** Unique identifier for the asset */
@@ -1206,8 +1263,8 @@ export type AssetDescription = {
1206
1263
  /** Name of the asset */
1207
1264
  name: string;
1208
1265
  /** Descriptions of all nodes */
1209
- nodeDataDescriptions: Array<StrictUnion<{
1210
- type?: 0;
1266
+ nodeDataDescriptions: Array<({
1267
+ type: 0;
1211
1268
  } | {
1212
1269
  /** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096, invalid_material=8192 */
1213
1270
  batchType?: number;
@@ -1246,7 +1303,7 @@ export type AssetDescription = {
1246
1303
  };
1247
1304
  /** A reference to a shader */
1248
1305
  shaderRef?: string;
1249
- type?: 1;
1306
+ type: 1;
1250
1307
  } | {
1251
1308
  /** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096, invalid_material=8192 */
1252
1309
  batchType?: number;
@@ -1281,7 +1338,7 @@ export type AssetDescription = {
1281
1338
  };
1282
1339
  /** Index into shaderContexts of the descriptor providing the shader context data for this node */
1283
1340
  shaderContextIndex: number;
1284
- type?: 2;
1341
+ type: 2;
1285
1342
  } | {
1286
1343
  /** @deprecated Const data type */
1287
1344
  constDataType?: (0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24) & number;
@@ -1295,14 +1352,14 @@ export type AssetDescription = {
1295
1352
  };
1296
1353
  /** A reference to a shader */
1297
1354
  shaderRef?: string;
1298
- type?: 3;
1355
+ type: 3;
1299
1356
  } | {
1300
1357
  filter?: number;
1301
1358
  /** Source render target */
1302
1359
  inputRenderTargetIndices?: Array<number>;
1303
1360
  /** Destination render target */
1304
1361
  outputRenderTargetIndices?: Array<number>;
1305
- type?: 4;
1362
+ type: 4;
1306
1363
  } | {
1307
1364
  /** Specialization constants values for the specified shader */
1308
1365
  constantsJson?: {
@@ -1314,19 +1371,19 @@ export type AssetDescription = {
1314
1371
  };
1315
1372
  /** A reference to a shader */
1316
1373
  shaderRef?: string;
1317
- type?: 5;
1374
+ type: 5;
1318
1375
  } | {
1319
1376
  /** Source render target */
1320
1377
  inputRenderTargetIndices?: Array<number>;
1321
1378
  /** Destination render target */
1322
1379
  outputRenderTargetIndices?: Array<number>;
1323
- type?: 6;
1380
+ type: 6;
1324
1381
  } | {
1325
1382
  /** Source render target */
1326
1383
  inputRenderTargetIndices?: Array<number>;
1327
1384
  /** Destination render target */
1328
1385
  outputRenderTargetIndices?: Array<number>;
1329
- type?: 7;
1386
+ type: 7;
1330
1387
  } | {
1331
1388
  /** Specialization constants values for the specified shader */
1332
1389
  constantsJson?: {
@@ -1363,18 +1420,18 @@ export type AssetDescription = {
1363
1420
  };
1364
1421
  /** A reference to a shader */
1365
1422
  shaderRef?: string;
1366
- type?: 8;
1423
+ type: 8;
1367
1424
  } | {
1368
1425
  filter?: number;
1369
1426
  /** Source render target */
1370
1427
  inputRenderTargetIndices?: Array<number>;
1371
1428
  /** Mip generation mode */
1372
1429
  mode?: (0 | 1) & number;
1373
- type?: 9;
1430
+ type: 9;
1374
1431
  } | {
1375
1432
  /** Source render target */
1376
1433
  inputRenderTargetIndices?: Array<number>;
1377
- type?: 10;
1434
+ type: 10;
1378
1435
  } | {
1379
1436
  /** Specialization constants values for the specified shader */
1380
1437
  constantsJson?: {
@@ -1390,7 +1447,7 @@ export type AssetDescription = {
1390
1447
  mode?: (0 | 1) & number;
1391
1448
  /** A reference to a shader */
1392
1449
  shaderRef?: string;
1393
- type?: 11;
1450
+ type: 11;
1394
1451
  } | {
1395
1452
  /** Clear value */
1396
1453
  clearValue?: Array<number> | Array<number> | Array<number> | {
@@ -1401,7 +1458,7 @@ export type AssetDescription = {
1401
1458
  clearValueType?: StrictUnion<0 | 1 | 2 | 3>;
1402
1459
  /** Render targets to clear */
1403
1460
  outputRenderTargetIndices?: Array<number>;
1404
- type?: 13;
1461
+ type: 13;
1405
1462
  } | {
1406
1463
  /** Name of the buffer */
1407
1464
  bufferName?: string;
@@ -1411,7 +1468,7 @@ export type AssetDescription = {
1411
1468
  bufferSize?: number;
1412
1469
  /** Value to fill the buffer with */
1413
1470
  bufferValue?: number;
1414
- type?: 15;
1471
+ type: 15;
1415
1472
  } | {
1416
1473
  /** Specialization constants values for the specified shader */
1417
1474
  constantsJson?: {
@@ -1448,7 +1505,7 @@ export type AssetDescription = {
1448
1505
  };
1449
1506
  /** A reference to a shader */
1450
1507
  shaderRef?: string;
1451
- type?: 16;
1508
+ type: 16;
1452
1509
  } | {
1453
1510
  /** Data provided to the shader through the node data buffer */
1454
1511
  dataJson?: {
@@ -1456,7 +1513,7 @@ export type AssetDescription = {
1456
1513
  };
1457
1514
  /** Index into shaderContexts of the descriptor providing the shader context data for this node */
1458
1515
  shaderContextIndex: number;
1459
- type?: 17;
1516
+ type: 17;
1460
1517
  } | {
1461
1518
  /** Depth bias clamp */
1462
1519
  depthBiasClamp?: number;
@@ -1464,7 +1521,7 @@ export type AssetDescription = {
1464
1521
  depthBiasConstantFactor?: number;
1465
1522
  /** Depth bias slope factor */
1466
1523
  depthBiasSlopeFactor?: number;
1467
- type?: 18;
1524
+ type: 18;
1468
1525
  } | {
1469
1526
  /** Specialization constants values for the specified shader */
1470
1527
  constantsJson?: {
@@ -1476,8 +1533,8 @@ export type AssetDescription = {
1476
1533
  };
1477
1534
  /** A reference to a shader */
1478
1535
  shaderRef?: string;
1479
- type?: 19;
1480
- }> & {
1536
+ type: 19;
1537
+ }) & {
1481
1538
  /** Index into the conditions array; -1 if unconditional */
1482
1539
  conditionIndex?: number;
1483
1540
  /** Node name */
@@ -2070,7 +2127,7 @@ export type AssetDescription = {
2070
2127
  /** Unique identifier for the asset */
2071
2128
  uuid: string;
2072
2129
  };
2073
- export type AssetContainerEditable = 'action_maps' | 'animation_graphs' | 'animation_sequences' | 'cubemaps' | 'event_maps' | 'materials' | 'modules' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'volume_materials';
2130
+ export type AssetContainerEditable = 'action_maps' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'cubemaps' | 'event_maps' | 'materials' | 'modules' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'volume_materials';
2074
2131
  export type EditableAssetDescription = {
2075
2132
  actions: {
2076
2133
  [action_name: string]: {
@@ -2236,10 +2293,33 @@ export type EditableAssetDescription = {
2236
2293
  durationInMs: number;
2237
2294
  /** Name of the asset */
2238
2295
  name: string;
2296
+ /** The size in byte of the compiled animation sequence library */
2297
+ payloadSize?: number;
2239
2298
  /** The array of track UUIDs at play in this animation sequence */
2240
2299
  trackUUIDs: Array<string>;
2241
2300
  /** Unique identifier for the asset */
2242
2301
  uuid: string;
2302
+ } | {
2303
+ /** Parent animation graph */
2304
+ animationGraphUUID: string;
2305
+ /** The animation set */
2306
+ animationSet: Array<{
2307
+ /** Key of the animation in the animation graph */
2308
+ animationKey: number;
2309
+ /** The referenced animation for the specified key */
2310
+ animationRef: string;
2311
+ }>;
2312
+ /** The bone mask set */
2313
+ boneMaskSet?: Array<{
2314
+ /** The bone mask. An array of floats which corresponds to the weight per bone */
2315
+ boneMask: Array<number>;
2316
+ /** Key of the bone mask in the animation graph */
2317
+ boneMaskKey: number;
2318
+ }>;
2319
+ /** Name of the asset */
2320
+ name: string;
2321
+ /** Unique identifier for the asset */
2322
+ uuid: string;
2243
2323
  } | {
2244
2324
  /** The 6 images forming the cube faces */
2245
2325
  faces: Array<string>;
@@ -2346,8 +2426,8 @@ export type EditableAssetDescription = {
2346
2426
  /** Name of the asset */
2347
2427
  name: string;
2348
2428
  /** Descriptions of all nodes */
2349
- nodeDataDescriptions: Array<StrictUnion<{
2350
- type?: 0;
2429
+ nodeDataDescriptions: Array<({
2430
+ type: 0;
2351
2431
  } | {
2352
2432
  /** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096, invalid_material=8192 */
2353
2433
  batchType?: number;
@@ -2386,7 +2466,7 @@ export type EditableAssetDescription = {
2386
2466
  };
2387
2467
  /** A reference to a shader */
2388
2468
  shaderRef?: string;
2389
- type?: 1;
2469
+ type: 1;
2390
2470
  } | {
2391
2471
  /** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096, invalid_material=8192 */
2392
2472
  batchType?: number;
@@ -2421,7 +2501,7 @@ export type EditableAssetDescription = {
2421
2501
  };
2422
2502
  /** Index into shaderContexts of the descriptor providing the shader context data for this node */
2423
2503
  shaderContextIndex: number;
2424
- type?: 2;
2504
+ type: 2;
2425
2505
  } | {
2426
2506
  /** @deprecated Const data type */
2427
2507
  constDataType?: (0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24) & number;
@@ -2435,14 +2515,14 @@ export type EditableAssetDescription = {
2435
2515
  };
2436
2516
  /** A reference to a shader */
2437
2517
  shaderRef?: string;
2438
- type?: 3;
2518
+ type: 3;
2439
2519
  } | {
2440
2520
  filter?: number;
2441
2521
  /** Source render target */
2442
2522
  inputRenderTargetIndices?: Array<number>;
2443
2523
  /** Destination render target */
2444
2524
  outputRenderTargetIndices?: Array<number>;
2445
- type?: 4;
2525
+ type: 4;
2446
2526
  } | {
2447
2527
  /** Specialization constants values for the specified shader */
2448
2528
  constantsJson?: {
@@ -2454,19 +2534,19 @@ export type EditableAssetDescription = {
2454
2534
  };
2455
2535
  /** A reference to a shader */
2456
2536
  shaderRef?: string;
2457
- type?: 5;
2537
+ type: 5;
2458
2538
  } | {
2459
2539
  /** Source render target */
2460
2540
  inputRenderTargetIndices?: Array<number>;
2461
2541
  /** Destination render target */
2462
2542
  outputRenderTargetIndices?: Array<number>;
2463
- type?: 6;
2543
+ type: 6;
2464
2544
  } | {
2465
2545
  /** Source render target */
2466
2546
  inputRenderTargetIndices?: Array<number>;
2467
2547
  /** Destination render target */
2468
2548
  outputRenderTargetIndices?: Array<number>;
2469
- type?: 7;
2549
+ type: 7;
2470
2550
  } | {
2471
2551
  /** Specialization constants values for the specified shader */
2472
2552
  constantsJson?: {
@@ -2503,18 +2583,18 @@ export type EditableAssetDescription = {
2503
2583
  };
2504
2584
  /** A reference to a shader */
2505
2585
  shaderRef?: string;
2506
- type?: 8;
2586
+ type: 8;
2507
2587
  } | {
2508
2588
  filter?: number;
2509
2589
  /** Source render target */
2510
2590
  inputRenderTargetIndices?: Array<number>;
2511
2591
  /** Mip generation mode */
2512
2592
  mode?: (0 | 1) & number;
2513
- type?: 9;
2593
+ type: 9;
2514
2594
  } | {
2515
2595
  /** Source render target */
2516
2596
  inputRenderTargetIndices?: Array<number>;
2517
- type?: 10;
2597
+ type: 10;
2518
2598
  } | {
2519
2599
  /** Specialization constants values for the specified shader */
2520
2600
  constantsJson?: {
@@ -2530,7 +2610,7 @@ export type EditableAssetDescription = {
2530
2610
  mode?: (0 | 1) & number;
2531
2611
  /** A reference to a shader */
2532
2612
  shaderRef?: string;
2533
- type?: 11;
2613
+ type: 11;
2534
2614
  } | {
2535
2615
  /** Clear value */
2536
2616
  clearValue?: Array<number> | Array<number> | Array<number> | {
@@ -2541,7 +2621,7 @@ export type EditableAssetDescription = {
2541
2621
  clearValueType?: StrictUnion<0 | 1 | 2 | 3>;
2542
2622
  /** Render targets to clear */
2543
2623
  outputRenderTargetIndices?: Array<number>;
2544
- type?: 13;
2624
+ type: 13;
2545
2625
  } | {
2546
2626
  /** Name of the buffer */
2547
2627
  bufferName?: string;
@@ -2551,7 +2631,7 @@ export type EditableAssetDescription = {
2551
2631
  bufferSize?: number;
2552
2632
  /** Value to fill the buffer with */
2553
2633
  bufferValue?: number;
2554
- type?: 15;
2634
+ type: 15;
2555
2635
  } | {
2556
2636
  /** Specialization constants values for the specified shader */
2557
2637
  constantsJson?: {
@@ -2588,7 +2668,7 @@ export type EditableAssetDescription = {
2588
2668
  };
2589
2669
  /** A reference to a shader */
2590
2670
  shaderRef?: string;
2591
- type?: 16;
2671
+ type: 16;
2592
2672
  } | {
2593
2673
  /** Data provided to the shader through the node data buffer */
2594
2674
  dataJson?: {
@@ -2596,7 +2676,7 @@ export type EditableAssetDescription = {
2596
2676
  };
2597
2677
  /** Index into shaderContexts of the descriptor providing the shader context data for this node */
2598
2678
  shaderContextIndex: number;
2599
- type?: 17;
2679
+ type: 17;
2600
2680
  } | {
2601
2681
  /** Depth bias clamp */
2602
2682
  depthBiasClamp?: number;
@@ -2604,7 +2684,7 @@ export type EditableAssetDescription = {
2604
2684
  depthBiasConstantFactor?: number;
2605
2685
  /** Depth bias slope factor */
2606
2686
  depthBiasSlopeFactor?: number;
2607
- type?: 18;
2687
+ type: 18;
2608
2688
  } | {
2609
2689
  /** Specialization constants values for the specified shader */
2610
2690
  constantsJson?: {
@@ -2616,8 +2696,8 @@ export type EditableAssetDescription = {
2616
2696
  };
2617
2697
  /** A reference to a shader */
2618
2698
  shaderRef?: string;
2619
- type?: 19;
2620
- }> & {
2699
+ type: 19;
2700
+ }) & {
2621
2701
  /** Index into the conditions array; -1 if unconditional */
2622
2702
  conditionIndex?: number;
2623
2703
  /** Node name */
@@ -3995,22 +4075,11 @@ export type EventJobCompleted = {
3995
4075
  /** User unique identifier */
3996
4076
  user_id: string;
3997
4077
  };
3998
- export type AssetContainerCreatable = 'action_maps' | 'animation_graphs' | 'animation_sequences' | 'cubemaps' | 'event_maps' | 'materials' | 'modules' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'volume_materials';
4078
+ export type AssetContainerCreatable = 'action_maps' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'cubemaps' | 'event_maps' | 'materials' | 'modules' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'volume_materials';
3999
4079
  /** Signature that can be used to verify the authenticity of a request. */
4000
4080
  export type X3dverseSignature = string;
4001
4081
  /** Unix timestamp of when the signature was generated, in milliseconds. */
4002
4082
  export type X3dverseSignatureTimestamp = number;
4003
- /** An error the gateway raised, or one of the services it calls answered */
4004
- export type ServiceError = {
4005
- /** The error's code, unique in the service, e.g. 1010 for UploadTaskNotFound */
4006
- errorCode: number;
4007
- /** The response's status code */
4008
- httpCode: number;
4009
- /** What went wrong, for a human */
4010
- message: string;
4011
- /** Details specific to each error, e.g. the ids it concerns, or the reason of a refusal */
4012
- [_additionalproperties_: string]: any;
4013
- };
4014
4083
  /** The body of every error response */
4015
4084
  export type ErrorResponse = {
4016
4085
  error: ServiceError;
@@ -4207,8 +4276,29 @@ export type EditableAssetDescriptionInput = {
4207
4276
  durationInMs: number;
4208
4277
  /** Name of the asset */
4209
4278
  name: string;
4279
+ /** The size in byte of the compiled animation sequence library */
4280
+ payloadSize?: number;
4210
4281
  /** The array of track UUIDs at play in this animation sequence */
4211
4282
  trackUUIDs: Array<string>;
4283
+ } | {
4284
+ /** Parent animation graph */
4285
+ animationGraphUUID: string;
4286
+ /** The animation set */
4287
+ animationSet: Array<{
4288
+ /** Key of the animation in the animation graph */
4289
+ animationKey: number;
4290
+ /** The referenced animation for the specified key */
4291
+ animationRef: string;
4292
+ }>;
4293
+ /** The bone mask set */
4294
+ boneMaskSet?: Array<{
4295
+ /** The bone mask. An array of floats which corresponds to the weight per bone */
4296
+ boneMask: Array<number>;
4297
+ /** Key of the bone mask in the animation graph */
4298
+ boneMaskKey: number;
4299
+ }>;
4300
+ /** Name of the asset */
4301
+ name: string;
4212
4302
  } | {
4213
4303
  /** The 6 images forming the cube faces */
4214
4304
  faces: Array<string>;
@@ -4307,8 +4397,8 @@ export type EditableAssetDescriptionInput = {
4307
4397
  /** Name of the asset */
4308
4398
  name: string;
4309
4399
  /** Descriptions of all nodes */
4310
- nodeDataDescriptions: Array<StrictUnion<{
4311
- type?: 0;
4400
+ nodeDataDescriptions: Array<({
4401
+ type: 0;
4312
4402
  } | {
4313
4403
  /** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096, invalid_material=8192 */
4314
4404
  batchType?: number;
@@ -4347,7 +4437,7 @@ export type EditableAssetDescriptionInput = {
4347
4437
  };
4348
4438
  /** A reference to a shader */
4349
4439
  shaderRef?: string;
4350
- type?: 1;
4440
+ type: 1;
4351
4441
  } | {
4352
4442
  /** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096, invalid_material=8192 */
4353
4443
  batchType?: number;
@@ -4382,7 +4472,7 @@ export type EditableAssetDescriptionInput = {
4382
4472
  };
4383
4473
  /** Index into shaderContexts of the descriptor providing the shader context data for this node */
4384
4474
  shaderContextIndex: number;
4385
- type?: 2;
4475
+ type: 2;
4386
4476
  } | {
4387
4477
  /** @deprecated Const data type */
4388
4478
  constDataType?: (0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24) & number;
@@ -4396,14 +4486,14 @@ export type EditableAssetDescriptionInput = {
4396
4486
  };
4397
4487
  /** A reference to a shader */
4398
4488
  shaderRef?: string;
4399
- type?: 3;
4489
+ type: 3;
4400
4490
  } | {
4401
4491
  filter?: number;
4402
4492
  /** Source render target */
4403
4493
  inputRenderTargetIndices?: Array<number>;
4404
4494
  /** Destination render target */
4405
4495
  outputRenderTargetIndices?: Array<number>;
4406
- type?: 4;
4496
+ type: 4;
4407
4497
  } | {
4408
4498
  /** Specialization constants values for the specified shader */
4409
4499
  constantsJson?: {
@@ -4415,19 +4505,19 @@ export type EditableAssetDescriptionInput = {
4415
4505
  };
4416
4506
  /** A reference to a shader */
4417
4507
  shaderRef?: string;
4418
- type?: 5;
4508
+ type: 5;
4419
4509
  } | {
4420
4510
  /** Source render target */
4421
4511
  inputRenderTargetIndices?: Array<number>;
4422
4512
  /** Destination render target */
4423
4513
  outputRenderTargetIndices?: Array<number>;
4424
- type?: 6;
4514
+ type: 6;
4425
4515
  } | {
4426
4516
  /** Source render target */
4427
4517
  inputRenderTargetIndices?: Array<number>;
4428
4518
  /** Destination render target */
4429
4519
  outputRenderTargetIndices?: Array<number>;
4430
- type?: 7;
4520
+ type: 7;
4431
4521
  } | {
4432
4522
  /** Specialization constants values for the specified shader */
4433
4523
  constantsJson?: {
@@ -4464,18 +4554,18 @@ export type EditableAssetDescriptionInput = {
4464
4554
  };
4465
4555
  /** A reference to a shader */
4466
4556
  shaderRef?: string;
4467
- type?: 8;
4557
+ type: 8;
4468
4558
  } | {
4469
4559
  filter?: number;
4470
4560
  /** Source render target */
4471
4561
  inputRenderTargetIndices?: Array<number>;
4472
4562
  /** Mip generation mode */
4473
4563
  mode?: (0 | 1) & number;
4474
- type?: 9;
4564
+ type: 9;
4475
4565
  } | {
4476
4566
  /** Source render target */
4477
4567
  inputRenderTargetIndices?: Array<number>;
4478
- type?: 10;
4568
+ type: 10;
4479
4569
  } | {
4480
4570
  /** Specialization constants values for the specified shader */
4481
4571
  constantsJson?: {
@@ -4491,7 +4581,7 @@ export type EditableAssetDescriptionInput = {
4491
4581
  mode?: (0 | 1) & number;
4492
4582
  /** A reference to a shader */
4493
4583
  shaderRef?: string;
4494
- type?: 11;
4584
+ type: 11;
4495
4585
  } | {
4496
4586
  /** Clear value */
4497
4587
  clearValue?: Array<number> | Array<number> | Array<number> | {
@@ -4502,7 +4592,7 @@ export type EditableAssetDescriptionInput = {
4502
4592
  clearValueType?: StrictUnion<0 | 1 | 2 | 3>;
4503
4593
  /** Render targets to clear */
4504
4594
  outputRenderTargetIndices?: Array<number>;
4505
- type?: 13;
4595
+ type: 13;
4506
4596
  } | {
4507
4597
  /** Name of the buffer */
4508
4598
  bufferName?: string;
@@ -4512,7 +4602,7 @@ export type EditableAssetDescriptionInput = {
4512
4602
  bufferSize?: number;
4513
4603
  /** Value to fill the buffer with */
4514
4604
  bufferValue?: number;
4515
- type?: 15;
4605
+ type: 15;
4516
4606
  } | {
4517
4607
  /** Specialization constants values for the specified shader */
4518
4608
  constantsJson?: {
@@ -4549,7 +4639,7 @@ export type EditableAssetDescriptionInput = {
4549
4639
  };
4550
4640
  /** A reference to a shader */
4551
4641
  shaderRef?: string;
4552
- type?: 16;
4642
+ type: 16;
4553
4643
  } | {
4554
4644
  /** Data provided to the shader through the node data buffer */
4555
4645
  dataJson?: {
@@ -4557,7 +4647,7 @@ export type EditableAssetDescriptionInput = {
4557
4647
  };
4558
4648
  /** Index into shaderContexts of the descriptor providing the shader context data for this node */
4559
4649
  shaderContextIndex: number;
4560
- type?: 17;
4650
+ type: 17;
4561
4651
  } | {
4562
4652
  /** Depth bias clamp */
4563
4653
  depthBiasClamp?: number;
@@ -4565,7 +4655,7 @@ export type EditableAssetDescriptionInput = {
4565
4655
  depthBiasConstantFactor?: number;
4566
4656
  /** Depth bias slope factor */
4567
4657
  depthBiasSlopeFactor?: number;
4568
- type?: 18;
4658
+ type: 18;
4569
4659
  } | {
4570
4660
  /** Specialization constants values for the specified shader */
4571
4661
  constantsJson?: {
@@ -4577,8 +4667,8 @@ export type EditableAssetDescriptionInput = {
4577
4667
  };
4578
4668
  /** A reference to a shader */
4579
4669
  shaderRef?: string;
4580
- type?: 19;
4581
- }> & {
4670
+ type: 19;
4671
+ }) & {
4582
4672
  /** Index into the conditions array; -1 if unconditional */
4583
4673
  conditionIndex?: number;
4584
4674
  /** Node name */
@@ -5006,6 +5096,11 @@ export type EditableAssetDescriptionInput = {
5006
5096
  value?: Array<number> | number;
5007
5097
  }>;
5008
5098
  };
5099
+ export declare class AssetSourceFileNotFound extends ServiceErrorResponse {
5100
+ static readonly ERROR_CODE = 1018;
5101
+ readonly asset_id: AssetId;
5102
+ constructor(serviceError: Record<string, unknown>);
5103
+ }
5009
5104
  export declare class InsufficientPermissions extends ServiceErrorResponse {
5010
5105
  static readonly ERROR_CODE = 1002;
5011
5106
  /** The permissions the caller misses, per resource */
@@ -5050,6 +5145,12 @@ export declare class InvalidGuestToken extends ServiceErrorResponse {
5050
5145
  static readonly ERROR_CODE = 1016;
5051
5146
  constructor(serviceError: Record<string, unknown>);
5052
5147
  }
5148
+ export declare class InvalidTokenTtl extends ServiceErrorResponse {
5149
+ static readonly ERROR_CODE = 1017;
5150
+ /** The time to live asked */
5151
+ readonly ttl: string;
5152
+ constructor(serviceError: Record<string, unknown>);
5153
+ }
5053
5154
  export declare class UploadedPayloadTooLarge extends ServiceErrorResponse {
5054
5155
  static readonly ERROR_CODE = 1007;
5055
5156
  /** The maximum upload size of the environment, in bytes */
@@ -5085,7 +5186,7 @@ export declare class ConversionTaskNotFound extends ServiceErrorResponse {
5085
5186
  constructor(serviceError: Record<string, unknown>);
5086
5187
  }
5087
5188
  /** The errors the spec declares. */
5088
- export type DeclaredError = InsufficientPermissions | InvalidAuthorization | InsufficientSecurityScope | Unauthorized | EnvironmentMismatch | MissingAuthorizationHeader | InvalidApiKey | InvalidGuestToken | UploadedPayloadTooLarge | NoFileUploaded | UploadAborted | UploadTaskNotFound | InvalidMaterial | InvalidRequest | ConversionTaskNotFound;
5189
+ export type DeclaredError = AssetSourceFileNotFound | InsufficientPermissions | InvalidAuthorization | InsufficientSecurityScope | Unauthorized | EnvironmentMismatch | MissingAuthorizationHeader | InvalidApiKey | InvalidGuestToken | InvalidTokenTtl | UploadedPayloadTooLarge | NoFileUploaded | UploadAborted | UploadTaskNotFound | InvalidMaterial | InvalidRequest | ConversionTaskNotFound;
5089
5190
  /**
5090
5191
  * The error declared in the spec that a request failed with, or undefined: read from the error a function of this
5091
5192
  * client rejected with, e.g. `if (errorOf(error) instanceof FolderNotFound)`.
@@ -5124,21 +5225,25 @@ export declare function updateUser({ user_id, username, }: {
5124
5225
  username: string;
5125
5226
  }, headers?: RawAxiosRequestHeaders | AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
5126
5227
  /**
5127
- * Deletes the target user.
5228
+ * Deletes a registered user of the environment. What it created stays, naming it under a placeholder username; its
5229
+ * accesses and the public access tokens impersonating it are deleted, and its user tokens are refused from then on.
5230
+ * A user cannot delete itself, nor the environment's tenant or an account user be deleted.
5128
5231
  */
5129
5232
  export declare function deleteUser({ user_id, }: {
5130
5233
  user_id: UserId;
5131
- }, headers?: RawAxiosRequestHeaders | AxiosRequestHeaders): AxiosPromise<{
5132
- deleted_assets?: AssetList;
5133
- }>;
5234
+ }, headers?: RawAxiosRequestHeaders | AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
5134
5235
  /**
5135
- * Generates a user token. This user token identifies the user when making a request.
5236
+ * Generates a user token. This user token identifies the user when making a request, with the scope it was generated
5237
+ * with, until it expires. It cannot be revoked.
5136
5238
  */
5137
5239
  export declare function generateUserToken({ user_id, scope, ttl, }: {
5138
5240
  user_id: UserId;
5139
5241
  /** Token permission scope */
5140
5242
  scope: 'read' | 'write' | 'manage';
5141
- /** Time to live */
5243
+ /**
5244
+ * Time to live, from 1 minute to 14 days, e.g. `30m`, `1h`, `7d` or `1h 30m`, a number alone counting
5245
+ * seconds
5246
+ */
5142
5247
  ttl?: string;
5143
5248
  }, headers?: RawAxiosRequestHeaders | AxiosRequestHeaders): AxiosPromise<Token>;
5144
5249
  /**
@@ -5396,7 +5501,7 @@ export declare function createAsset({ folder_id, asset_creation_options, }: {
5396
5501
  };
5397
5502
  }>;
5398
5503
  }, headers?: RawAxiosRequestHeaders | AxiosRequestHeaders): AxiosPromise<{
5399
- /** Asset unique identifier */
5504
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
5400
5505
  asset_id: string;
5401
5506
  name: string;
5402
5507
  /** Map of source asset ids to copied asset ids */
@@ -5404,7 +5509,7 @@ export declare function createAsset({ folder_id, asset_creation_options, }: {
5404
5509
  [source_asset_id: string]: AssetId;
5405
5510
  };
5406
5511
  } | {
5407
- /** Asset unique identifier */
5512
+ /** Asset unique identifier, a version 4 uuid in its canonical lowercase form */
5408
5513
  asset_id: string;
5409
5514
  name: string;
5410
5515
  source_to_copy_asset_id_map?: {
@@ -5619,7 +5724,9 @@ export declare function getPipeline({ pipeline_id, }: {
5619
5724
  pipeline_id: PipelineId;
5620
5725
  }, headers?: RawAxiosRequestHeaders | AxiosRequestHeaders): AxiosPromise<Pipeline>;
5621
5726
  /**
5622
- * Returns a list of all assets.
5727
+ * Lists the assets of the caller's environment, at every depth, grouped by type, and with
5728
+ * `filter[include_public_assets]` those shared with the platform from any environment too, as asset pickers list
5729
+ * them. Filters by types and by name (a uuid, or a case-insensitive substring).
5623
5730
  */
5624
5731
  export declare function listAssets({ offset, limit, filter, }: {
5625
5732
  offset?: number;
@@ -5631,7 +5738,7 @@ export declare function listAssets({ offset, limit, filter, }: {
5631
5738
  asset_types?: Array<AssetType>;
5632
5739
  /** Filter by asset name */
5633
5740
  asset_name?: string;
5634
- /** Include assets coming from public libraries */
5741
+ /** Include the assets shared with the platform, from any environment */
5635
5742
  include_public_assets?: boolean;
5636
5743
  };
5637
5744
  }, headers?: RawAxiosRequestHeaders | AxiosRequestHeaders): AxiosPromise<AssetList>;
@@ -5649,7 +5756,8 @@ export declare function deleteAsset({ asset_container, asset_id, }: {
5649
5756
  asset_id: AssetId;
5650
5757
  }, headers?: RawAxiosRequestHeaders | AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
5651
5758
  /**
5652
- * Gets the source file of the specified asset.
5759
+ * Gets the source file the specified asset was imported from.
5760
+ * @throws {AssetSourceFileNotFound}
5653
5761
  */
5654
5762
  export declare function getAssetSourceFile({ asset_container, asset_id, }: {
5655
5763
  asset_container: AssetContainer;
@@ -5845,7 +5953,7 @@ export declare function setAssetThumbnail({ asset_container, asset_id, body, }:
5845
5953
  asset_container: AssetContainer;
5846
5954
  asset_id: AssetId;
5847
5955
  body: ArrayBuffer | ReadableStream;
5848
- }, contentType: 'image/jpg' | 'image/png', headers?: RawAxiosRequestHeaders | AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
5956
+ }, contentType: 'image/jpeg' | 'image/jpg' | 'image/png', headers?: RawAxiosRequestHeaders | AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
5849
5957
  /**
5850
5958
  * Packages and downloads the target asset.
5851
5959
  */
@@ -5856,13 +5964,13 @@ export declare function packageAsset<T extends 'arraybuffer' | 'stream' | 'json'
5856
5964
  /**
5857
5965
  * Downloads an asset payload in a given format. Only mesh is supported for the moment. This endpoint requires special export permission.
5858
5966
  */
5859
- export declare function exportAsset<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container_exportable, asset_id, format, scale, sub_mesh_index, }: {
5967
+ export declare function exportAsset({ asset_container_exportable, asset_id, format, scale, sub_mesh_index, }: {
5860
5968
  asset_container_exportable: AssetContainerExportable;
5861
5969
  asset_id: AssetId;
5862
5970
  format: 'obj' | 'stl';
5863
5971
  scale?: number;
5864
5972
  sub_mesh_index?: number;
5865
- }, headers?: RawAxiosRequestHeaders | AxiosRequestHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
5973
+ }, headers?: RawAxiosRequestHeaders | AxiosRequestHeaders): AxiosPromise<string | ArrayBuffer | ReadableStream>;
5866
5974
  /**
5867
5975
  * Lists all sessions running a specified scene.
5868
5976
  */
@@ -7077,7 +7185,8 @@ export declare function getSession({ session_id, }: {
7077
7185
  session_id: SessionId;
7078
7186
  }, headers?: RawAxiosRequestHeaders | AxiosRequestHeaders): AxiosPromise<Session>;
7079
7187
  /**
7080
- * Forcefully terminates a session.
7188
+ * Terminates a session: its renderer is stopped, its clients disconnected. Only the session's creator can terminate
7189
+ * it. The session is closing until its renderer stopped, joined no more.
7081
7190
  */
7082
7191
  export declare function killSession({ session_id, }: {
7083
7192
  session_id: SessionId;
@@ -7098,7 +7207,8 @@ export declare function getClient({ session_id, client_id, }: {
7098
7207
  client_id: ClientId;
7099
7208
  }, headers?: RawAxiosRequestHeaders | AxiosRequestHeaders): AxiosPromise<Client>;
7100
7209
  /**
7101
- * Kick a client from a running session.
7210
+ * Kicks a client from a running session: it is disconnected, and leaves the session. Only the session's creator can
7211
+ * kick a client.
7102
7212
  */
7103
7213
  export declare function kickClientFromSession({ session_id, client_id, }: {
7104
7214
  session_id: SessionId;