@3dverse/api 0.8.2 → 0.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,28 +2,28 @@
2
2
  * 3dverse Asset API v1.0
3
3
  * # Getting Started
4
4
  *
5
- * Welcome to the 3dverse Asset API. This is the reference for the REST API endpoints.
5
+ *Welcome to the 3dverse Asset API. This is the reference for the REST API endpoints.
6
6
  *
7
- * ## NPM package
7
+ *## NPM package
8
8
  *
9
- * We provide a TypeScript wrapper library to make typesafe API requests and get typed responses: [https://www.npmjs.com/package/@3dverse/api](https://www.npmjs.com/package/@3dverse/api).
9
+ *We provide a TypeScript wrapper library to make typesafe API requests and get typed responses: [https://www.npmjs.com/package/@3dverse/api](https://www.npmjs.com/package/@3dverse/api).
10
10
  *
11
- * ## Authentication
11
+ *## Authentication
12
12
  *
13
- * To authenticate your API calls, you'll need to generate an API key via the [3dverse Console](https://console.3dverse.com) and send an `api_key` header with your API requests.
14
- * Alternatively, you can create a user, generate a token for the user and authenticate with a `user_token`.
13
+ *To authenticate your API calls, you'll need to generate an API key via the [3dverse Console](https://console.3dverse.com) and send an `api_key` header with your API requests.
14
+ *Alternatively, you can create a user, generate a token for the user and authenticate with a `user_token`.
15
15
  *
16
16
  *
17
- * ---
17
+ *---
18
18
  *
19
19
  *
20
20
  * Contact: 3dverse Support (support@3dverse.com)
21
21
  *
22
22
  * DO NOT EDIT THIS FILE MANUALLY.
23
23
  * This file has been generated automatically from its OpenAPI spec file.
24
- * See : https://gitlab.com/3dverse/platform/libs/js/openapi-client-library-generator
24
+ * See: https://gitlab.com/3dverse/platform/libs/js/openapi-client-library-generator
25
25
  */
26
- import { AxiosPromise } from 'axios';
26
+ import { AxiosPromise, AxiosHeaders } from 'axios';
27
27
  type UnionKeys<T> = T extends T ? keyof T : never;
28
28
  type StrictUnionHelper<T, TAll> = T extends any ? T & Partial<Record<Exclude<UnionKeys<TAll>, keyof T>, never>> : never;
29
29
  type StrictUnion<T> = StrictUnionHelper<T, T>;
@@ -34,46 +34,64 @@ export type ListUsers_User_UserInfo = {
34
34
  username: string;
35
35
  registered_at: string;
36
36
  };
37
- export declare function listUsers({ offset, limit }: {
37
+ /**
38
+ * Retrieve a list of all users in the current application.
39
+ */
40
+ export declare function listUsers({ offset, limit, }: {
38
41
  offset?: number;
39
42
  limit?: number;
40
- }): AxiosPromise<Array<ListUsers_User_UserInfo>>;
43
+ }, headers?: AxiosHeaders): AxiosPromise<Array<ListUsers_User_UserInfo>>;
41
44
  export type RegisterUser_User_UserInfo = {
42
45
  user_id: string;
43
46
  username: string;
44
47
  registered_at: string;
45
48
  };
46
- export declare function registerUser({ username }: {
49
+ /**
50
+ * Registers the target user in the current application.
51
+ */
52
+ export declare function registerUser({ username, }: {
47
53
  username: string;
48
- }): AxiosPromise<RegisterUser_User_UserInfo>;
54
+ }, headers?: AxiosHeaders): AxiosPromise<RegisterUser_User_UserInfo>;
49
55
  export type GetUser_User_UserInfo = {
50
56
  user_id: string;
51
57
  username: string;
52
58
  registered_at: string;
53
59
  };
54
- export declare function getUser({ user_id }: {
60
+ /**
61
+ * Retrieves details about the target user.
62
+ */
63
+ export declare function getUser({ user_id, }: {
55
64
  user_id: string;
56
- }): AxiosPromise<GetUser_User_UserInfo>;
57
- export declare function updateUser({ user_id, username }: {
65
+ }, headers?: AxiosHeaders): AxiosPromise<GetUser_User_UserInfo>;
66
+ /**
67
+ * Updates the details of the target user.
68
+ */
69
+ export declare function updateUser({ user_id, username, }: {
58
70
  user_id: string;
59
71
  username: string;
60
- }): Promise<import("axios").AxiosResponse<any, any>>;
72
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
61
73
  export type DeleteUser_Object = {
62
74
  deleted_assets?: DeleteUser_Object;
63
75
  };
64
- export declare function deleteUser({ user_id }: {
76
+ /**
77
+ * Deletes the target user.
78
+ */
79
+ export declare function deleteUser({ user_id, }: {
65
80
  user_id: string;
66
- }): AxiosPromise<DeleteUser_Object>;
81
+ }, headers?: AxiosHeaders): AxiosPromise<DeleteUser_Object>;
67
82
  export type GenerateUserToken_Token = {
68
83
  user_token?: string;
69
84
  expires_in?: number;
70
85
  expires_on?: number;
71
86
  };
72
- export declare function generateUserToken({ user_id, scope, ttl }: {
87
+ /**
88
+ * Generates a user token. This user token identifies the user when making a request.
89
+ */
90
+ export declare function generateUserToken({ user_id, scope, ttl, }: {
73
91
  user_id: string;
74
- scope: "read" | "write" | "manage";
92
+ scope: 'read' | 'write' | 'manage';
75
93
  ttl?: string;
76
- }): AxiosPromise<GenerateUserToken_Token>;
94
+ }, headers?: AxiosHeaders): AxiosPromise<GenerateUserToken_Token>;
77
95
  export type GetUserGroups_Group_GroupInfo = {
78
96
  group_id: string;
79
97
  name: string;
@@ -84,12 +102,15 @@ export type GetUserGroups_Group_GroupInfo = {
84
102
  export type GetUserGroups_GroupMember_GroupAccess = {
85
103
  user_id: string;
86
104
  joined_at?: string;
87
- group_access: "read" | "write" | "manage";
88
- folder_access: "read" | "write" | "manage";
105
+ group_access: 'read' | 'write' | 'manage';
106
+ folder_access: 'read' | 'write' | 'manage';
89
107
  };
90
- export declare function getUserGroups({ user_id }: {
108
+ /**
109
+ * Lists all user groups.
110
+ */
111
+ export declare function getUserGroups({ user_id, }: {
91
112
  user_id: string;
92
- }): AxiosPromise<Array<GetUserGroups_Group_GroupInfo>>;
113
+ }, headers?: AxiosHeaders): AxiosPromise<Array<GetUserGroups_Group_GroupInfo>>;
93
114
  export type GetUserUploadTasks_UploadTask = {
94
115
  upload_task_id: string;
95
116
  folder_id: string;
@@ -108,19 +129,22 @@ export type GetUserUploadTasks_ConversionTask = {
108
129
  asset_id: string;
109
130
  source_file_id: string;
110
131
  source_file_name: string;
111
- conversion_pipeline: "auto-detect" | "volume" | "scene" | "texture" | "animation" | "beta-pipeline";
132
+ conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'beta-pipeline';
112
133
  progress: number;
113
134
  status: StrictUnion<'pending' | 'converting' | 'error' | 'success'> & string;
114
135
  };
115
- export declare function getUserUploadTasks({ user_id, offset, limit }: {
136
+ /**
137
+ * Lists all upload tasks of the target user.
138
+ */
139
+ export declare function getUserUploadTasks({ user_id, offset, limit, }: {
116
140
  user_id: string;
117
141
  offset?: number;
118
142
  limit?: number;
119
- }): AxiosPromise<Array<GetUserUploadTasks_UploadTask>>;
143
+ }, headers?: AxiosHeaders): AxiosPromise<Array<GetUserUploadTasks_UploadTask>>;
120
144
  export type CreateGroup_GroupMember_GroupAccess = {
121
145
  user_id: string;
122
- group_access: "read" | "write" | "manage";
123
- folder_access: "read" | "write" | "manage";
146
+ group_access: 'read' | 'write' | 'manage';
147
+ folder_access: 'read' | 'write' | 'manage';
124
148
  };
125
149
  export type CreateGroup_Group_GroupInfo = {
126
150
  group_id: string;
@@ -132,14 +156,17 @@ export type CreateGroup_Group_GroupInfo = {
132
156
  export type CreateGroup_GroupMember_GroupAccess_Writable = {
133
157
  user_id: string;
134
158
  joined_at?: string;
135
- group_access: "read" | "write" | "manage";
136
- folder_access: "read" | "write" | "manage";
159
+ group_access: 'read' | 'write' | 'manage';
160
+ folder_access: 'read' | 'write' | 'manage';
137
161
  };
138
- export declare function createGroup({ name, description, members }: {
162
+ /**
163
+ * Creates a new user group.
164
+ */
165
+ export declare function createGroup({ name, description, members, }: {
139
166
  name: string;
140
167
  description?: string;
141
168
  members: Array<CreateGroup_GroupMember_GroupAccess>;
142
- }): AxiosPromise<CreateGroup_Group_GroupInfo>;
169
+ }, headers?: AxiosHeaders): AxiosPromise<CreateGroup_Group_GroupInfo>;
143
170
  export type GetGroup_Group_GroupInfo = {
144
171
  group_id: string;
145
172
  name: string;
@@ -150,32 +177,47 @@ export type GetGroup_Group_GroupInfo = {
150
177
  export type GetGroup_GroupMember_GroupAccess = {
151
178
  user_id: string;
152
179
  joined_at?: string;
153
- group_access: "read" | "write" | "manage";
154
- folder_access: "read" | "write" | "manage";
180
+ group_access: 'read' | 'write' | 'manage';
181
+ folder_access: 'read' | 'write' | 'manage';
155
182
  };
156
- export declare function getGroup({ group_id }: {
183
+ /**
184
+ * Gets a group details.
185
+ */
186
+ export declare function getGroup({ group_id, }: {
157
187
  group_id: string;
158
- }): AxiosPromise<GetGroup_Group_GroupInfo>;
159
- export declare function updateGroupDescription({ group_id, name, description }: {
188
+ }, headers?: AxiosHeaders): AxiosPromise<GetGroup_Group_GroupInfo>;
189
+ /**
190
+ * Updates a group details.
191
+ */
192
+ export declare function updateGroupDescription({ group_id, name, description, }: {
160
193
  group_id: string;
161
194
  name: string;
162
195
  description: string;
163
- }): Promise<import("axios").AxiosResponse<any, any>>;
164
- export declare function deleteGroup({ group_id }: {
196
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
197
+ /**
198
+ * Deletes a group and all its access rights.
199
+ */
200
+ export declare function deleteGroup({ group_id, }: {
165
201
  group_id: string;
166
- }): Promise<import("axios").AxiosResponse<any, any>>;
167
- export declare function grantMemberAccessToGroup({ group_id, member_type, member_id, group_access, folder_access }: {
202
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
203
+ /**
204
+ * Grants member access to the group.
205
+ */
206
+ export declare function grantMemberAccessToGroup({ group_id, member_type, member_id, group_access, folder_access, }: {
168
207
  group_id: string;
169
- member_type: "users" | "groups";
208
+ member_type: 'users' | 'groups';
170
209
  member_id: string;
171
- group_access: "read" | "write" | "manage";
172
- folder_access: "read" | "write" | "manage";
173
- }): Promise<import("axios").AxiosResponse<any, any>>;
174
- export declare function revokeMemberAccessToGroup({ group_id, member_type, member_id }: {
210
+ group_access: 'read' | 'write' | 'manage';
211
+ folder_access: 'read' | 'write' | 'manage';
212
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
213
+ /**
214
+ * Revoke requested user access to group.
215
+ */
216
+ export declare function revokeMemberAccessToGroup({ group_id, member_type, member_id, }: {
175
217
  group_id: string;
176
- member_type: "users" | "groups";
218
+ member_type: 'users' | 'groups';
177
219
  member_id: string;
178
- }): Promise<import("axios").AxiosResponse<any, any>>;
220
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
179
221
  export type ListFolders_Folder = {
180
222
  folder_id: string;
181
223
  parent_folder_id?: string;
@@ -191,10 +233,13 @@ export type ListFolders_Object = {
191
233
  username: string;
192
234
  registered_at: string;
193
235
  };
194
- export declare function listFolders({ offset, limit }: {
236
+ /**
237
+ * Lists all accessible folders.
238
+ */
239
+ export declare function listFolders({ offset, limit, }: {
195
240
  offset?: number;
196
241
  limit?: number;
197
- }): AxiosPromise<Array<ListFolders_Folder>>;
242
+ }, headers?: AxiosHeaders): AxiosPromise<Array<ListFolders_Folder>>;
198
243
  export type CreateFolder_Folder = {
199
244
  name: string;
200
245
  subfolders?: Array<CreateFolder_Folder>;
@@ -214,10 +259,13 @@ export type CreateFolder_Object = {
214
259
  username: string;
215
260
  registered_at: string;
216
261
  };
217
- export declare function createFolder({ name, subfolders }: {
262
+ /**
263
+ * Creates a folder.
264
+ */
265
+ export declare function createFolder({ name, subfolders, }: {
218
266
  name: string;
219
267
  subfolders?: Array<CreateFolder_Folder>;
220
- }): AxiosPromise<CreateFolder_Folder_Writable>;
268
+ }, headers?: AxiosHeaders): AxiosPromise<CreateFolder_Folder_Writable>;
221
269
  export type GetFolderInfo_Folder = {
222
270
  folder_id: string;
223
271
  parent_folder_id?: string;
@@ -233,20 +281,32 @@ export type GetFolderInfo_Object = {
233
281
  username: string;
234
282
  registered_at: string;
235
283
  };
236
- export declare function getFolderInfo({ folder_id }: {
284
+ /**
285
+ * Gets the requested folder details.
286
+ */
287
+ export declare function getFolderInfo({ folder_id, }: {
237
288
  folder_id: string;
238
- }): AxiosPromise<GetFolderInfo_Folder>;
239
- export declare function moveFolders({ folder_id, folder_ids }: {
289
+ }, headers?: AxiosHeaders): AxiosPromise<GetFolderInfo_Folder>;
290
+ /**
291
+ * Move folders inside the specified folder.
292
+ */
293
+ export declare function moveFolders({ folder_id, folder_ids, }: {
240
294
  folder_id: string;
241
295
  folder_ids: Array<string>;
242
- }): Promise<import("axios").AxiosResponse<any, any>>;
243
- export declare function updateFolder({ folder_id, name }: {
296
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
297
+ /**
298
+ * Updates the folder details.
299
+ */
300
+ export declare function updateFolder({ folder_id, name, }: {
244
301
  folder_id: string;
245
302
  name?: string;
246
- }): Promise<import("axios").AxiosResponse<any, any>>;
247
- export declare function deleteFolder({ folder_id }: {
303
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
304
+ /**
305
+ * Deletes the requested folder. The target folder must be empty.
306
+ */
307
+ export declare function deleteFolder({ folder_id, }: {
248
308
  folder_id: string;
249
- }): Promise<import("axios").AxiosResponse<any, any>>;
309
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
250
310
  export type ListFolderAccesses_Object = {
251
311
  users?: Array<ListFolderAccesses_UserInfo_FolderAccess>;
252
312
  groups?: Array<ListFolderAccesses_GroupInfo_FolderAccess>;
@@ -254,27 +314,36 @@ export type ListFolderAccesses_Object = {
254
314
  export type ListFolderAccesses_UserInfo_FolderAccess = {
255
315
  user_id: string;
256
316
  username: string;
257
- access: "read" | "write" | "manage";
317
+ access: 'read' | 'write' | 'manage';
258
318
  };
259
319
  export type ListFolderAccesses_GroupInfo_FolderAccess = {
260
320
  group_id: string;
261
321
  name: string;
262
- access: "read" | "write" | "manage";
322
+ access: 'read' | 'write' | 'manage';
263
323
  };
264
- export declare function listFolderAccesses({ folder_id }: {
324
+ /**
325
+ * List member access to the targeted folder.
326
+ */
327
+ export declare function listFolderAccesses({ folder_id, }: {
265
328
  folder_id: string;
266
- }): AxiosPromise<ListFolderAccesses_Object>;
267
- export declare function grantMemberAccessToFolder({ folder_id, member_type, member_id, access }: {
329
+ }, headers?: AxiosHeaders): AxiosPromise<ListFolderAccesses_Object>;
330
+ /**
331
+ * Grants member access to the targeted folder.
332
+ */
333
+ export declare function grantMemberAccessToFolder({ folder_id, member_type, member_id, access, }: {
268
334
  folder_id: string;
269
- member_type: "users" | "groups";
335
+ member_type: 'users' | 'groups';
270
336
  member_id: string;
271
- access: "read" | "write" | "manage";
272
- }): Promise<import("axios").AxiosResponse<any, any>>;
273
- export declare function revokeMemberAccessToFolder({ folder_id, member_type, member_id }: {
337
+ access: 'read' | 'write' | 'manage';
338
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
339
+ /**
340
+ * Revokes member access to a target folder.
341
+ */
342
+ export declare function revokeMemberAccessToFolder({ folder_id, member_type, member_id, }: {
274
343
  folder_id: string;
275
- member_type: "users" | "groups";
344
+ member_type: 'users' | 'groups';
276
345
  member_id: string;
277
- }): Promise<import("axios").AxiosResponse<any, any>>;
346
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
278
347
  export type CreateSubfolder_Folder = {
279
348
  name: string;
280
349
  subfolders?: Array<CreateSubfolder_Folder>;
@@ -294,11 +363,14 @@ export type CreateSubfolder_Object = {
294
363
  username: string;
295
364
  registered_at: string;
296
365
  };
297
- export declare function createSubfolder({ folder_id, name, subfolders }: {
366
+ /**
367
+ * Creates a subfolder.
368
+ */
369
+ export declare function createSubfolder({ folder_id, name, subfolders, }: {
298
370
  folder_id: string;
299
371
  name: string;
300
372
  subfolders?: Array<CreateSubfolder_Folder>;
301
- }): AxiosPromise<CreateSubfolder_Folder_Writable>;
373
+ }, headers?: AxiosHeaders): AxiosPromise<CreateSubfolder_Folder_Writable>;
302
374
  export type ListFolderSubFolders_Folder = {
303
375
  folder_id: string;
304
376
  parent_folder_id?: string;
@@ -314,16 +386,22 @@ export type ListFolderSubFolders_Object = {
314
386
  username: string;
315
387
  registered_at: string;
316
388
  };
317
- export declare function listFolderSubFolders({ folder_id }: {
389
+ /**
390
+ * Lists all subfolders of requested folder. This request can be recursive.
391
+ */
392
+ export declare function listFolderSubFolders({ folder_id, }: {
318
393
  folder_id: string;
319
- }): AxiosPromise<Array<ListFolderSubFolders_Folder>>;
394
+ }, headers?: AxiosHeaders): AxiosPromise<Array<ListFolderSubFolders_Folder>>;
320
395
  export type UploadSourceFiles_Object = {
321
396
  upload_task_id?: string;
322
397
  };
323
- export declare function uploadSourceFiles({ folder_id, body }: {
398
+ /**
399
+ * Uploads the specified source file(s).
400
+ */
401
+ export declare function uploadSourceFiles({ folder_id, body, }: {
324
402
  folder_id: string;
325
403
  body: FormData;
326
- }): AxiosPromise<UploadSourceFiles_Object>;
404
+ }, headers?: AxiosHeaders): AxiosPromise<UploadSourceFiles_Object>;
327
405
  export type GetSourceFilesInFolder_Filters = {
328
406
  source_file_name?: string;
329
407
  };
@@ -333,16 +411,22 @@ export type GetSourceFilesInFolder_SourceFile = {
333
411
  name: string;
334
412
  size: number;
335
413
  };
336
- export declare function getSourceFilesInFolder({ folder_id, offset, limit, filters }: {
414
+ /**
415
+ * Lists all source files in a folder.
416
+ */
417
+ export declare function getSourceFilesInFolder({ folder_id, offset, limit, filters, }: {
337
418
  folder_id: string;
338
419
  offset?: number;
339
420
  limit?: number;
340
421
  filters?: GetSourceFilesInFolder_Filters;
341
- }): AxiosPromise<Array<GetSourceFilesInFolder_SourceFile>>;
342
- export declare function moveSourceFiles({ folder_id, source_file_ids }: {
422
+ }, headers?: AxiosHeaders): AxiosPromise<Array<GetSourceFilesInFolder_SourceFile>>;
423
+ /**
424
+ * Move source files inside the specified folder.
425
+ */
426
+ export declare function moveSourceFiles({ folder_id, source_file_ids, }: {
343
427
  folder_id: string;
344
428
  source_file_ids: Array<string>;
345
- }): Promise<import("axios").AxiosResponse<any, any>>;
429
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
346
430
  export type GetUploadTasksInFolder_UploadTask = {
347
431
  upload_task_id: string;
348
432
  folder_id: string;
@@ -361,19 +445,22 @@ export type GetUploadTasksInFolder_ConversionTask = {
361
445
  asset_id: string;
362
446
  source_file_id: string;
363
447
  source_file_name: string;
364
- conversion_pipeline: "auto-detect" | "volume" | "scene" | "texture" | "animation" | "beta-pipeline";
448
+ conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'beta-pipeline';
365
449
  progress: number;
366
450
  status: StrictUnion<'pending' | 'converting' | 'error' | 'success'> & string;
367
451
  };
368
- export declare function getUploadTasksInFolder({ folder_id, offset, limit }: {
452
+ /**
453
+ * Lists all upload tasks in a folder.
454
+ */
455
+ export declare function getUploadTasksInFolder({ folder_id, offset, limit, }: {
369
456
  folder_id: string;
370
457
  offset?: number;
371
458
  limit?: number;
372
- }): AxiosPromise<Array<GetUploadTasksInFolder_UploadTask>>;
459
+ }, headers?: AxiosHeaders): AxiosPromise<Array<GetUploadTasksInFolder_UploadTask>>;
373
460
  export type GetFolderAssets_Filters = {
374
461
  asset_name?: string;
375
- asset_type?: (Array<"action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material"> | "action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material");
376
- source_file?: (Array<string> | string | 'exclude');
462
+ asset_type?: Array<'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'> | 'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
463
+ source_file?: Array<string> | string | 'exclude';
377
464
  };
378
465
  export type GetFolderAssets_AssetCount = {
379
466
  total: number;
@@ -408,25 +495,28 @@ export type GetFolderAssets_Object = {
408
495
  asset_id: string;
409
496
  name: string;
410
497
  };
411
- export declare function getFolderAssets({ folder_id, offset, limit, filter, recursive }: {
498
+ /**
499
+ * Lists assets.
500
+ */
501
+ export declare function getFolderAssets({ folder_id, offset, limit, filter, recursive, }: {
412
502
  folder_id: string;
413
503
  offset?: number;
414
504
  limit?: number;
415
505
  filter?: GetFolderAssets_Filters;
416
506
  recursive?: boolean;
417
- }): AxiosPromise<GetFolderAssets__index_AssetList_AssetList>;
507
+ }, headers?: AxiosHeaders): AxiosPromise<GetFolderAssets__index_AssetList_AssetList>;
418
508
  export type CreateAsset_NewAsset = {
419
- asset_type: "action_map" | "algorithm" | "animation_graph" | "animation_sequence" | "cubemap" | "event_map" | "material" | "module" | "render_graph" | "scene" | "script" | "shader" | "volume_material";
509
+ asset_type: 'action_map' | 'algorithm' | 'animation_graph' | 'animation_sequence' | 'cubemap' | 'event_map' | 'material' | 'module' | 'render_graph' | 'scene' | 'script' | 'shader' | 'volume_material';
420
510
  name: string;
421
511
  };
422
512
  export type CreateAsset_AssetDuplication = {
423
- asset_type: "action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material";
513
+ asset_type: 'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
424
514
  copy_from_asset_id: string;
425
515
  new_asset_name?: string;
426
516
  options?: CreateAsset_DuplicationOptions;
427
517
  };
428
518
  export type CreateAsset_DuplicationOptions = {
429
- asset_types?: Array<"action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material">;
519
+ asset_types?: Array<'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
430
520
  max_depth?: number;
431
521
  };
432
522
  export type CreateAsset_AssetDuplicationResult = {
@@ -437,32 +527,44 @@ export type CreateAsset_AssetDuplicationResult = {
437
527
  export type CreateAsset_SourceToCopyAssetIdMap = {
438
528
  [source_asset_id: string]: string;
439
529
  };
440
- export declare function createAsset({ folder_id, asset_creation_options }: {
530
+ /**
531
+ * Creates a new asset.
532
+ */
533
+ export declare function createAsset({ folder_id, asset_creation_options, }: {
441
534
  folder_id: string;
442
535
  asset_creation_options: StrictUnion<CreateAsset_NewAsset | CreateAsset_AssetDuplication>;
443
- }): AxiosPromise<CreateAsset_AssetDuplicationResult>;
444
- export declare function moveAssets({ folder_id, asset_ids }: {
536
+ }, headers?: AxiosHeaders): AxiosPromise<CreateAsset_AssetDuplicationResult>;
537
+ /**
538
+ * Move assets inside the specified folder.
539
+ */
540
+ export declare function moveAssets({ folder_id, asset_ids, }: {
445
541
  folder_id: string;
446
542
  asset_ids: Array<string>;
447
- }): Promise<import("axios").AxiosResponse<any, any>>;
543
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
448
544
  export type CreateMaterial_Object = {
449
545
  asset_id: string;
450
546
  };
451
- export declare function createMaterial({ folder_id, dataJson, isDoubleSided, name, shaderRef }: {
547
+ /**
548
+ * Creates a material.
549
+ */
550
+ export declare function createMaterial({ folder_id, dataJson, isDoubleSided, name, shaderRef, }: {
452
551
  folder_id: string;
453
552
  dataJson: object;
454
553
  isDoubleSided: boolean;
455
554
  name: string;
456
555
  shaderRef: string;
457
- }): AxiosPromise<CreateMaterial_Object>;
556
+ }, headers?: AxiosHeaders): AxiosPromise<CreateMaterial_Object>;
458
557
  export type CreateCubemap_Object = {
459
558
  asset_id: string;
460
559
  };
461
- export declare function createCubemap({ folder_id, faces, name }: {
560
+ /**
561
+ * Creates a cubemap.
562
+ */
563
+ export declare function createCubemap({ folder_id, faces, name, }: {
462
564
  folder_id: string;
463
565
  faces: Array<string>;
464
566
  name: string;
465
- }): AxiosPromise<CreateCubemap_Object>;
567
+ }, headers?: AxiosHeaders): AxiosPromise<CreateCubemap_Object>;
466
568
  export type ImportAssets__index_ImportAssetsResponse_ImportAssetsResponse = {
467
569
  asset_ids: ImportAssets_AssetIds;
468
570
  skipped_files?: Array<string>;
@@ -472,11 +574,45 @@ export type ImportAssets_AssetIds = {
472
574
  overwritten: Array<string>;
473
575
  skipped: Array<string>;
474
576
  };
475
- export declare function importAssets({ folder_id, overwrite, body }: {
577
+ /**
578
+ * Imports or replaces multiple assets submitted as a package.
579
+ * The package must be a zip archive containing the assets to import.
580
+ * The package should contain the assets themselves at the root level of the archive with their descriptions in JSON format, and their payloads (e.g. textures, meshes, etc.)
581
+ * and contain all the assets' dependencies if they do not already exist.
582
+ * Supported assets are :
583
+ * - scene
584
+ * - mesh
585
+ * - material
586
+ * - animation
587
+ * - animation_set
588
+ * - animation_graph
589
+ * - skeleton
590
+ * - texture_1d
591
+ * - texture
592
+ * - texture_3d
593
+ * - collision_geometry
594
+ * - cubemap
595
+ * - volume_material
596
+ * - event_map
597
+ * - action_map
598
+ * - sound
599
+ * - point_cloud
600
+ * The packaged assets' files should be named according to the following pattern:
601
+ * ``` json
602
+ * - desc.[asset_type].{uuid}
603
+ * - payload.[mesh|texture|animation|skeleton|texture_1d|texture_3d|collision_geometry|sound].{uuid}
604
+ * - payload.[texture_1d|texture|texture_3d].mips[0-16].{uuid}
605
+ * - payload.point_cloud.[position|color].{uuid}
606
+ * - payload.texture_3d.histogram.{uuid}
607
+ * ```
608
+ * The package may also contain an overwrite.json file that describes which assets to overwrite.
609
+ * The overwrite.json file is only used if the overwrite query parameter is set to only-specified.
610
+ */
611
+ export declare function importAssets({ folder_id, overwrite, body, }: {
476
612
  folder_id: string;
477
613
  overwrite?: StrictUnion<'never' | 'only-specified' | 'always'>;
478
- body: ArrayBuffer;
479
- }): AxiosPromise<ImportAssets__index_ImportAssetsResponse_ImportAssetsResponse>;
614
+ body: ArrayBuffer | ReadableStream;
615
+ }, headers?: AxiosHeaders): AxiosPromise<ImportAssets__index_ImportAssetsResponse_ImportAssetsResponse>;
480
616
  export type GetSessionsInFolder_Session = {
481
617
  session_id: string;
482
618
  scene_id: string;
@@ -496,9 +632,12 @@ export type GetSessionsInFolder_UserInfo = {
496
632
  user_id: string;
497
633
  username: string;
498
634
  };
499
- export declare function getSessionsInFolder({ folder_id }: {
635
+ /**
636
+ * Lists all sessions running on scenes contained in a specified folder.
637
+ */
638
+ export declare function getSessionsInFolder({ folder_id, }: {
500
639
  folder_id: string;
501
- }): AxiosPromise<Array<GetSessionsInFolder_Session>>;
640
+ }, headers?: AxiosHeaders): AxiosPromise<Array<GetSessionsInFolder_Session>>;
502
641
  export type ListSourceFiles_Filters = {
503
642
  source_file_name?: string;
504
643
  };
@@ -508,31 +647,46 @@ export type ListSourceFiles_SourceFile = {
508
647
  name: string;
509
648
  size: number;
510
649
  };
511
- export declare function listSourceFiles({ offset, limit, filters }: {
650
+ /**
651
+ * List source files.
652
+ */
653
+ export declare function listSourceFiles({ offset, limit, filters, }: {
512
654
  offset?: number;
513
655
  limit?: number;
514
656
  filters?: ListSourceFiles_Filters;
515
- }): AxiosPromise<Array<ListSourceFiles_SourceFile>>;
516
- export declare function deleteSourceFiles({ source_file_ids, delete_assets }: {
657
+ }, headers?: AxiosHeaders): AxiosPromise<Array<ListSourceFiles_SourceFile>>;
658
+ /**
659
+ * Deletes the target source files. Deleting a source file is permanent.
660
+ */
661
+ export declare function deleteSourceFiles({ source_file_ids, delete_assets, }: {
517
662
  source_file_ids: Array<string>;
518
663
  delete_assets?: boolean;
519
- }): Promise<import("axios").AxiosResponse<any, any>>;
520
- export declare function downloadSourceFile({ source_file_id }: {
664
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
665
+ /**
666
+ * Downloads the target source file.
667
+ */
668
+ export declare function downloadSourceFile<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ source_file_id, }: {
521
669
  source_file_id: string;
522
- }): AxiosPromise<ArrayBuffer>;
670
+ }, headers?: AxiosHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
523
671
  export type GetSourceFileDetails_SourceFile = {
524
672
  source_file_id: string;
525
673
  source_file_original_name: string;
526
674
  name: string;
527
675
  size: number;
528
676
  };
529
- export declare function getSourceFileDetails({ source_file_id }: {
677
+ /**
678
+ * Get source file details.
679
+ */
680
+ export declare function getSourceFileDetails({ source_file_id, }: {
530
681
  source_file_id: string;
531
- }): AxiosPromise<GetSourceFileDetails_SourceFile>;
532
- export declare function updateSourceFileDetails({ source_file_id, name }: {
682
+ }, headers?: AxiosHeaders): AxiosPromise<GetSourceFileDetails_SourceFile>;
683
+ /**
684
+ * Updates details for a specific source file.
685
+ */
686
+ export declare function updateSourceFileDetails({ source_file_id, name, }: {
533
687
  source_file_id: string;
534
688
  name: string;
535
- }): Promise<import("axios").AxiosResponse<any, any>>;
689
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
536
690
  export type GetSourceFileAssets__index_AssetList_AssetList = {
537
691
  action_maps?: Array<GetSourceFileAssets_Object>;
538
692
  algorithms?: Array<GetSourceFileAssets_Object>;
@@ -562,13 +716,19 @@ export type GetSourceFileAssets_Object = {
562
716
  asset_id: string;
563
717
  name: string;
564
718
  };
565
- export declare function getSourceFileAssets({ source_file_id }: {
719
+ /**
720
+ * Lists all assets generated from the requested source file.
721
+ */
722
+ export declare function getSourceFileAssets({ source_file_id, }: {
566
723
  source_file_id: string;
567
- }): AxiosPromise<GetSourceFileAssets__index_AssetList_AssetList>;
568
- export declare function getUploadTasks({ offset, limit }: {
724
+ }, headers?: AxiosHeaders): AxiosPromise<GetSourceFileAssets__index_AssetList_AssetList>;
725
+ /**
726
+ * Lists all upload tasks. These upload tasks relate to uploaded source files.
727
+ */
728
+ export declare function getUploadTasks({ offset, limit, }: {
569
729
  offset?: number;
570
730
  limit?: number;
571
- }): AxiosPromise<any>;
731
+ }, headers?: AxiosHeaders): AxiosPromise<any>;
572
732
  export type GetUploadTask_UploadTask = {
573
733
  upload_task_id: string;
574
734
  folder_id: string;
@@ -587,19 +747,25 @@ export type GetUploadTask_ConversionTask = {
587
747
  asset_id: string;
588
748
  source_file_id: string;
589
749
  source_file_name: string;
590
- conversion_pipeline: "auto-detect" | "volume" | "scene" | "texture" | "animation" | "beta-pipeline";
750
+ conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'beta-pipeline';
591
751
  progress: number;
592
752
  status: StrictUnion<'pending' | 'converting' | 'error' | 'success'> & string;
593
753
  };
594
- export declare function getUploadTask({ upload_task_id }: {
754
+ /**
755
+ * Gets information related to an upload task. This upload task relates to uploaded source files.
756
+ */
757
+ export declare function getUploadTask({ upload_task_id, }: {
595
758
  upload_task_id: string;
596
- }): AxiosPromise<GetUploadTask_UploadTask>;
597
- export declare function getConversionTaskMetadata({ asset_id, filename }: {
759
+ }, headers?: AxiosHeaders): AxiosPromise<GetUploadTask_UploadTask>;
760
+ /**
761
+ * Gets metadata related to a conversion task. This metadata is produced by the conversion task.
762
+ */
763
+ export declare function getConversionTaskMetadata<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_id, filename, }: {
598
764
  asset_id: string;
599
765
  filename: string;
600
- }): AxiosPromise<ArrayBuffer>;
766
+ }, headers?: AxiosHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
601
767
  export type ListAssets_Filter = {
602
- asset_type?: (Array<"action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material"> | "action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material");
768
+ asset_type?: Array<'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'> | 'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
603
769
  asset_name?: string;
604
770
  include_public_assets?: boolean;
605
771
  };
@@ -632,28 +798,40 @@ export type ListAssets_Object = {
632
798
  asset_id: string;
633
799
  name: string;
634
800
  };
635
- export declare function listAssets({ offset, limit, filter }: {
801
+ /**
802
+ * Returns a list of all assets.
803
+ */
804
+ export declare function listAssets({ offset, limit, filter, }: {
636
805
  offset?: number;
637
806
  limit?: number;
638
807
  filter?: ListAssets_Filter;
639
- }): AxiosPromise<ListAssets__index_AssetList_AssetList>;
640
- export declare function deleteAssets({ asset_ids }: {
808
+ }, headers?: AxiosHeaders): AxiosPromise<ListAssets__index_AssetList_AssetList>;
809
+ /**
810
+ * Batch delete assets. You **MUST NOT** reference assets.
811
+ */
812
+ export declare function deleteAssets({ asset_ids, }: {
641
813
  asset_ids: Array<string>;
642
- }): Promise<import("axios").AxiosResponse<any, any>>;
643
- export declare function deleteAsset({ asset_container, asset_id }: {
644
- asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
814
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
815
+ /**
816
+ * Deletes the asset.
817
+ */
818
+ export declare function deleteAsset({ asset_container, asset_id, }: {
819
+ asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
645
820
  asset_id: string;
646
- }): Promise<import("axios").AxiosResponse<any, any>>;
821
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
647
822
  export type GetAssetSourceFile_SourceFile = {
648
823
  source_file_id: string;
649
824
  source_file_original_name: string;
650
825
  name: string;
651
826
  size: number;
652
827
  };
653
- export declare function getAssetSourceFile({ asset_container, asset_id }: {
654
- asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
828
+ /**
829
+ * Gets the source file of the specified asset.
830
+ */
831
+ export declare function getAssetSourceFile({ asset_container, asset_id, }: {
832
+ asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
655
833
  asset_id: string;
656
- }): AxiosPromise<GetAssetSourceFile_SourceFile>;
834
+ }, headers?: AxiosHeaders): AxiosPromise<GetAssetSourceFile_SourceFile>;
657
835
  export type GetAssetDetails__index_AssetDetails_AssetDetails = {
658
836
  asset_id: string;
659
837
  contributors?: Array<GetAssetDetails_Contributor>;
@@ -662,7 +840,7 @@ export type GetAssetDetails__index_AssetDetails_AssetDetails = {
662
840
  last_edited_at?: string;
663
841
  last_edited_by?: GetAssetDetails_LastEditedBy;
664
842
  name: string;
665
- type: "action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material";
843
+ type: 'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
666
844
  };
667
845
  export type GetAssetDetails_Contributor = {
668
846
  contribution_count: number;
@@ -678,10 +856,13 @@ export type GetAssetDetails_LastEditedBy = {
678
856
  user_id: string;
679
857
  username: string;
680
858
  };
681
- export declare function getAssetDetails({ asset_container, asset_id }: {
682
- asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
859
+ /**
860
+ * Gets the asset details from the specified asset.
861
+ */
862
+ export declare function getAssetDetails({ asset_container, asset_id, }: {
863
+ asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
683
864
  asset_id: string;
684
- }): AxiosPromise<GetAssetDetails__index_AssetDetails_AssetDetails>;
865
+ }, headers?: AxiosHeaders): AxiosPromise<GetAssetDetails__index_AssetDetails_AssetDetails>;
685
866
  export type GetAssetFolder_Folder = {
686
867
  folder_id: string;
687
868
  parent_folder_id?: string;
@@ -697,18 +878,21 @@ export type GetAssetFolder_Object = {
697
878
  username: string;
698
879
  registered_at: string;
699
880
  };
700
- export declare function getAssetFolder({ asset_container, asset_id }: {
701
- asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
881
+ /**
882
+ * Gets the asset folder from the specified asset.
883
+ */
884
+ export declare function getAssetFolder({ asset_container, asset_id, }: {
885
+ asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
702
886
  asset_id: string;
703
- }): AxiosPromise<GetAssetFolder_Folder>;
887
+ }, headers?: AxiosHeaders): AxiosPromise<GetAssetFolder_Folder>;
704
888
  export type GetAssetDependencies_Filter = {
705
- with_asset_types?: Array<"action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material">;
706
- without_asset_types?: Array<"action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material">;
889
+ with_asset_types?: Array<'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
890
+ without_asset_types?: Array<'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
707
891
  public?: StrictUnion<'include' | 'exclude' | 'restrict-to'>;
708
892
  };
709
893
  export type GetAssetDependencies_Asset = {
710
894
  asset_id: string;
711
- asset_type: "action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material";
895
+ asset_type: 'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
712
896
  properties?: GetAssetDependencies_Object;
713
897
  };
714
898
  export type GetAssetDependencies_Object = {
@@ -727,18 +911,21 @@ export type GetAssetDependencies_Dependency = {
727
911
  asset_id: string;
728
912
  count: number;
729
913
  };
730
- export declare function getAssetDependencies({ asset_container, asset_id, offset, limit, depth, filters, properties }: {
731
- asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
914
+ /**
915
+ * Gets the asset dependencies from the specified asset.
916
+ */
917
+ export declare function getAssetDependencies({ asset_container, asset_id, offset, limit, depth, filters, properties, }: {
918
+ asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
732
919
  asset_id: string;
733
920
  offset?: number;
734
921
  limit?: number;
735
- depth?: ('all' | 'direct' | number);
922
+ depth?: 'all' | 'direct' | number;
736
923
  filters?: GetAssetDependencies_Filter;
737
924
  properties?: Array<StrictUnion<'name' | 'dependencies' | 'count' | 'public' | 'payload_info'>>;
738
- }): AxiosPromise<Array<GetAssetDependencies_Asset>>;
925
+ }, headers?: AxiosHeaders): AxiosPromise<Array<GetAssetDependencies_Asset>>;
739
926
  export type GetAssetReferences_Asset = {
740
927
  asset_id: string;
741
- asset_type: "action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material";
928
+ asset_type: 'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
742
929
  properties?: GetAssetReferences_Object;
743
930
  };
744
931
  export type GetAssetReferences_Object = {
@@ -746,13 +933,16 @@ export type GetAssetReferences_Object = {
746
933
  direct_count?: number;
747
934
  is_public?: boolean;
748
935
  };
749
- export declare function getAssetReferences({ asset_container, asset_id, offset, limit, properties }: {
750
- asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
936
+ /**
937
+ * Gets the asset references from the specified asset.
938
+ */
939
+ export declare function getAssetReferences({ asset_container, asset_id, offset, limit, properties, }: {
940
+ asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
751
941
  asset_id: string;
752
942
  offset?: number;
753
943
  limit?: number;
754
944
  properties?: Array<StrictUnion<'name' | 'count' | 'public'>>;
755
- }): AxiosPromise<Array<GetAssetReferences_Asset>>;
945
+ }, headers?: AxiosHeaders): AxiosPromise<Array<GetAssetReferences_Asset>>;
756
946
  export type GetAssetDescription_ActionMap = {
757
947
  actions: GetAssetDescription_Object;
758
948
  name: string;
@@ -948,58 +1138,91 @@ export type GetAssetDescription_VolumeMaterial = {
948
1138
  roughnessLUT?: Array<GetAssetDescription_Object>;
949
1139
  uuid: string;
950
1140
  };
951
- export declare function getAssetDescription({ asset_container, asset_id }: {
952
- asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
1141
+ /**
1142
+ * Gets the asset description from the specified asset.
1143
+ */
1144
+ export declare function getAssetDescription({ asset_container, asset_id, }: {
1145
+ asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
953
1146
  asset_id: string;
954
- }): AxiosPromise<StrictUnion<GetAssetDescription_ActionMap | GetAssetDescription_Algorithm | GetAssetDescription_Animation | GetAssetDescription_AnimationGraph | GetAssetDescription_AnimationSequence | GetAssetDescription_AnimationSet | GetAssetDescription_CollisionGeometry | GetAssetDescription_Cubemap | GetAssetDescription_EventMap | GetAssetDescription_Material | GetAssetDescription_Mesh | GetAssetDescription_Module | GetAssetDescription_PointCloud | GetAssetDescription_RenderGraph | GetAssetDescription_Scene | GetAssetDescription_Script | GetAssetDescription_Shader | GetAssetDescription_Skeleton | GetAssetDescription_Sound | GetAssetDescription_Texture | GetAssetDescription_Texture_1D | GetAssetDescription_Texture_3D | GetAssetDescription_VolumeMaterial>>;
955
- export declare function renameAsset({ asset_container, asset_id, name }: {
956
- asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
1147
+ }, headers?: AxiosHeaders): AxiosPromise<StrictUnion<GetAssetDescription_ActionMap | GetAssetDescription_Algorithm | GetAssetDescription_Animation | GetAssetDescription_AnimationGraph | GetAssetDescription_AnimationSequence | GetAssetDescription_AnimationSet | GetAssetDescription_CollisionGeometry | GetAssetDescription_Cubemap | GetAssetDescription_EventMap | GetAssetDescription_Material | GetAssetDescription_Mesh | GetAssetDescription_Module | GetAssetDescription_PointCloud | GetAssetDescription_RenderGraph | GetAssetDescription_Scene | GetAssetDescription_Script | GetAssetDescription_Shader | GetAssetDescription_Skeleton | GetAssetDescription_Sound | GetAssetDescription_Texture | GetAssetDescription_Texture_1D | GetAssetDescription_Texture_3D | GetAssetDescription_VolumeMaterial>>;
1148
+ /**
1149
+ * Updates asset description. Supports only updating name.
1150
+ */
1151
+ export declare function renameAsset({ asset_container, asset_id, name, }: {
1152
+ asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
957
1153
  asset_id: string;
958
1154
  name?: string;
959
- }): Promise<import("axios").AxiosResponse<any, any>>;
960
- export declare function getAssetPayload({ asset_container_with_payload, asset_id, sub_resource }: {
961
- asset_container_with_payload: "animations" | "animation_sequences" | "collision_geometries" | "meshes" | "point_clouds" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d";
1155
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
1156
+ /**
1157
+ * Gets the asset payload from the specified asset.
1158
+ */
1159
+ export declare function getAssetPayload<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container_with_payload, asset_id, sub_resource, }: {
1160
+ asset_container_with_payload: 'animations' | 'animation_sequences' | 'collision_geometries' | 'meshes' | 'point_clouds' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d';
962
1161
  asset_id: string;
963
1162
  sub_resource?: StrictUnion<string | 'histogram' | 'position' | 'color'>;
964
- }): AxiosPromise<ArrayBuffer>;
965
- export declare function getAssetHistory({ asset_container, asset_id }: {
966
- asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
1163
+ }, headers?: AxiosHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
1164
+ /**
1165
+ * Gets the asset history from the specified asset.
1166
+ */
1167
+ export declare function getAssetHistory({ asset_container, asset_id, }: {
1168
+ asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
967
1169
  asset_id: string;
968
- }): AxiosPromise<object>;
969
- export declare function getAssetMeta({ asset_container, asset_id }: {
970
- asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
1170
+ }, headers?: AxiosHeaders): AxiosPromise<object>;
1171
+ /**
1172
+ * Gets the asset metadata from the specified asset.
1173
+ */
1174
+ export declare function getAssetMeta({ asset_container, asset_id, }: {
1175
+ asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
971
1176
  asset_id: string;
972
- }): AxiosPromise<object>;
973
- export declare function getAssetCode({ asset_container_with_code, asset_id }: {
974
- asset_container_with_code: "algorithms" | "animation_sequences" | "modules" | "scripts" | "shaders";
1177
+ }, headers?: AxiosHeaders): AxiosPromise<object>;
1178
+ /**
1179
+ * Gets the code of the specified asset.
1180
+ */
1181
+ export declare function getAssetCode({ asset_container_with_code, asset_id, }: {
1182
+ asset_container_with_code: 'algorithms' | 'animation_sequences' | 'modules' | 'scripts' | 'shaders';
975
1183
  asset_id: string;
976
- }): AxiosPromise<string>;
977
- export declare function getAssetThumbnail({ asset_container, asset_id, size, default_url }: {
978
- asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
1184
+ }, headers?: AxiosHeaders): AxiosPromise<string>;
1185
+ /**
1186
+ * Gets the asset thumbnail from the specified asset.
1187
+ */
1188
+ export declare function getAssetThumbnail<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container, asset_id, size, default_url, }: {
1189
+ asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
979
1190
  asset_id: string;
980
- size: "large" | "medium" | "small" | "tiny";
1191
+ size: 'large' | 'medium' | 'small' | 'tiny';
981
1192
  default_url?: string;
982
- }): AxiosPromise<ArrayBuffer>;
983
- export declare function setAssetThumbnail({ asset_container, asset_id, body }: {
984
- asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
1193
+ }, headers?: AxiosHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
1194
+ /**
1195
+ * Assigns a thumbnail to the specified asset.
1196
+ */
1197
+ export declare function setAssetThumbnail({ asset_container, asset_id, body, }: {
1198
+ asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
985
1199
  asset_id: string;
986
- body: ArrayBuffer;
987
- }, contentType: 'image/jpg' | 'image/png'): Promise<import("axios").AxiosResponse<any, any>>;
988
- export declare function getAssetCustomTypes({ asset_container_with_custom_types, asset_id }: {
989
- asset_container_with_custom_types: "modules";
1200
+ body: ArrayBuffer | ReadableStream;
1201
+ }, contentType: 'image/jpg' | 'image/png', headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
1202
+ /**
1203
+ * Gets the asset custom types from the specified asset recursively.
1204
+ */
1205
+ export declare function getAssetCustomTypes({ asset_container_with_custom_types, asset_id, }: {
1206
+ asset_container_with_custom_types: 'modules';
990
1207
  asset_id: string;
991
- }): AxiosPromise<object>;
992
- export declare function packageAsset({ asset_container, asset_id }: {
993
- asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
1208
+ }, headers?: AxiosHeaders): AxiosPromise<object>;
1209
+ /**
1210
+ * Packages and downloads the target asset.
1211
+ */
1212
+ export declare function packageAsset<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container, asset_id, }: {
1213
+ asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
994
1214
  asset_id: string;
995
- }): AxiosPromise<ArrayBuffer>;
996
- export declare function exportAsset({ asset_container_exportable, asset_id, format, scale, sub_mesh_index }: {
997
- asset_container_exportable: "meshes" | "sounds";
1215
+ }, headers?: AxiosHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
1216
+ /**
1217
+ * Downloads an asset payload in a given format. Only mesh is supported for the moment. This endpoint requires special export permission.
1218
+ */
1219
+ export declare function exportAsset<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container_exportable, asset_id, format, scale, sub_mesh_index, }: {
1220
+ asset_container_exportable: 'meshes' | 'sounds';
998
1221
  asset_id: string;
999
- format: "obj" | "stl";
1222
+ format: 'obj' | 'stl';
1000
1223
  scale?: number;
1001
1224
  sub_mesh_index?: number;
1002
- }): AxiosPromise<ArrayBuffer>;
1225
+ }, headers?: AxiosHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
1003
1226
  export type GetSceneSessions_Session = {
1004
1227
  session_id: string;
1005
1228
  scene_id: string;
@@ -1019,16 +1242,22 @@ export type GetSceneSessions_UserInfo = {
1019
1242
  user_id: string;
1020
1243
  username: string;
1021
1244
  };
1022
- export declare function getSceneSessions({ scene_id }: {
1245
+ /**
1246
+ * Lists all sessions running a specified scene.
1247
+ */
1248
+ export declare function getSceneSessions({ scene_id, }: {
1023
1249
  scene_id: string;
1024
- }): AxiosPromise<Array<GetSceneSessions_Session>>;
1250
+ }, headers?: AxiosHeaders): AxiosPromise<Array<GetSceneSessions_Session>>;
1025
1251
  export type GetSceneAabb_Object = {
1026
1252
  max: Array<number>;
1027
1253
  min: Array<number>;
1028
1254
  };
1029
- export declare function getSceneAABB({ scene_id }: {
1255
+ /**
1256
+ * Get the axis aligned bounding box of the specified scene.
1257
+ */
1258
+ export declare function getSceneAABB({ scene_id, }: {
1030
1259
  scene_id: string;
1031
- }): AxiosPromise<GetSceneAabb_Object>;
1260
+ }, headers?: AxiosHeaders): AxiosPromise<GetSceneAabb_Object>;
1032
1261
  export type CreateEntity_animation_controller = {
1033
1262
  animation_controller: CreateEntity_AnimationController;
1034
1263
  };
@@ -1373,10 +1602,13 @@ export type CreateEntity_VolumeReference = {
1373
1602
  export type CreateEntity_Object = {
1374
1603
  entity_id: string;
1375
1604
  };
1376
- export declare function createEntity({ scene_id, entity_components }: {
1605
+ /**
1606
+ * Create a new entity in a scene.
1607
+ */
1608
+ export declare function createEntity({ scene_id, entity_components, }: {
1377
1609
  scene_id: string;
1378
- entity_components: (CreateEntity_animation_controller | CreateEntity_bone | CreateEntity_box_geometry | CreateEntity_camera | CreateEntity_capsule_geometry | CreateEntity_character_controller | CreateEntity_collision_geometry_ref | CreateEntity_cylinder_geometry | CreateEntity_debug_name | CreateEntity_decal_projector | CreateEntity_environment | CreateEntity_joint | CreateEntity_lineage | CreateEntity_local_aabb | CreateEntity_local_transform | CreateEntity_material | CreateEntity_material_ref | CreateEntity_mesh_ref | CreateEntity_orthographic_lens | CreateEntity_overrider | CreateEntity_perspective_lens | CreateEntity_physics_material | CreateEntity_plane_geometry | CreateEntity_point_cloud_ref | CreateEntity_point_light | CreateEntity_reflection_probe | CreateEntity_revolute_joint | CreateEntity_rigid_body | CreateEntity_scene_ref | CreateEntity_script_element | CreateEntity_script_map | CreateEntity_shadow_caster | CreateEntity_skeleton_ref | CreateEntity_sound_ref | CreateEntity_sphere_geometry | CreateEntity_spot_light | CreateEntity_stereoscopic_lens | CreateEntity_tags | CreateEntity_volume_filter | CreateEntity_volume_material_ref | CreateEntity_volume_ref);
1379
- }): AxiosPromise<CreateEntity_Object>;
1610
+ entity_components: CreateEntity_animation_controller | CreateEntity_bone | CreateEntity_box_geometry | CreateEntity_camera | CreateEntity_capsule_geometry | CreateEntity_character_controller | CreateEntity_collision_geometry_ref | CreateEntity_cylinder_geometry | CreateEntity_debug_name | CreateEntity_decal_projector | CreateEntity_environment | CreateEntity_joint | CreateEntity_lineage | CreateEntity_local_aabb | CreateEntity_local_transform | CreateEntity_material | CreateEntity_material_ref | CreateEntity_mesh_ref | CreateEntity_orthographic_lens | CreateEntity_overrider | CreateEntity_perspective_lens | CreateEntity_physics_material | CreateEntity_plane_geometry | CreateEntity_point_cloud_ref | CreateEntity_point_light | CreateEntity_reflection_probe | CreateEntity_revolute_joint | CreateEntity_rigid_body | CreateEntity_scene_ref | CreateEntity_script_element | CreateEntity_script_map | CreateEntity_shadow_caster | CreateEntity_skeleton_ref | CreateEntity_sound_ref | CreateEntity_sphere_geometry | CreateEntity_spot_light | CreateEntity_stereoscopic_lens | CreateEntity_tags | CreateEntity_volume_filter | CreateEntity_volume_material_ref | CreateEntity_volume_ref;
1611
+ }, headers?: AxiosHeaders): AxiosPromise<CreateEntity_Object>;
1380
1612
  export type GetEntity_animation_controller = {
1381
1613
  animation_controller: GetEntity_AnimationController;
1382
1614
  };
@@ -1724,11 +1956,14 @@ export type GetEntity_Entity = {
1724
1956
  export type GetEntity_EntityUid = {
1725
1957
  value: string;
1726
1958
  };
1727
- export declare function getEntity({ scene_id, entity_id, compute_global_transform }: {
1959
+ /**
1960
+ * Get a specific entity from a scene.
1961
+ */
1962
+ export declare function getEntity({ scene_id, entity_id, compute_global_transform, }: {
1728
1963
  scene_id: string;
1729
1964
  entity_id: string;
1730
1965
  compute_global_transform?: boolean;
1731
- }): AxiosPromise<(GetEntity_animation_controller | GetEntity_bone | GetEntity_box_geometry | GetEntity_camera | GetEntity_capsule_geometry | GetEntity_character_controller | GetEntity_collision_geometry_ref | GetEntity_cylinder_geometry | GetEntity_debug_name | GetEntity_decal_projector | GetEntity_environment | GetEntity_joint | GetEntity_lineage | GetEntity_local_aabb | GetEntity_local_transform | GetEntity_material | GetEntity_material_ref | GetEntity_mesh_ref | GetEntity_orthographic_lens | GetEntity_overrider | GetEntity_perspective_lens | GetEntity_physics_material | GetEntity_plane_geometry | GetEntity_point_cloud_ref | GetEntity_point_light | GetEntity_reflection_probe | GetEntity_revolute_joint | GetEntity_rigid_body | GetEntity_scene_ref | GetEntity_script_element | GetEntity_script_map | GetEntity_shadow_caster | GetEntity_skeleton_ref | GetEntity_sound_ref | GetEntity_sphere_geometry | GetEntity_spot_light | GetEntity_stereoscopic_lens | GetEntity_tags | GetEntity_volume_filter | GetEntity_volume_material_ref | GetEntity_volume_ref) & GetEntity_Entity>;
1966
+ }, headers?: AxiosHeaders): AxiosPromise<(GetEntity_animation_controller | GetEntity_bone | GetEntity_box_geometry | GetEntity_camera | GetEntity_capsule_geometry | GetEntity_character_controller | GetEntity_collision_geometry_ref | GetEntity_cylinder_geometry | GetEntity_debug_name | GetEntity_decal_projector | GetEntity_environment | GetEntity_joint | GetEntity_lineage | GetEntity_local_aabb | GetEntity_local_transform | GetEntity_material | GetEntity_material_ref | GetEntity_mesh_ref | GetEntity_orthographic_lens | GetEntity_overrider | GetEntity_perspective_lens | GetEntity_physics_material | GetEntity_plane_geometry | GetEntity_point_cloud_ref | GetEntity_point_light | GetEntity_reflection_probe | GetEntity_revolute_joint | GetEntity_rigid_body | GetEntity_scene_ref | GetEntity_script_element | GetEntity_script_map | GetEntity_shadow_caster | GetEntity_skeleton_ref | GetEntity_sound_ref | GetEntity_sphere_geometry | GetEntity_spot_light | GetEntity_stereoscopic_lens | GetEntity_tags | GetEntity_volume_filter | GetEntity_volume_material_ref | GetEntity_volume_ref) & GetEntity_Entity>;
1732
1967
  export type UpdateEntity_animation_controller = {
1733
1968
  animation_controller: UpdateEntity_AnimationController;
1734
1969
  };
@@ -2070,18 +2305,27 @@ export type UpdateEntity_volume_ref = {
2070
2305
  export type UpdateEntity_VolumeReference = {
2071
2306
  texture3dRef: string;
2072
2307
  };
2073
- export declare function updateEntity({ scene_id, entity_id, entity_components }: {
2308
+ /**
2309
+ * Update a specific entity from a scene.
2310
+ */
2311
+ export declare function updateEntity({ scene_id, entity_id, entity_components, }: {
2074
2312
  scene_id: string;
2075
2313
  entity_id: string;
2076
- entity_components: (UpdateEntity_animation_controller | UpdateEntity_bone | UpdateEntity_box_geometry | UpdateEntity_camera | UpdateEntity_capsule_geometry | UpdateEntity_character_controller | UpdateEntity_collision_geometry_ref | UpdateEntity_cylinder_geometry | UpdateEntity_debug_name | UpdateEntity_decal_projector | UpdateEntity_environment | UpdateEntity_joint | UpdateEntity_lineage | UpdateEntity_local_aabb | UpdateEntity_local_transform | UpdateEntity_material | UpdateEntity_material_ref | UpdateEntity_mesh_ref | UpdateEntity_orthographic_lens | UpdateEntity_overrider | UpdateEntity_perspective_lens | UpdateEntity_physics_material | UpdateEntity_plane_geometry | UpdateEntity_point_cloud_ref | UpdateEntity_point_light | UpdateEntity_reflection_probe | UpdateEntity_revolute_joint | UpdateEntity_rigid_body | UpdateEntity_scene_ref | UpdateEntity_script_element | UpdateEntity_script_map | UpdateEntity_shadow_caster | UpdateEntity_skeleton_ref | UpdateEntity_sound_ref | UpdateEntity_sphere_geometry | UpdateEntity_spot_light | UpdateEntity_stereoscopic_lens | UpdateEntity_tags | UpdateEntity_volume_filter | UpdateEntity_volume_material_ref | UpdateEntity_volume_ref);
2077
- }): Promise<import("axios").AxiosResponse<any, any>>;
2078
- export declare function deleteEntity({ scene_id, entity_id }: {
2314
+ entity_components: UpdateEntity_animation_controller | UpdateEntity_bone | UpdateEntity_box_geometry | UpdateEntity_camera | UpdateEntity_capsule_geometry | UpdateEntity_character_controller | UpdateEntity_collision_geometry_ref | UpdateEntity_cylinder_geometry | UpdateEntity_debug_name | UpdateEntity_decal_projector | UpdateEntity_environment | UpdateEntity_joint | UpdateEntity_lineage | UpdateEntity_local_aabb | UpdateEntity_local_transform | UpdateEntity_material | UpdateEntity_material_ref | UpdateEntity_mesh_ref | UpdateEntity_orthographic_lens | UpdateEntity_overrider | UpdateEntity_perspective_lens | UpdateEntity_physics_material | UpdateEntity_plane_geometry | UpdateEntity_point_cloud_ref | UpdateEntity_point_light | UpdateEntity_reflection_probe | UpdateEntity_revolute_joint | UpdateEntity_rigid_body | UpdateEntity_scene_ref | UpdateEntity_script_element | UpdateEntity_script_map | UpdateEntity_shadow_caster | UpdateEntity_skeleton_ref | UpdateEntity_sound_ref | UpdateEntity_sphere_geometry | UpdateEntity_spot_light | UpdateEntity_stereoscopic_lens | UpdateEntity_tags | UpdateEntity_volume_filter | UpdateEntity_volume_material_ref | UpdateEntity_volume_ref;
2315
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
2316
+ /**
2317
+ * Delete a specific entity from a scene.
2318
+ */
2319
+ export declare function deleteEntity({ scene_id, entity_id, }: {
2079
2320
  scene_id: string;
2080
2321
  entity_id: string;
2081
- }): Promise<import("axios").AxiosResponse<any, any>>;
2082
- export declare function getSceneSettings({ scene_id }: {
2322
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
2323
+ /**
2324
+ * Get the settings of a scene.
2325
+ */
2326
+ export declare function getSceneSettings({ scene_id, }: {
2083
2327
  scene_id: string;
2084
- }): AxiosPromise<object>;
2328
+ }, headers?: AxiosHeaders): AxiosPromise<object>;
2085
2329
  export type GetRunningSessions_Filter = {
2086
2330
  user_id?: string;
2087
2331
  scene_id?: string;
@@ -2106,17 +2350,23 @@ export type GetRunningSessions_UserInfo = {
2106
2350
  user_id: string;
2107
2351
  username: string;
2108
2352
  };
2109
- export declare function getRunningSessions({ filters }: {
2353
+ /**
2354
+ * Lists all running rendering sessions.
2355
+ */
2356
+ export declare function getRunningSessions({ filters, }: {
2110
2357
  filters?: GetRunningSessions_Filter;
2111
- }): AxiosPromise<Array<GetRunningSessions_Session>>;
2358
+ }, headers?: AxiosHeaders): AxiosPromise<Array<GetRunningSessions_Session>>;
2112
2359
  export type CreateSession_Object = {
2113
2360
  session_id: string;
2114
2361
  };
2115
- export declare function createSession({ scene_id, renderer_version, is_transient }: {
2362
+ /**
2363
+ * Create a new rendering session.
2364
+ */
2365
+ export declare function createSession({ scene_id, renderer_version, is_transient, }: {
2116
2366
  scene_id: string;
2117
2367
  renderer_version?: string;
2118
2368
  is_transient?: boolean;
2119
- }): AxiosPromise<CreateSession_Object>;
2369
+ }, headers?: AxiosHeaders): AxiosPromise<CreateSession_Object>;
2120
2370
  export type GetSession_Session = {
2121
2371
  session_id: string;
2122
2372
  scene_id: string;
@@ -2136,12 +2386,18 @@ export type GetSession_UserInfo = {
2136
2386
  user_id: string;
2137
2387
  username: string;
2138
2388
  };
2139
- export declare function getSession({ session_id }: {
2389
+ /**
2390
+ * Retrieves details about the target session.
2391
+ */
2392
+ export declare function getSession({ session_id, }: {
2140
2393
  session_id: string;
2141
- }): AxiosPromise<GetSession_Session>;
2142
- export declare function killSession({ session_id }: {
2394
+ }, headers?: AxiosHeaders): AxiosPromise<GetSession_Session>;
2395
+ /**
2396
+ * Forcefully terminates a session.
2397
+ */
2398
+ export declare function killSession({ session_id, }: {
2143
2399
  session_id: string;
2144
- }): Promise<import("axios").AxiosResponse<any, any>>;
2400
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
2145
2401
  export type JoinSession_SessionToken = {
2146
2402
  session_token: string;
2147
2403
  endpoint_info: JoinSession_Object;
@@ -2151,13 +2407,19 @@ export type JoinSession_Object = {
2151
2407
  port: number;
2152
2408
  ssl_port: number;
2153
2409
  };
2154
- export declare function joinSession({ session_id }: {
2410
+ /**
2411
+ * Creates a new client for the user and returns a token to join the session.
2412
+ */
2413
+ export declare function joinSession({ session_id, }: {
2155
2414
  session_id: string;
2156
- }): AxiosPromise<JoinSession_SessionToken>;
2157
- export declare function kickClientFromSession({ session_id, client_id }: {
2415
+ }, headers?: AxiosHeaders): AxiosPromise<JoinSession_SessionToken>;
2416
+ /**
2417
+ * Kick a client from a running session.
2418
+ */
2419
+ export declare function kickClientFromSession({ session_id, client_id, }: {
2158
2420
  session_id: string;
2159
2421
  client_id: string;
2160
- }): Promise<import("axios").AxiosResponse<any, any>>;
2422
+ }, headers?: AxiosHeaders): Promise<import("axios").AxiosResponse<any, any>>;
2161
2423
  export type JoinSessionAsGuest_SessionToken = {
2162
2424
  session_token: string;
2163
2425
  endpoint_info: JoinSessionAsGuest_Object;
@@ -2167,11 +2429,17 @@ export type JoinSessionAsGuest_Object = {
2167
2429
  port: number;
2168
2430
  ssl_port: number;
2169
2431
  };
2170
- export declare function joinSessionAsGuest(): AxiosPromise<JoinSessionAsGuest_SessionToken>;
2432
+ /**
2433
+ * Join a session as guest. The guest token is required in the `guest_token` header.
2434
+ */
2435
+ export declare function joinSessionAsGuest(headers?: AxiosHeaders): AxiosPromise<JoinSessionAsGuest_SessionToken>;
2171
2436
  export type GenerateGuestToken_GuestToken = {
2172
2437
  guest_token?: string;
2173
2438
  };
2174
- export declare function generateGuestToken({ session_id }: {
2439
+ /**
2440
+ * Generates a token to join the session as a guest.
2441
+ */
2442
+ export declare function generateGuestToken({ session_id, }: {
2175
2443
  session_id: string;
2176
- }): AxiosPromise<GenerateGuestToken_GuestToken>;
2444
+ }, headers?: AxiosHeaders): AxiosPromise<GenerateGuestToken_GuestToken>;
2177
2445
  export {};