@3dverse/api 0.0.1 → 0.0.3

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