@3dverse/api 0.0.1 → 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
package/dist/index.d.ts CHANGED
@@ -1,3 +1,954 @@
1
- export declare function setApiKey(apiKey: string): void;
2
- export declare function setUserToken(userToken: string): void;
3
- export * from './_prebuild/wrapper';
1
+ import * as axios from 'axios';
2
+
3
+ /**
4
+ * 3dverse v1.0
5
+ * # 3dverse API
6
+ *
7
+ * Welcome to the 3dverse API. The 3dverse API scopes to an API key. Each development environment of an application requires a separate API key.
8
+ * Through the API key, you can manage ownership, access, and permissions for each environment.
9
+ * Each environment has its own set of users, groups, folders, and assets.
10
+ *
11
+ *
12
+ * Contact: 3dverse Support (support@3dverse.com)
13
+ *
14
+ * NOTE: This file is auto generated by library-generator (https://gitlab.com/3dverse/libs/library-generator).
15
+ * Do not edit this file class manually.
16
+ */
17
+ declare const axiosInstance: axios.AxiosInstance;
18
+ interface ApiError {
19
+ errorCode: number;
20
+ status: number;
21
+ error: any;
22
+ }
23
+ type ListUsers_User_UserInfo = {
24
+ user_id: string;
25
+ username: string;
26
+ registered_at?: string;
27
+ };
28
+ declare function listUsers({ offset, limit }: {
29
+ offset: number;
30
+ limit: number;
31
+ }): Promise<Array<ListUsers_User_UserInfo>>;
32
+ type RegisterUser_User_UserInfo = {
33
+ user_id: string;
34
+ username: string;
35
+ registered_at?: string;
36
+ };
37
+ declare function registerUser({ username }: {
38
+ username: string;
39
+ }): Promise<RegisterUser_User_UserInfo>;
40
+ type GetUser_User_UserInfo = {
41
+ user_id: string;
42
+ username: string;
43
+ registered_at?: string;
44
+ };
45
+ declare function getUser({ user_id }: {
46
+ user_id: string;
47
+ }): Promise<GetUser_User_UserInfo>;
48
+ declare function updateUser({ user_id, username }: {
49
+ user_id: string;
50
+ username: string;
51
+ }): Promise<axios.AxiosResponse<any, any>>;
52
+ type DeleteUser_Object = {
53
+ deleted_assets?: DeleteUser_asset_list;
54
+ };
55
+ type DeleteUser_asset_list = {
56
+ animations?: Array<DeleteUser_asset_item>;
57
+ animationGraphs?: Array<DeleteUser_asset_item>;
58
+ animationSequences?: Array<DeleteUser_asset_item>;
59
+ animationSets?: Array<DeleteUser_asset_item>;
60
+ cubemaps?: Array<DeleteUser_asset_item>;
61
+ eventMaps?: Array<DeleteUser_asset_item>;
62
+ materials?: Array<DeleteUser_asset_item>;
63
+ meshes?: Array<DeleteUser_asset_item>;
64
+ pointClouds?: Array<DeleteUser_asset_item>;
65
+ renderGraphs?: Array<DeleteUser_asset_item>;
66
+ scenes?: Array<DeleteUser_asset_item>;
67
+ scripts?: Array<DeleteUser_asset_item>;
68
+ shaders?: Array<DeleteUser_asset_item>;
69
+ skeletons?: Array<DeleteUser_asset_item>;
70
+ sounds?: Array<DeleteUser_asset_item>;
71
+ textures?: Array<DeleteUser_asset_item>;
72
+ volumeMaterials?: Array<DeleteUser_asset_item>;
73
+ };
74
+ type DeleteUser_asset_item = {
75
+ asset_id?: string;
76
+ asset_name?: string;
77
+ };
78
+ declare function deleteUser({ user_id }: {
79
+ user_id: string;
80
+ }): Promise<DeleteUser_Object>;
81
+ type GenerateUserToken_Token = {
82
+ user_token?: string;
83
+ expires_in?: number;
84
+ expires_on?: number;
85
+ };
86
+ declare function generateUserToken({ user_id, scope, ttl }: {
87
+ user_id: string;
88
+ scope: "read" | "write" | "manage";
89
+ ttl: string;
90
+ }): Promise<GenerateUserToken_Token>;
91
+ type GetUserGroups_Group_GroupInfo = {
92
+ group_id: string;
93
+ group_name: string;
94
+ group_description?: string;
95
+ created_at?: string;
96
+ members?: Array<GetUserGroups_GroupMember_GroupAccess>;
97
+ };
98
+ type GetUserGroups_GroupMember_GroupAccess = {
99
+ user_id: string;
100
+ joined_at?: string;
101
+ group_access: "read" | "write" | "manage";
102
+ folder_access: "read" | "write" | "manage";
103
+ };
104
+ declare function getUserGroups({ user_id }: {
105
+ user_id: string;
106
+ }): Promise<Array<GetUserGroups_Group_GroupInfo>>;
107
+ type GetUserUploadTasks_UploadTask = {
108
+ upload_task_id?: string;
109
+ folder_id?: string;
110
+ uploaded_at?: string;
111
+ uploaded_by?: string;
112
+ progress?: number;
113
+ status?: string;
114
+ conversion_tasks?: Array<GetUserUploadTasks_ConversionTask>;
115
+ };
116
+ type GetUserUploadTasks_ConversionTask = {
117
+ source_file_id?: string;
118
+ conversion_pipeline?: string;
119
+ progress?: number;
120
+ status?: string;
121
+ };
122
+ declare function getUserUploadTasks({ user_id, offset, limit }: {
123
+ user_id: string;
124
+ offset: number;
125
+ limit: number;
126
+ }): Promise<Array<GetUserUploadTasks_UploadTask>>;
127
+ type CreateGroup_GroupMember_GroupAccess = {
128
+ user_id: string;
129
+ group_access: "read" | "write" | "manage";
130
+ folder_access: "read" | "write" | "manage";
131
+ };
132
+ type CreateGroup_Group_GroupInfo = {
133
+ group_id: string;
134
+ group_name: string;
135
+ group_description?: string;
136
+ created_at?: string;
137
+ members?: Array<CreateGroup_GroupMember_GroupAccess>;
138
+ };
139
+ declare function createGroup({ group_name, group_description, members }: {
140
+ group_name: string;
141
+ group_description?: string;
142
+ members?: Array<CreateGroup_GroupMember_GroupAccess>;
143
+ }): Promise<CreateGroup_Group_GroupInfo>;
144
+ type GetGroup_Group_GroupInfo = {
145
+ group_id: string;
146
+ group_name: string;
147
+ group_description?: string;
148
+ created_at?: string;
149
+ members?: Array<GetGroup_GroupMember_GroupAccess>;
150
+ };
151
+ type GetGroup_GroupMember_GroupAccess = {
152
+ user_id: string;
153
+ joined_at?: string;
154
+ group_access: "read" | "write" | "manage";
155
+ folder_access: "read" | "write" | "manage";
156
+ };
157
+ declare function getGroup({ group_id }: {
158
+ group_id: string;
159
+ }): Promise<GetGroup_Group_GroupInfo>;
160
+ declare function updateGroupDescription({ group_id, group_name, group_description }: {
161
+ group_id: string;
162
+ group_name: string;
163
+ group_description: string;
164
+ }): Promise<axios.AxiosResponse<any, any>>;
165
+ declare function deleteGroup({ group_id }: {
166
+ group_id: string;
167
+ }): Promise<axios.AxiosResponse<any, any>>;
168
+ declare function grantMemberAccessToGroup({ group_id, member_type, member_id, group_access, folder_access }: {
169
+ group_id: string;
170
+ member_type: "users" | "groups";
171
+ member_id: string;
172
+ group_access: "read" | "write" | "manage";
173
+ folder_access: "read" | "write" | "manage";
174
+ }): Promise<axios.AxiosResponse<any, any>>;
175
+ declare function revokeMemberAccessToGroup({ group_id, member_type, member_id }: {
176
+ group_id: string;
177
+ member_type: "users" | "groups";
178
+ member_id: string;
179
+ }): Promise<axios.AxiosResponse<any, any>>;
180
+ type ListFolders_Folder = {
181
+ folder_id: string;
182
+ parent_folder_id?: string;
183
+ folder_name: string;
184
+ created_at?: string;
185
+ created_by?: ListFolders_User_UserInfo;
186
+ subfolders?: Array<ListFolders_Folder>;
187
+ source_file_count?: number;
188
+ asset_count?: number;
189
+ };
190
+ type ListFolders_User_UserInfo = {
191
+ user_id: string;
192
+ username: string;
193
+ registered_at?: string;
194
+ };
195
+ declare function listFolders({ offset, limit }: {
196
+ offset: number;
197
+ limit: number;
198
+ }): Promise<Array<ListFolders_Folder>>;
199
+ type CreateFolder_Folder = {
200
+ folder_name: string;
201
+ subfolders?: Array<CreateFolder_Folder>;
202
+ };
203
+ declare function createFolder({ folder_name, subfolders }: {
204
+ folder_name: string;
205
+ subfolders?: Array<CreateFolder_Folder>;
206
+ }): Promise<CreateFolder_Folder>;
207
+ type GetFolderInfo_Folder = {
208
+ folder_id: string;
209
+ parent_folder_id?: string;
210
+ folder_name: string;
211
+ created_at?: string;
212
+ created_by?: GetFolderInfo_User_UserInfo;
213
+ subfolders?: Array<GetFolderInfo_Folder>;
214
+ source_file_count?: number;
215
+ asset_count?: number;
216
+ };
217
+ type GetFolderInfo_User_UserInfo = {
218
+ user_id: string;
219
+ username: string;
220
+ registered_at?: string;
221
+ };
222
+ declare function getFolderInfo({ folder_id }: {
223
+ folder_id: string;
224
+ }): Promise<GetFolderInfo_Folder>;
225
+ declare function moveFolders({ folder_id, folder_ids }: {
226
+ folder_id: string;
227
+ folder_ids: Array<string>;
228
+ }): Promise<axios.AxiosResponse<any, any>>;
229
+ declare function updateFolder({ folder_id, folder_name }: {
230
+ folder_id: string;
231
+ folder_name?: string;
232
+ }): Promise<axios.AxiosResponse<any, any>>;
233
+ declare function deleteFolder({ folder_id }: {
234
+ folder_id: string;
235
+ }): Promise<axios.AxiosResponse<any, any>>;
236
+ type ListFolderAccesses_Object = {
237
+ users?: Array<ListFolderAccesses_UserInfo_FolderAccess>;
238
+ groups?: Array<ListFolderAccesses_GroupInfo_FolderAccess>;
239
+ };
240
+ type ListFolderAccesses_UserInfo_FolderAccess = {
241
+ user_id: string;
242
+ username: string;
243
+ access: "read" | "write" | "manage";
244
+ };
245
+ type ListFolderAccesses_GroupInfo_FolderAccess = {
246
+ group_id: string;
247
+ group_name: string;
248
+ access: "read" | "write" | "manage";
249
+ };
250
+ declare function listFolderAccesses({ folder_id }: {
251
+ folder_id: string;
252
+ }): Promise<ListFolderAccesses_Object>;
253
+ declare function grantMemberAccessToFolder({ folder_id, member_type, member_id, access }: {
254
+ folder_id: string;
255
+ member_type: "users" | "groups";
256
+ member_id: string;
257
+ access: "read" | "write" | "manage";
258
+ }): Promise<axios.AxiosResponse<any, any>>;
259
+ declare function revokeMemberAccessToFolder({ folder_id, member_type, member_id }: {
260
+ folder_id: string;
261
+ member_type: "users" | "groups";
262
+ member_id: string;
263
+ }): Promise<axios.AxiosResponse<any, any>>;
264
+ type CreateSubfolder_Folder = {
265
+ folder_name: string;
266
+ subfolders?: Array<CreateSubfolder_Folder>;
267
+ };
268
+ declare function createSubfolder({ folder_id, folder_name, subfolders }: {
269
+ folder_id: string;
270
+ folder_name: string;
271
+ subfolders?: Array<CreateSubfolder_Folder>;
272
+ }): Promise<CreateSubfolder_Folder>;
273
+ type ListFolderSubFolders_Folder = {
274
+ folder_id: string;
275
+ parent_folder_id?: string;
276
+ folder_name: string;
277
+ created_at?: string;
278
+ created_by?: ListFolderSubFolders_User_UserInfo;
279
+ subfolders?: Array<ListFolderSubFolders_Folder>;
280
+ source_file_count?: number;
281
+ asset_count?: number;
282
+ };
283
+ type ListFolderSubFolders_User_UserInfo = {
284
+ user_id: string;
285
+ username: string;
286
+ registered_at?: string;
287
+ };
288
+ declare function listFolderSubFolders({ folder_id, depth }: {
289
+ folder_id: string;
290
+ depth: number;
291
+ }): Promise<Array<ListFolderSubFolders_Folder>>;
292
+ type UploadSourceFiles_Object = {
293
+ upload_task_id?: string;
294
+ };
295
+ declare function uploadSourceFiles({ folder_id, body }: {
296
+ folder_id: string;
297
+ body: FormData;
298
+ }): Promise<UploadSourceFiles_Object>;
299
+ type GetSourceFilesInFolder_SourceFile = {
300
+ source_file_id?: string;
301
+ upload_task_id?: string;
302
+ source_file_original_name?: string;
303
+ source_file_name?: string;
304
+ size?: number;
305
+ };
306
+ declare function getSourceFilesInFolder({ folder_id, offset, limit }: {
307
+ folder_id: string;
308
+ offset: number;
309
+ limit: number;
310
+ }): Promise<Array<GetSourceFilesInFolder_SourceFile>>;
311
+ declare function moveSourceFiles({ folder_id, source_file_ids }: {
312
+ folder_id: string;
313
+ source_file_ids: Array<string>;
314
+ }): Promise<axios.AxiosResponse<any, any>>;
315
+ type GetUploadTasksInFolder_UploadTask = {
316
+ upload_task_id?: string;
317
+ folder_id?: string;
318
+ uploaded_at?: string;
319
+ uploaded_by?: string;
320
+ progress?: number;
321
+ status?: string;
322
+ conversion_tasks?: Array<GetUploadTasksInFolder_ConversionTask>;
323
+ };
324
+ type GetUploadTasksInFolder_ConversionTask = {
325
+ source_file_id?: string;
326
+ conversion_pipeline?: string;
327
+ progress?: number;
328
+ status?: string;
329
+ };
330
+ declare function getUploadTasksInFolder({ folder_id, offset, limit }: {
331
+ folder_id: string;
332
+ offset: number;
333
+ limit: number;
334
+ }): Promise<Array<GetUploadTasksInFolder_UploadTask>>;
335
+ type GetFolderAssets_asset_list = {
336
+ animations?: Array<GetFolderAssets_asset_item>;
337
+ animationGraphs?: Array<GetFolderAssets_asset_item>;
338
+ animationSequences?: Array<GetFolderAssets_asset_item>;
339
+ animationSets?: Array<GetFolderAssets_asset_item>;
340
+ cubemaps?: Array<GetFolderAssets_asset_item>;
341
+ eventMaps?: Array<GetFolderAssets_asset_item>;
342
+ materials?: Array<GetFolderAssets_asset_item>;
343
+ meshes?: Array<GetFolderAssets_asset_item>;
344
+ pointClouds?: Array<GetFolderAssets_asset_item>;
345
+ renderGraphs?: Array<GetFolderAssets_asset_item>;
346
+ scenes?: Array<GetFolderAssets_asset_item>;
347
+ scripts?: Array<GetFolderAssets_asset_item>;
348
+ shaders?: Array<GetFolderAssets_asset_item>;
349
+ skeletons?: Array<GetFolderAssets_asset_item>;
350
+ sounds?: Array<GetFolderAssets_asset_item>;
351
+ textures?: Array<GetFolderAssets_asset_item>;
352
+ volumeMaterials?: Array<GetFolderAssets_asset_item>;
353
+ };
354
+ type GetFolderAssets_asset_item = {
355
+ asset_id?: string;
356
+ asset_name?: string;
357
+ };
358
+ declare function getFolderAssets({ folder_id }: {
359
+ folder_id: string;
360
+ }): Promise<GetFolderAssets_asset_list>;
361
+ declare function moveAssets({ folder_id, asset_ids }: {
362
+ folder_id: string;
363
+ asset_ids: Array<string>;
364
+ }): Promise<axios.AxiosResponse<any, any>>;
365
+ type CreateAsset_Object = {
366
+ copy_from_asset_id: string;
367
+ };
368
+ type CreateAsset_AssetDescription = {
369
+ name?: string;
370
+ };
371
+ declare function createAsset({ folder_id, asset_container_creatable, body }: {
372
+ folder_id: string;
373
+ asset_container_creatable: "animationGraphs" | "animationSequences" | "cubemaps" | "eventMaps" | "materials" | "renderGraphs" | "scenes" | "scripts" | "shaders" | "volumeMaterials";
374
+ body: CreateAsset_Object | CreateAsset_AssetDescription;
375
+ }): Promise<axios.AxiosResponse<any, any>>;
376
+ type GetSessionsInFolder_Session = {
377
+ session_id: string;
378
+ scene_id: string;
379
+ scene_name: string;
380
+ folder_id: string;
381
+ max_users: number;
382
+ created_at: string;
383
+ country_code: string;
384
+ continent_code: string;
385
+ clients: Array<GetSessionsInFolder_UserInfo>;
386
+ };
387
+ type GetSessionsInFolder_UserInfo = {
388
+ client_id?: string;
389
+ client_type?: 'user' | 'guest';
390
+ user_id: string;
391
+ username: string;
392
+ };
393
+ declare function getSessionsInFolder({ folder_id }: {
394
+ folder_id: string;
395
+ }): Promise<Array<GetSessionsInFolder_Session>>;
396
+ type ListSourceFiles_SourceFile = {
397
+ source_file_id?: string;
398
+ upload_task_id?: string;
399
+ source_file_original_name?: string;
400
+ source_file_name?: string;
401
+ size?: number;
402
+ };
403
+ declare function listSourceFiles({ offset, limit }: {
404
+ offset: number;
405
+ limit: number;
406
+ }): Promise<Array<ListSourceFiles_SourceFile>>;
407
+ declare function deleteSourceFiles({ source_file_ids }: {
408
+ source_file_ids: Array<string>;
409
+ }): Promise<axios.AxiosResponse<any, any>>;
410
+ declare function downloadSourceFile({ source_file_id }: {
411
+ source_file_id: string;
412
+ }): Promise<ArrayBuffer>;
413
+ type GetSourceFileDetails_SourceFile = {
414
+ source_file_id?: string;
415
+ upload_task_id?: string;
416
+ source_file_original_name?: string;
417
+ source_file_name?: string;
418
+ size?: number;
419
+ };
420
+ declare function getSourceFileDetails({ source_file_id }: {
421
+ source_file_id: string;
422
+ }): Promise<GetSourceFileDetails_SourceFile>;
423
+ declare function updateSourceFileDetails({ source_file_id, source_file_name }: {
424
+ source_file_id: string;
425
+ source_file_name?: string;
426
+ }): Promise<axios.AxiosResponse<any, any>>;
427
+ type GetSourceFileAssets_asset_list = {
428
+ animations?: Array<GetSourceFileAssets_asset_item>;
429
+ animationGraphs?: Array<GetSourceFileAssets_asset_item>;
430
+ animationSequences?: Array<GetSourceFileAssets_asset_item>;
431
+ animationSets?: Array<GetSourceFileAssets_asset_item>;
432
+ cubemaps?: Array<GetSourceFileAssets_asset_item>;
433
+ eventMaps?: Array<GetSourceFileAssets_asset_item>;
434
+ materials?: Array<GetSourceFileAssets_asset_item>;
435
+ meshes?: Array<GetSourceFileAssets_asset_item>;
436
+ pointClouds?: Array<GetSourceFileAssets_asset_item>;
437
+ renderGraphs?: Array<GetSourceFileAssets_asset_item>;
438
+ scenes?: Array<GetSourceFileAssets_asset_item>;
439
+ scripts?: Array<GetSourceFileAssets_asset_item>;
440
+ shaders?: Array<GetSourceFileAssets_asset_item>;
441
+ skeletons?: Array<GetSourceFileAssets_asset_item>;
442
+ sounds?: Array<GetSourceFileAssets_asset_item>;
443
+ textures?: Array<GetSourceFileAssets_asset_item>;
444
+ volumeMaterials?: Array<GetSourceFileAssets_asset_item>;
445
+ };
446
+ type GetSourceFileAssets_asset_item = {
447
+ asset_id?: string;
448
+ asset_name?: string;
449
+ };
450
+ declare function getSourceFileAssets({ source_file_id }: {
451
+ source_file_id: string;
452
+ }): Promise<GetSourceFileAssets_asset_list>;
453
+ type GetUploadTask_UploadTask = {
454
+ upload_task_id?: string;
455
+ folder_id?: string;
456
+ uploaded_at?: string;
457
+ uploaded_by?: string;
458
+ progress?: number;
459
+ status?: string;
460
+ conversion_tasks?: Array<GetUploadTask_ConversionTask>;
461
+ };
462
+ type GetUploadTask_ConversionTask = {
463
+ source_file_id?: string;
464
+ conversion_pipeline?: string;
465
+ progress?: number;
466
+ status?: string;
467
+ };
468
+ declare function getUploadTask({ upload_task_id }: {
469
+ upload_task_id: string;
470
+ }): Promise<GetUploadTask_UploadTask>;
471
+ type ListAssets_asset_list = {
472
+ animations?: Array<ListAssets_asset_item>;
473
+ animationGraphs?: Array<ListAssets_asset_item>;
474
+ animationSequences?: Array<ListAssets_asset_item>;
475
+ animationSets?: Array<ListAssets_asset_item>;
476
+ cubemaps?: Array<ListAssets_asset_item>;
477
+ eventMaps?: Array<ListAssets_asset_item>;
478
+ materials?: Array<ListAssets_asset_item>;
479
+ meshes?: Array<ListAssets_asset_item>;
480
+ pointClouds?: Array<ListAssets_asset_item>;
481
+ renderGraphs?: Array<ListAssets_asset_item>;
482
+ scenes?: Array<ListAssets_asset_item>;
483
+ scripts?: Array<ListAssets_asset_item>;
484
+ shaders?: Array<ListAssets_asset_item>;
485
+ skeletons?: Array<ListAssets_asset_item>;
486
+ sounds?: Array<ListAssets_asset_item>;
487
+ textures?: Array<ListAssets_asset_item>;
488
+ volumeMaterials?: Array<ListAssets_asset_item>;
489
+ };
490
+ type ListAssets_asset_item = {
491
+ asset_id?: string;
492
+ asset_name?: string;
493
+ };
494
+ declare function listAssets({ offset, limit }: {
495
+ offset: number;
496
+ limit: number;
497
+ }): Promise<ListAssets_asset_list>;
498
+ declare function deleteAssets({ asset_ids }: {
499
+ asset_ids: Array<string>;
500
+ }): Promise<axios.AxiosResponse<any, any>>;
501
+ declare function deleteAsset({ asset_container, asset_id }: {
502
+ asset_container: "animations" | "animationGraphs" | "animationSequences" | "animationSets" | "cubemaps" | "eventMaps" | "materials" | "meshes" | "pointClouds" | "renderGraphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "volumeMaterials";
503
+ asset_id: string;
504
+ }): Promise<axios.AxiosResponse<any, any>>;
505
+ type GetAssetSourceFile_SourceFile = {
506
+ source_file_id?: string;
507
+ upload_task_id?: string;
508
+ source_file_original_name?: string;
509
+ source_file_name?: string;
510
+ size?: number;
511
+ };
512
+ declare function getAssetSourceFile({ asset_container, asset_id }: {
513
+ asset_container: "animations" | "animationGraphs" | "animationSequences" | "animationSets" | "cubemaps" | "eventMaps" | "materials" | "meshes" | "pointClouds" | "renderGraphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "volumeMaterials";
514
+ asset_id: string;
515
+ }): Promise<GetAssetSourceFile_SourceFile>;
516
+ type GetAssetDetails_asset_details = {
517
+ type?: string;
518
+ asset_id?: string;
519
+ name?: string;
520
+ created_at?: string;
521
+ created_by?: GetAssetDetails_User_UserInfo;
522
+ last_edited_at?: string;
523
+ last_edited_by?: GetAssetDetails_User_UserInfo;
524
+ contributors?: Array<GetAssetDetails_UserContribution>;
525
+ };
526
+ type GetAssetDetails_User_UserInfo = {
527
+ user_id: string;
528
+ username: string;
529
+ registered_at?: string;
530
+ };
531
+ type GetAssetDetails_UserContribution = {
532
+ user?: GetAssetDetails_User_UserInfo;
533
+ contribution_count?: number;
534
+ };
535
+ declare function getAssetDetails({ asset_container, asset_id }: {
536
+ asset_container: "animations" | "animationGraphs" | "animationSequences" | "animationSets" | "cubemaps" | "eventMaps" | "materials" | "meshes" | "pointClouds" | "renderGraphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "volumeMaterials";
537
+ asset_id: string;
538
+ }): Promise<GetAssetDetails_asset_details>;
539
+ type GetAssetFolder_Folder = {
540
+ folder_id: string;
541
+ parent_folder_id?: string;
542
+ folder_name: string;
543
+ created_at?: string;
544
+ created_by?: GetAssetFolder_User_UserInfo;
545
+ subfolders?: Array<GetAssetFolder_Folder>;
546
+ source_file_count?: number;
547
+ asset_count?: number;
548
+ };
549
+ type GetAssetFolder_User_UserInfo = {
550
+ user_id: string;
551
+ username: string;
552
+ registered_at?: string;
553
+ };
554
+ declare function getAssetFolder({ asset_container, asset_id }: {
555
+ asset_container: "animations" | "animationGraphs" | "animationSequences" | "animationSets" | "cubemaps" | "eventMaps" | "materials" | "meshes" | "pointClouds" | "renderGraphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "volumeMaterials";
556
+ asset_id: string;
557
+ }): Promise<GetAssetFolder_Folder>;
558
+ type GetAssetDependencies_Object = {
559
+ type?: Array<string>;
560
+ };
561
+ declare function getAssetDependencies({ asset_container, asset_id, format, depth, filter }: {
562
+ asset_container: "animations" | "animationGraphs" | "animationSequences" | "animationSets" | "cubemaps" | "eventMaps" | "materials" | "meshes" | "pointClouds" | "renderGraphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "volumeMaterials";
563
+ asset_id: string;
564
+ format: 'flat' | 'graph';
565
+ depth: 'all' | 'direct';
566
+ filter?: GetAssetDependencies_Object;
567
+ }): Promise<GetAssetDependencies_Object>;
568
+ type GetAssetReferences_Object = {};
569
+ declare function getAssetReferences({ asset_container, asset_id }: {
570
+ asset_container: "animations" | "animationGraphs" | "animationSequences" | "animationSets" | "cubemaps" | "eventMaps" | "materials" | "meshes" | "pointClouds" | "renderGraphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "volumeMaterials";
571
+ asset_id: string;
572
+ }): Promise<GetAssetReferences_Object>;
573
+ type GetAssetDescription_Object = {};
574
+ declare function getAssetDescription({ asset_container, asset_id }: {
575
+ asset_container: "animations" | "animationGraphs" | "animationSequences" | "animationSets" | "cubemaps" | "eventMaps" | "materials" | "meshes" | "pointClouds" | "renderGraphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "volumeMaterials";
576
+ asset_id: string;
577
+ }): Promise<GetAssetDescription_Object>;
578
+ declare function updateAssetDescription({ asset_container, asset_id, name }: {
579
+ asset_container: "animations" | "animationGraphs" | "animationSequences" | "animationSets" | "cubemaps" | "eventMaps" | "materials" | "meshes" | "pointClouds" | "renderGraphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "volumeMaterials";
580
+ asset_id: string;
581
+ name?: string;
582
+ }): Promise<axios.AxiosResponse<any, any>>;
583
+ declare function getAssetPayload({ asset_container_with_payload, asset_id }: {
584
+ asset_container_with_payload: "animations" | "animationSequences" | "meshes" | "pointClouds" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures";
585
+ asset_id: string;
586
+ }): Promise<ArrayBuffer>;
587
+ type GetAssetHistory_Object = {};
588
+ declare function getAssetHistory({ asset_container, asset_id }: {
589
+ asset_container: "animations" | "animationGraphs" | "animationSequences" | "animationSets" | "cubemaps" | "eventMaps" | "materials" | "meshes" | "pointClouds" | "renderGraphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "volumeMaterials";
590
+ asset_id: string;
591
+ }): Promise<GetAssetHistory_Object>;
592
+ type GetAssetMeta_Object = {};
593
+ declare function getAssetMeta({ asset_container, asset_id }: {
594
+ asset_container: "animations" | "animationGraphs" | "animationSequences" | "animationSets" | "cubemaps" | "eventMaps" | "materials" | "meshes" | "pointClouds" | "renderGraphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "volumeMaterials";
595
+ asset_id: string;
596
+ }): Promise<GetAssetMeta_Object>;
597
+ declare function getAssetCode({ asset_container_with_code, asset_id }: {
598
+ asset_container_with_code: "animationSequences" | "scripts" | "shaders";
599
+ asset_id: string;
600
+ }): Promise<string>;
601
+ declare function getAssetThumbnail({ asset_container, asset_id, size, default_url }: {
602
+ asset_container: "animations" | "animationGraphs" | "animationSequences" | "animationSets" | "cubemaps" | "eventMaps" | "materials" | "meshes" | "pointClouds" | "renderGraphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "volumeMaterials";
603
+ asset_id: string;
604
+ size: "large" | "medium" | "small" | "tiny";
605
+ default_url?: string;
606
+ }): Promise<axios.AxiosResponse<any, any>>;
607
+ declare function setAssetThumbnail({ asset_container, asset_id, body }: {
608
+ asset_container: "animations" | "animationGraphs" | "animationSequences" | "animationSets" | "cubemaps" | "eventMaps" | "materials" | "meshes" | "pointClouds" | "renderGraphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "volumeMaterials";
609
+ asset_id: string;
610
+ body: ArrayBuffer;
611
+ }, contentType: 'image/jpg' | 'image/png'): Promise<axios.AxiosResponse<any, any>>;
612
+ type GetAssetCustomTypes_Object = {};
613
+ declare function getAssetCustomTypes({ asset_container_with_custom_types, asset_id }: {
614
+ asset_container_with_custom_types: "modules";
615
+ asset_id: string;
616
+ }): Promise<GetAssetCustomTypes_Object>;
617
+ declare function packageAsset({ asset_container, asset_id }: {
618
+ asset_container: "animations" | "animationGraphs" | "animationSequences" | "animationSets" | "cubemaps" | "eventMaps" | "materials" | "meshes" | "pointClouds" | "renderGraphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "volumeMaterials";
619
+ asset_id: string;
620
+ }): Promise<ArrayBuffer>;
621
+ declare function exportAsset({ asset_container_exportable, asset_id, format, scale }: {
622
+ asset_container_exportable: "meshes" | "sounds";
623
+ asset_id: string;
624
+ format: "obj" | "stl";
625
+ scale: number;
626
+ }): Promise<ArrayBuffer>;
627
+ type GetSceneSessions_Session = {
628
+ session_id: string;
629
+ scene_id: string;
630
+ scene_name: string;
631
+ folder_id: string;
632
+ max_users: number;
633
+ created_at: string;
634
+ country_code: string;
635
+ continent_code: string;
636
+ clients: Array<GetSceneSessions_UserInfo>;
637
+ };
638
+ type GetSceneSessions_UserInfo = {
639
+ client_id?: string;
640
+ client_type?: 'user' | 'guest';
641
+ user_id: string;
642
+ username: string;
643
+ };
644
+ declare function getSceneSessions({ scene_id }: {
645
+ scene_id: string;
646
+ }): Promise<Array<GetSceneSessions_Session>>;
647
+ type GetSceneAabb_Object = {
648
+ max?: Array<number>;
649
+ min?: Array<number>;
650
+ };
651
+ declare function getSceneAABB({ scene_id }: {
652
+ scene_id: string;
653
+ }): Promise<GetSceneAabb_Object>;
654
+ type GetEntity_entity = {
655
+ animation_controller?: GetEntity_animation_controller;
656
+ bone?: GetEntity_bone;
657
+ box_geometry?: GetEntity_box_geometry;
658
+ camera?: GetEntity_camera;
659
+ capsule_geometry?: GetEntity_capsule_geometry;
660
+ character_controller?: GetEntity_character_controller;
661
+ collision_geometry_ref?: GetEntity_collision_geometry_ref;
662
+ cylinder_geometry?: GetEntity_cylinder_geometry;
663
+ debug_name?: GetEntity_debug_name;
664
+ decal_projector?: GetEntity_decal_projector;
665
+ environment?: GetEntity_environment;
666
+ euid: GetEntity_euid;
667
+ joint?: GetEntity_joint;
668
+ lineage?: GetEntity_lineage;
669
+ local_aabb?: GetEntity_local_aabb;
670
+ local_transform?: GetEntity_local_transform;
671
+ material?: GetEntity_material;
672
+ material_ref?: GetEntity_material_ref;
673
+ mesh_ref?: GetEntity_mesh_ref;
674
+ orthographic_lens?: GetEntity_orthographic_lens;
675
+ overrider?: GetEntity_overrider;
676
+ perspective_lens?: GetEntity_perspective_lens;
677
+ physics_material?: GetEntity_physics_material;
678
+ plane_geometry?: GetEntity_plane_geometry;
679
+ point_cloud_ref?: GetEntity_point_cloud_ref;
680
+ point_light?: GetEntity_point_light;
681
+ reflection_probe?: GetEntity_reflection_probe;
682
+ revolute_joint?: GetEntity_revolute_joint;
683
+ rigid_body?: GetEntity_rigid_body;
684
+ scene_ref?: GetEntity_scene_ref;
685
+ script_element?: GetEntity_script_element;
686
+ script_map?: GetEntity_script_map;
687
+ shadow_caster?: GetEntity_shadow_caster;
688
+ skeleton_ref?: GetEntity_skeleton_ref;
689
+ sound_ref?: GetEntity_sound_ref;
690
+ sphere_geometry?: GetEntity_sphere_geometry;
691
+ spot_light?: GetEntity_spot_light;
692
+ stereoscopic_lens?: GetEntity_stereoscopic_lens;
693
+ tags?: GetEntity_tags;
694
+ volume_filter?: GetEntity_volume_filter;
695
+ volume_material_ref?: GetEntity_volume_material_ref;
696
+ volume_ref?: GetEntity_volume_ref;
697
+ };
698
+ type GetEntity_animation_controller = {
699
+ animationGraphRef?: string;
700
+ animationSetRef?: string;
701
+ dataJSON?: GetEntity_json;
702
+ rootBoneEntityRef?: GetEntity_entity_ref;
703
+ rootMotionEnabled?: boolean;
704
+ };
705
+ type GetEntity_json = {};
706
+ type GetEntity_entity_ref = {
707
+ originalEUID: string;
708
+ linkage: Array<string>;
709
+ };
710
+ type GetEntity_bone = {
711
+ boneIndex?: number;
712
+ };
713
+ type GetEntity_box_geometry = {
714
+ dimension?: Array<number>;
715
+ isAdditive?: boolean;
716
+ offset?: Array<number>;
717
+ };
718
+ type GetEntity_camera = {
719
+ renderGraphRef?: string;
720
+ renderTargetIndex?: number;
721
+ dataJSON?: GetEntity_json;
722
+ };
723
+ type GetEntity_capsule_geometry = {
724
+ radius?: number;
725
+ height?: number;
726
+ axis?: number;
727
+ isAdditive?: boolean;
728
+ offset?: Array<number>;
729
+ };
730
+ type GetEntity_character_controller = {
731
+ stepOffset?: number;
732
+ slopeLimit?: number;
733
+ skinWidth?: number;
734
+ velocity?: Array<number>;
735
+ };
736
+ type GetEntity_collision_geometry_ref = {
737
+ collisionGeometryRef?: string;
738
+ };
739
+ type GetEntity_cylinder_geometry = {
740
+ radius?: number;
741
+ height?: number;
742
+ axis?: number;
743
+ isAdditive?: boolean;
744
+ offset?: Array<number>;
745
+ };
746
+ type GetEntity_debug_name = {
747
+ value?: string;
748
+ };
749
+ type GetEntity_decal_projector = {
750
+ zIndex?: number;
751
+ };
752
+ type GetEntity_environment = {
753
+ skyboxUUID?: string;
754
+ radianceUUID?: string;
755
+ irradianceUUID?: string;
756
+ };
757
+ type GetEntity_euid = {
758
+ value?: string;
759
+ };
760
+ type GetEntity_joint = {
761
+ constrainee?: GetEntity_entity_ref;
762
+ constrainer?: GetEntity_entity_ref;
763
+ breakForce?: number;
764
+ breakTorque?: number;
765
+ };
766
+ type GetEntity_lineage = {
767
+ parentUUID?: string;
768
+ ordinal?: number;
769
+ };
770
+ type GetEntity_local_aabb = {
771
+ min?: Array<number>;
772
+ max?: Array<number>;
773
+ };
774
+ type GetEntity_local_transform = {
775
+ position?: Array<number>;
776
+ orientation?: Array<number>;
777
+ scale?: Array<number>;
778
+ eulerOrientation?: Array<number>;
779
+ globalEulerOrientation?: Array<number>;
780
+ };
781
+ type GetEntity_material = {
782
+ shaderRef?: string;
783
+ transparencyMode?: number;
784
+ isDoubleSided?: boolean;
785
+ dataJSON?: GetEntity_json;
786
+ };
787
+ type GetEntity_material_ref = {
788
+ value?: string;
789
+ faceCulling?: number;
790
+ };
791
+ type GetEntity_mesh_ref = {
792
+ value?: string;
793
+ submeshIndex?: number;
794
+ };
795
+ type GetEntity_orthographic_lens = {
796
+ left?: number;
797
+ right?: number;
798
+ top?: number;
799
+ bottom?: number;
800
+ zNear?: number;
801
+ zFar?: number;
802
+ };
803
+ type GetEntity_overrider = {
804
+ deleter?: boolean;
805
+ entityRef?: GetEntity_entity_ref;
806
+ componentsToDetach?: Array<number>;
807
+ };
808
+ type GetEntity_perspective_lens = {
809
+ aspectRatio?: number;
810
+ fovy?: number;
811
+ nearPlane?: number;
812
+ farPlane?: number;
813
+ };
814
+ type GetEntity_physics_material = {
815
+ staticFriction?: number;
816
+ dynamicFriction?: number;
817
+ restitution?: number;
818
+ isTrigger?: boolean;
819
+ };
820
+ type GetEntity_plane_geometry = {
821
+ distance?: number;
822
+ normal?: Array<number>;
823
+ };
824
+ type GetEntity_point_cloud_ref = {
825
+ value?: string;
826
+ };
827
+ type GetEntity_point_light = {
828
+ color?: Array<number>;
829
+ intensity?: number;
830
+ range?: number;
831
+ isDirectional?: boolean;
832
+ isSun?: boolean;
833
+ };
834
+ type GetEntity_reflection_probe = {
835
+ offset?: Array<number>;
836
+ nearDist?: number;
837
+ farDist?: number;
838
+ quality?: number;
839
+ };
840
+ type GetEntity_revolute_joint = {
841
+ axis?: Array<number>;
842
+ anchor?: Array<number>;
843
+ };
844
+ type GetEntity_rigid_body = {
845
+ mass?: number;
846
+ linearDamping?: number;
847
+ angularDamping?: number;
848
+ friction?: number;
849
+ rollingFriction?: number;
850
+ spinningFriction?: number;
851
+ restitution?: number;
852
+ linearSleepingThreshold?: number;
853
+ angularSleepingThreshold?: number;
854
+ isKinematic?: boolean;
855
+ };
856
+ type GetEntity_scene_ref = {
857
+ value?: string;
858
+ maxRecursionCount?: number;
859
+ };
860
+ type GetEntity_script_element = {
861
+ scriptRef?: string;
862
+ dataJSON?: GetEntity_json;
863
+ };
864
+ type GetEntity_script_map = {
865
+ elements?: GetEntity_map_script_element;
866
+ };
867
+ type GetEntity_map_script_element = {};
868
+ type GetEntity_shadow_caster = {
869
+ bias?: number;
870
+ nearDist?: number;
871
+ farDist?: number;
872
+ quality?: number;
873
+ accumulateShadowCascades?: boolean;
874
+ };
875
+ type GetEntity_skeleton_ref = {
876
+ value?: string;
877
+ };
878
+ type GetEntity_sound_ref = {
879
+ value?: string;
880
+ volume?: number;
881
+ pan?: number;
882
+ playSpeed?: number;
883
+ looping?: boolean;
884
+ };
885
+ type GetEntity_sphere_geometry = {
886
+ radius?: number;
887
+ isAdditive?: boolean;
888
+ offset?: Array<number>;
889
+ };
890
+ type GetEntity_spot_light = {
891
+ cutoff?: number;
892
+ IESProfile?: string;
893
+ };
894
+ type GetEntity_stereoscopic_lens = {
895
+ angleLeft?: number;
896
+ angleRight?: number;
897
+ angleUp?: number;
898
+ angleDown?: number;
899
+ nearPlane?: number;
900
+ farPlane?: number;
901
+ aspectRatio?: number;
902
+ };
903
+ type GetEntity_tags = {
904
+ value?: Array<string>;
905
+ };
906
+ type GetEntity_volume_filter = {
907
+ range?: Array<number>;
908
+ applyGaussianFiltering?: boolean;
909
+ sampleUnfiltered?: boolean;
910
+ enableMPR?: boolean;
911
+ enable3D?: boolean;
912
+ };
913
+ type GetEntity_volume_material_ref = {
914
+ value?: string;
915
+ };
916
+ type GetEntity_volume_ref = {
917
+ texture3dRef?: string;
918
+ };
919
+ declare function getEntity({ scene_id, entity_id, compute_global_transform }: {
920
+ scene_id: string;
921
+ entity_id: string;
922
+ compute_global_transform: boolean;
923
+ }): Promise<GetEntity_entity>;
924
+ type CreateSession_Object = {
925
+ session_id?: string;
926
+ };
927
+ declare function createSession({ scene_id }: {
928
+ scene_id?: string;
929
+ }): Promise<CreateSession_Object>;
930
+ declare function killSession({ session_id }: {
931
+ session_id: string;
932
+ }): Promise<axios.AxiosResponse<any, any>>;
933
+ type JoinSession_SessionToken = {
934
+ session_token?: string;
935
+ endpoint_info?: JoinSession_Object;
936
+ };
937
+ type JoinSession_Object = {
938
+ ip?: string;
939
+ port?: number;
940
+ ssl_port?: number;
941
+ };
942
+ declare function joinSession({ session_id }: {
943
+ session_id: string;
944
+ }): Promise<JoinSession_SessionToken>;
945
+ declare function kickClientFromSession({ session_id, client_id }: {
946
+ session_id: string;
947
+ client_id: string;
948
+ }): Promise<axios.AxiosResponse<any, any>>;
949
+
950
+ declare function setApiKey(apiKey: string): void;
951
+ declare function setUserToken(userToken: string): void;
952
+ declare function setBaseUrl(url: string): void;
953
+
954
+ export { ApiError, CreateAsset_AssetDescription, CreateAsset_Object, CreateFolder_Folder, CreateGroup_GroupMember_GroupAccess, CreateGroup_Group_GroupInfo, CreateSession_Object, CreateSubfolder_Folder, DeleteUser_Object, DeleteUser_asset_item, DeleteUser_asset_list, GenerateUserToken_Token, GetAssetCustomTypes_Object, GetAssetDependencies_Object, GetAssetDescription_Object, GetAssetDetails_UserContribution, GetAssetDetails_User_UserInfo, GetAssetDetails_asset_details, GetAssetFolder_Folder, GetAssetFolder_User_UserInfo, GetAssetHistory_Object, GetAssetMeta_Object, GetAssetReferences_Object, GetAssetSourceFile_SourceFile, 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_entity, GetEntity_entity_ref, GetEntity_environment, GetEntity_euid, GetEntity_joint, GetEntity_json, GetEntity_lineage, GetEntity_local_aabb, GetEntity_local_transform, GetEntity_map_script_element, 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, GetFolderAssets_asset_item, GetFolderAssets_asset_list, GetFolderInfo_Folder, GetFolderInfo_User_UserInfo, GetGroup_GroupMember_GroupAccess, GetGroup_Group_GroupInfo, GetSceneAabb_Object, GetSceneSessions_Session, GetSceneSessions_UserInfo, GetSessionsInFolder_Session, GetSessionsInFolder_UserInfo, GetSourceFileAssets_asset_item, GetSourceFileAssets_asset_list, GetSourceFileDetails_SourceFile, GetSourceFilesInFolder_SourceFile, GetUploadTask_ConversionTask, GetUploadTask_UploadTask, GetUploadTasksInFolder_ConversionTask, GetUploadTasksInFolder_UploadTask, GetUserGroups_GroupMember_GroupAccess, GetUserGroups_Group_GroupInfo, GetUserUploadTasks_ConversionTask, GetUserUploadTasks_UploadTask, GetUser_User_UserInfo, JoinSession_Object, JoinSession_SessionToken, ListAssets_asset_item, ListAssets_asset_list, ListFolderAccesses_GroupInfo_FolderAccess, ListFolderAccesses_Object, ListFolderAccesses_UserInfo_FolderAccess, ListFolderSubFolders_Folder, ListFolderSubFolders_User_UserInfo, ListFolders_Folder, ListFolders_User_UserInfo, ListSourceFiles_SourceFile, ListUsers_User_UserInfo, RegisterUser_User_UserInfo, UploadSourceFiles_Object, axiosInstance, createAsset, createFolder, createGroup, createSession, createSubfolder, deleteAsset, deleteAssets, deleteFolder, deleteGroup, deleteSourceFiles, deleteUser, downloadSourceFile, exportAsset, generateUserToken, getAssetCode, getAssetCustomTypes, getAssetDependencies, getAssetDescription, getAssetDetails, getAssetFolder, getAssetHistory, getAssetMeta, getAssetPayload, getAssetReferences, getAssetSourceFile, getAssetThumbnail, getEntity, getFolderAssets, getFolderInfo, getGroup, getSceneAABB, getSceneSessions, getSessionsInFolder, getSourceFileAssets, getSourceFileDetails, getSourceFilesInFolder, getUploadTask, getUploadTasksInFolder, getUser, getUserGroups, getUserUploadTasks, grantMemberAccessToFolder, grantMemberAccessToGroup, joinSession, kickClientFromSession, killSession, listAssets, listFolderAccesses, listFolderSubFolders, listFolders, listSourceFiles, listUsers, moveAssets, moveFolders, moveSourceFiles, packageAsset, registerUser, revokeMemberAccessToFolder, revokeMemberAccessToGroup, setApiKey, setAssetThumbnail, setBaseUrl, setUserToken, updateAssetDescription, updateFolder, updateGroupDescription, updateSourceFileDetails, updateUser, uploadSourceFiles };