@3dverse/api 0.8.9 → 0.8.11
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.
- package/dist/_prebuild/wrapper.d.ts +80 -75
- package/dist/index.js +8 -4
- package/dist/index.js.map +2 -2
- package/dist/index.mjs +5 -1
- package/dist/index.mjs.map +2 -2
- package/package.json +6 -6
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
2
|
+
* Asset API v1.0
|
|
3
|
+
* ## Getting Started
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
*This is the reference for the REST API endpoints.
|
|
6
6
|
*
|
|
7
|
-
|
|
7
|
+
*### NPM package
|
|
8
8
|
*
|
|
9
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
|
-
|
|
11
|
+
*### Authentication
|
|
12
12
|
*
|
|
13
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
14
|
*Alternatively, you can create a user, generate a token for the user and authenticate with a `user_token`.
|
|
@@ -69,7 +69,7 @@ export declare function getUser({ user_id, }: {
|
|
|
69
69
|
export declare function updateUser({ user_id, username, }: {
|
|
70
70
|
user_id: string;
|
|
71
71
|
username: string;
|
|
72
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
72
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
73
73
|
export type DeleteUser_Object = {
|
|
74
74
|
deleted_assets?: DeleteUser_Object;
|
|
75
75
|
};
|
|
@@ -193,13 +193,13 @@ export declare function updateGroupDescription({ group_id, name, description, }:
|
|
|
193
193
|
group_id: string;
|
|
194
194
|
name: string;
|
|
195
195
|
description: string;
|
|
196
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
196
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
197
197
|
/**
|
|
198
198
|
* Deletes a group and all its access rights.
|
|
199
199
|
*/
|
|
200
200
|
export declare function deleteGroup({ group_id, }: {
|
|
201
201
|
group_id: string;
|
|
202
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
202
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
203
203
|
/**
|
|
204
204
|
* Grants member access to the group.
|
|
205
205
|
*/
|
|
@@ -209,7 +209,7 @@ export declare function grantMemberAccessToGroup({ group_id, member_type, member
|
|
|
209
209
|
member_id: string;
|
|
210
210
|
group_access: 'read' | 'write' | 'manage';
|
|
211
211
|
folder_access: 'read' | 'write' | 'manage';
|
|
212
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
212
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
213
213
|
/**
|
|
214
214
|
* Revoke requested user access to group.
|
|
215
215
|
*/
|
|
@@ -217,7 +217,7 @@ export declare function revokeMemberAccessToGroup({ group_id, member_type, membe
|
|
|
217
217
|
group_id: string;
|
|
218
218
|
member_type: 'users' | 'groups';
|
|
219
219
|
member_id: string;
|
|
220
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
220
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
221
221
|
export type ListFolders_Folder = {
|
|
222
222
|
folder_id: string;
|
|
223
223
|
parent_folder_id?: string;
|
|
@@ -293,20 +293,20 @@ export declare function getFolderInfo({ folder_id, }: {
|
|
|
293
293
|
export declare function moveFolders({ folder_id, folder_ids, }: {
|
|
294
294
|
folder_id: string;
|
|
295
295
|
folder_ids: Array<string>;
|
|
296
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
296
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
297
297
|
/**
|
|
298
298
|
* Updates the folder details.
|
|
299
299
|
*/
|
|
300
300
|
export declare function updateFolder({ folder_id, name, }: {
|
|
301
301
|
folder_id: string;
|
|
302
302
|
name?: string;
|
|
303
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
303
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
304
304
|
/**
|
|
305
305
|
* Deletes the requested folder. The target folder must be empty.
|
|
306
306
|
*/
|
|
307
307
|
export declare function deleteFolder({ folder_id, }: {
|
|
308
308
|
folder_id: string;
|
|
309
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
309
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
310
310
|
export type ListFolderAccesses_Object = {
|
|
311
311
|
users?: Array<ListFolderAccesses_UserInfo_FolderAccess>;
|
|
312
312
|
groups?: Array<ListFolderAccesses_GroupInfo_FolderAccess>;
|
|
@@ -335,7 +335,7 @@ export declare function grantMemberAccessToFolder({ folder_id, member_type, memb
|
|
|
335
335
|
member_type: 'users' | 'groups';
|
|
336
336
|
member_id: string;
|
|
337
337
|
access: 'read' | 'write' | 'manage';
|
|
338
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
338
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
339
339
|
/**
|
|
340
340
|
* Revokes member access to a target folder.
|
|
341
341
|
*/
|
|
@@ -343,7 +343,7 @@ export declare function revokeMemberAccessToFolder({ folder_id, member_type, mem
|
|
|
343
343
|
folder_id: string;
|
|
344
344
|
member_type: 'users' | 'groups';
|
|
345
345
|
member_id: string;
|
|
346
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
346
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
347
347
|
export type CreateSubfolder_Folder = {
|
|
348
348
|
name: string;
|
|
349
349
|
subfolders?: Array<CreateSubfolder_Folder>;
|
|
@@ -397,6 +397,14 @@ export type UploadSourceFiles_Object = {
|
|
|
397
397
|
};
|
|
398
398
|
/**
|
|
399
399
|
* Uploads the specified source file(s).
|
|
400
|
+
* The supported file formats are:
|
|
401
|
+
* - Scene :
|
|
402
|
+
* - Mesh : `fbx, obj/mtl, stl, ply, ifc, usd, usda, usdc, usdz, skp, ptf, 3ds, 3mf, ac, ac3d, acc, amj, ase, ask, b3d, blend, bvh, cms, cob, dae, dxf, gltf/bin, glb, enff, hmb, irr, irrmesh, lwo, lws, lxo, m3d, md2, md3, md5, mdc, mdl, xml, mot, ms3d, ndo, nff, off, ogex, pmx, prj, q3o, q3s, raw, scn, sib, smd, ter, uc, vta, wrl, x, x3d, xgl, zgl`
|
|
403
|
+
* - Point cloud : `e57, ptx, xyz, las, laz`
|
|
404
|
+
* - Volume : `dcm`
|
|
405
|
+
* - Texture : `jpg, jpeg, png, tga, dds, tif, tiff, bmp, rgbe`
|
|
406
|
+
* - Cubemap : `hdr`
|
|
407
|
+
* - Sound : `wav, mp3, ogg, flac`.
|
|
400
408
|
*/
|
|
401
409
|
export declare function uploadSourceFiles({ folder_id, body, }: {
|
|
402
410
|
folder_id: string;
|
|
@@ -426,7 +434,7 @@ export declare function getSourceFilesInFolder({ folder_id, offset, limit, filte
|
|
|
426
434
|
export declare function moveSourceFiles({ folder_id, source_file_ids, }: {
|
|
427
435
|
folder_id: string;
|
|
428
436
|
source_file_ids: Array<string>;
|
|
429
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
437
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
430
438
|
export type GetUploadTasksInFolder_UploadTask = {
|
|
431
439
|
upload_task_id: string;
|
|
432
440
|
folder_id: string;
|
|
@@ -459,7 +467,7 @@ export declare function getUploadTasksInFolder({ folder_id, offset, limit, }: {
|
|
|
459
467
|
}, headers?: AxiosRequestHeaders): AxiosPromise<Array<GetUploadTasksInFolder_UploadTask>>;
|
|
460
468
|
export type GetFolderAssets_Filters = {
|
|
461
469
|
asset_name?: string;
|
|
462
|
-
asset_type?: Array<'action_map' | '
|
|
470
|
+
asset_type?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'> | 'action_map' | '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
471
|
source_file?: Array<string> | string | 'exclude';
|
|
464
472
|
};
|
|
465
473
|
export type GetFolderAssets_AssetCount = {
|
|
@@ -468,7 +476,6 @@ export type GetFolderAssets_AssetCount = {
|
|
|
468
476
|
};
|
|
469
477
|
export type GetFolderAssets__index_AssetList_AssetList = {
|
|
470
478
|
action_maps?: Array<GetFolderAssets_Object>;
|
|
471
|
-
algorithms?: Array<GetFolderAssets_Object>;
|
|
472
479
|
animation_graphs?: Array<GetFolderAssets_Object>;
|
|
473
480
|
animation_sequences?: Array<GetFolderAssets_Object>;
|
|
474
481
|
animation_sets?: Array<GetFolderAssets_Object>;
|
|
@@ -506,17 +513,17 @@ export declare function getFolderAssets({ folder_id, offset, limit, filter, recu
|
|
|
506
513
|
recursive?: boolean;
|
|
507
514
|
}, headers?: AxiosRequestHeaders): AxiosPromise<GetFolderAssets__index_AssetList_AssetList>;
|
|
508
515
|
export type CreateAsset_NewAsset = {
|
|
509
|
-
asset_type: 'action_map' | '
|
|
516
|
+
asset_type: 'action_map' | 'animation_graph' | 'animation_sequence' | 'cubemap' | 'event_map' | 'material' | 'module' | 'render_graph' | 'scene' | 'script' | 'shader' | 'volume_material';
|
|
510
517
|
name: string;
|
|
511
518
|
};
|
|
512
519
|
export type CreateAsset_AssetDuplication = {
|
|
513
|
-
asset_type: 'action_map' | '
|
|
520
|
+
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
514
521
|
copy_from_asset_id: string;
|
|
515
522
|
new_asset_name?: string;
|
|
516
523
|
options?: CreateAsset_DuplicationOptions;
|
|
517
524
|
};
|
|
518
525
|
export type CreateAsset_DuplicationOptions = {
|
|
519
|
-
asset_types?: Array<'action_map' | '
|
|
526
|
+
asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
520
527
|
max_depth?: number;
|
|
521
528
|
};
|
|
522
529
|
export type CreateAsset_AssetDuplicationResult = {
|
|
@@ -540,7 +547,7 @@ export declare function createAsset({ folder_id, asset_creation_options, }: {
|
|
|
540
547
|
export declare function moveAssets({ folder_id, asset_ids, }: {
|
|
541
548
|
folder_id: string;
|
|
542
549
|
asset_ids: Array<string>;
|
|
543
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
550
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
544
551
|
export type CreateMaterial_Object = {
|
|
545
552
|
asset_id: string;
|
|
546
553
|
};
|
|
@@ -610,7 +617,7 @@ export type ImportAssets_AssetIds = {
|
|
|
610
617
|
*/
|
|
611
618
|
export declare function importAssets({ folder_id, overwrite, body, }: {
|
|
612
619
|
folder_id: string;
|
|
613
|
-
overwrite?:
|
|
620
|
+
overwrite?: 'never' | 'only-specified' | 'always';
|
|
614
621
|
body: ArrayBuffer | ReadableStream;
|
|
615
622
|
}, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void, headers?: AxiosRequestHeaders): AxiosPromise<ImportAssets__index_ImportAssetsResponse_ImportAssetsResponse>;
|
|
616
623
|
export type GetSessionsInFolder_Session = {
|
|
@@ -628,7 +635,7 @@ export type GetSessionsInFolder_Session = {
|
|
|
628
635
|
};
|
|
629
636
|
export type GetSessionsInFolder_Client_UserInfo = {
|
|
630
637
|
client_id?: string;
|
|
631
|
-
client_type?:
|
|
638
|
+
client_type?: 'user' | 'guest';
|
|
632
639
|
user_id: string;
|
|
633
640
|
username: string;
|
|
634
641
|
};
|
|
@@ -661,7 +668,7 @@ export declare function listSourceFiles({ offset, limit, filters, }: {
|
|
|
661
668
|
export declare function deleteSourceFiles({ source_file_ids, delete_assets, }: {
|
|
662
669
|
source_file_ids: Array<string>;
|
|
663
670
|
delete_assets?: boolean;
|
|
664
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
671
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
665
672
|
/**
|
|
666
673
|
* Downloads the target source file.
|
|
667
674
|
*/
|
|
@@ -686,10 +693,9 @@ export declare function getSourceFileDetails({ source_file_id, }: {
|
|
|
686
693
|
export declare function updateSourceFileDetails({ source_file_id, name, }: {
|
|
687
694
|
source_file_id: string;
|
|
688
695
|
name: string;
|
|
689
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
696
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
690
697
|
export type GetSourceFileAssets__index_AssetList_AssetList = {
|
|
691
698
|
action_maps?: Array<GetSourceFileAssets_Object>;
|
|
692
|
-
algorithms?: Array<GetSourceFileAssets_Object>;
|
|
693
699
|
animation_graphs?: Array<GetSourceFileAssets_Object>;
|
|
694
700
|
animation_sequences?: Array<GetSourceFileAssets_Object>;
|
|
695
701
|
animation_sets?: Array<GetSourceFileAssets_Object>;
|
|
@@ -765,13 +771,12 @@ export declare function getConversionTaskMetadata<T extends 'arraybuffer' | 'str
|
|
|
765
771
|
filename: string;
|
|
766
772
|
}, headers?: AxiosRequestHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
|
767
773
|
export type ListAssets_Filter = {
|
|
768
|
-
asset_type?: Array<'action_map' | '
|
|
774
|
+
asset_type?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'> | 'action_map' | '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';
|
|
769
775
|
asset_name?: string;
|
|
770
776
|
include_public_assets?: boolean;
|
|
771
777
|
};
|
|
772
778
|
export type ListAssets__index_AssetList_AssetList = {
|
|
773
779
|
action_maps?: Array<ListAssets_Object>;
|
|
774
|
-
algorithms?: Array<ListAssets_Object>;
|
|
775
780
|
animation_graphs?: Array<ListAssets_Object>;
|
|
776
781
|
animation_sequences?: Array<ListAssets_Object>;
|
|
777
782
|
animation_sets?: Array<ListAssets_Object>;
|
|
@@ -811,14 +816,14 @@ export declare function listAssets({ offset, limit, filter, }: {
|
|
|
811
816
|
*/
|
|
812
817
|
export declare function deleteAssets({ asset_ids, }: {
|
|
813
818
|
asset_ids: Array<string>;
|
|
814
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
819
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
815
820
|
/**
|
|
816
821
|
* Deletes the asset.
|
|
817
822
|
*/
|
|
818
823
|
export declare function deleteAsset({ asset_container, asset_id, }: {
|
|
819
|
-
asset_container: 'action_maps' | '
|
|
824
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
820
825
|
asset_id: string;
|
|
821
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
826
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
822
827
|
export type GetAssetSourceFile_SourceFile = {
|
|
823
828
|
source_file_id: string;
|
|
824
829
|
source_file_original_name: string;
|
|
@@ -829,7 +834,7 @@ export type GetAssetSourceFile_SourceFile = {
|
|
|
829
834
|
* Gets the source file of the specified asset.
|
|
830
835
|
*/
|
|
831
836
|
export declare function getAssetSourceFile({ asset_container, asset_id, }: {
|
|
832
|
-
asset_container: 'action_maps' | '
|
|
837
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
833
838
|
asset_id: string;
|
|
834
839
|
}, headers?: AxiosRequestHeaders): AxiosPromise<GetAssetSourceFile_SourceFile>;
|
|
835
840
|
export type GetAssetDetails__index_AssetDetails_AssetDetails = {
|
|
@@ -840,7 +845,7 @@ export type GetAssetDetails__index_AssetDetails_AssetDetails = {
|
|
|
840
845
|
last_edited_at?: string;
|
|
841
846
|
last_edited_by?: GetAssetDetails_LastEditedBy;
|
|
842
847
|
name: string;
|
|
843
|
-
type: 'action_map' | '
|
|
848
|
+
type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
844
849
|
};
|
|
845
850
|
export type GetAssetDetails_Contributor = {
|
|
846
851
|
contribution_count: number;
|
|
@@ -860,7 +865,7 @@ export type GetAssetDetails_LastEditedBy = {
|
|
|
860
865
|
* Gets the asset details from the specified asset.
|
|
861
866
|
*/
|
|
862
867
|
export declare function getAssetDetails({ asset_container, asset_id, }: {
|
|
863
|
-
asset_container: 'action_maps' | '
|
|
868
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
864
869
|
asset_id: string;
|
|
865
870
|
}, headers?: AxiosRequestHeaders): AxiosPromise<GetAssetDetails__index_AssetDetails_AssetDetails>;
|
|
866
871
|
export type GetAssetFolder_Folder = {
|
|
@@ -882,17 +887,17 @@ export type GetAssetFolder_Object = {
|
|
|
882
887
|
* Gets the asset folder from the specified asset.
|
|
883
888
|
*/
|
|
884
889
|
export declare function getAssetFolder({ asset_container, asset_id, }: {
|
|
885
|
-
asset_container: 'action_maps' | '
|
|
890
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
886
891
|
asset_id: string;
|
|
887
892
|
}, headers?: AxiosRequestHeaders): AxiosPromise<GetAssetFolder_Folder>;
|
|
888
893
|
export type GetAssetDependencies_Filter = {
|
|
889
|
-
with_asset_types?: Array<'action_map' | '
|
|
890
|
-
without_asset_types?: Array<'action_map' | '
|
|
891
|
-
public?:
|
|
894
|
+
with_asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
895
|
+
without_asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
896
|
+
public?: 'include' | 'exclude' | 'restrict-to';
|
|
892
897
|
};
|
|
893
898
|
export type GetAssetDependencies_Asset = {
|
|
894
899
|
asset_id: string;
|
|
895
|
-
asset_type: 'action_map' | '
|
|
900
|
+
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
896
901
|
properties?: GetAssetDependencies_Object;
|
|
897
902
|
};
|
|
898
903
|
export type GetAssetDependencies_Object = {
|
|
@@ -916,17 +921,17 @@ export type GetAssetDependencies_Dependency = {
|
|
|
916
921
|
* Gets the asset dependencies from the specified asset.
|
|
917
922
|
*/
|
|
918
923
|
export declare function getAssetDependencies({ asset_container, asset_id, offset, limit, depth, filters, properties, }: {
|
|
919
|
-
asset_container: 'action_maps' | '
|
|
924
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
920
925
|
asset_id: string;
|
|
921
926
|
offset?: number;
|
|
922
927
|
limit?: number;
|
|
923
928
|
depth?: 'all' | 'direct' | number;
|
|
924
929
|
filters?: GetAssetDependencies_Filter;
|
|
925
|
-
properties?: Array<
|
|
930
|
+
properties?: Array<'name' | 'dependencies' | 'count' | 'public' | 'accessible' | 'payload_info'>;
|
|
926
931
|
}, headers?: AxiosRequestHeaders): AxiosPromise<Array<GetAssetDependencies_Asset>>;
|
|
927
932
|
export type GetAssetReferences_Asset = {
|
|
928
933
|
asset_id: string;
|
|
929
|
-
asset_type: 'action_map' | '
|
|
934
|
+
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
930
935
|
properties?: GetAssetReferences_Object;
|
|
931
936
|
};
|
|
932
937
|
export type GetAssetReferences_Object = {
|
|
@@ -938,11 +943,11 @@ export type GetAssetReferences_Object = {
|
|
|
938
943
|
* Gets the asset references from the specified asset.
|
|
939
944
|
*/
|
|
940
945
|
export declare function getAssetReferences({ asset_container, asset_id, offset, limit, properties, }: {
|
|
941
|
-
asset_container: 'action_maps' | '
|
|
946
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
942
947
|
asset_id: string;
|
|
943
948
|
offset?: number;
|
|
944
949
|
limit?: number;
|
|
945
|
-
properties?: Array<
|
|
950
|
+
properties?: Array<'name' | 'count' | 'public'>;
|
|
946
951
|
}, headers?: AxiosRequestHeaders): AxiosPromise<Array<GetAssetReferences_Asset>>;
|
|
947
952
|
export type GetAssetDescription_ActionMap = {
|
|
948
953
|
actions: GetAssetDescription_Object;
|
|
@@ -952,12 +957,6 @@ export type GetAssetDescription_ActionMap = {
|
|
|
952
957
|
export type GetAssetDescription_Object = {
|
|
953
958
|
[action_name: string]: object;
|
|
954
959
|
};
|
|
955
|
-
export type GetAssetDescription_Algorithm = {
|
|
956
|
-
inputDescriptor: Array<object>;
|
|
957
|
-
name: string;
|
|
958
|
-
outputDescriptor: Array<object>;
|
|
959
|
-
uuid: string;
|
|
960
|
-
};
|
|
961
960
|
export type GetAssetDescription_Animation = {
|
|
962
961
|
animationEventTrack: GetAssetDescription_Object;
|
|
963
962
|
durationInMs: number;
|
|
@@ -1017,6 +1016,7 @@ export type GetAssetDescription_Submesh = {
|
|
|
1017
1016
|
aabb: GetAssetDescription_BoundingBox;
|
|
1018
1017
|
channels: Array<GetAssetDescription_Channel>;
|
|
1019
1018
|
indexCount: number;
|
|
1019
|
+
morphTargets?: Array<GetAssetDescription_MorphTarget>;
|
|
1020
1020
|
vertexCount: number;
|
|
1021
1021
|
};
|
|
1022
1022
|
export type GetAssetDescription_BoundingBox = {
|
|
@@ -1031,6 +1031,14 @@ export type GetAssetDescription_Channel = {
|
|
|
1031
1031
|
elementType: StrictUnion<0 | 1 | 2> & number;
|
|
1032
1032
|
semantic: StrictUnion<'index' | 'position' | 'normal' | 'uv' | 'color' | 'bone_id' | 'weight'>;
|
|
1033
1033
|
};
|
|
1034
|
+
export type GetAssetDescription_MorphTarget = {
|
|
1035
|
+
aabb: GetAssetDescription_Aabb;
|
|
1036
|
+
channels: Array<GetAssetDescription_Channel>;
|
|
1037
|
+
};
|
|
1038
|
+
export type GetAssetDescription_Aabb = {
|
|
1039
|
+
max: Array<number>;
|
|
1040
|
+
min: Array<number>;
|
|
1041
|
+
};
|
|
1034
1042
|
export type GetAssetDescription_Module = {
|
|
1035
1043
|
functions: GetAssetDescription_Object;
|
|
1036
1044
|
name: string;
|
|
@@ -1066,10 +1074,6 @@ export type GetAssetDescription_Scene = {
|
|
|
1066
1074
|
triangleCount?: number;
|
|
1067
1075
|
uuid: string;
|
|
1068
1076
|
};
|
|
1069
|
-
export type GetAssetDescription_Aabb = {
|
|
1070
|
-
max: Array<number>;
|
|
1071
|
-
min: Array<number>;
|
|
1072
|
-
};
|
|
1073
1077
|
export type GetAssetDescription_Script = {
|
|
1074
1078
|
eventNames: Array<string>;
|
|
1075
1079
|
inputDescriptor?: Array<GetAssetDescription_Object>;
|
|
@@ -1143,17 +1147,17 @@ export type GetAssetDescription_VolumeMaterial = {
|
|
|
1143
1147
|
* Gets the asset description from the specified asset.
|
|
1144
1148
|
*/
|
|
1145
1149
|
export declare function getAssetDescription({ asset_container, asset_id, }: {
|
|
1146
|
-
asset_container: 'action_maps' | '
|
|
1150
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1147
1151
|
asset_id: string;
|
|
1148
|
-
}, headers?: AxiosRequestHeaders): AxiosPromise<StrictUnion<GetAssetDescription_ActionMap |
|
|
1152
|
+
}, headers?: AxiosRequestHeaders): AxiosPromise<StrictUnion<GetAssetDescription_ActionMap | 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>>;
|
|
1149
1153
|
/**
|
|
1150
1154
|
* Updates asset description. Supports only updating name.
|
|
1151
1155
|
*/
|
|
1152
1156
|
export declare function renameAsset({ asset_container, asset_id, name, }: {
|
|
1153
|
-
asset_container: 'action_maps' | '
|
|
1157
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1154
1158
|
asset_id: string;
|
|
1155
1159
|
name?: string;
|
|
1156
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
1160
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
1157
1161
|
/**
|
|
1158
1162
|
* Gets the asset payload from the specified asset.
|
|
1159
1163
|
*/
|
|
@@ -1166,28 +1170,28 @@ export declare function getAssetPayload<T extends 'arraybuffer' | 'stream' | 'js
|
|
|
1166
1170
|
* Gets the asset history from the specified asset.
|
|
1167
1171
|
*/
|
|
1168
1172
|
export declare function getAssetHistory({ asset_container, asset_id, }: {
|
|
1169
|
-
asset_container: 'action_maps' | '
|
|
1173
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1170
1174
|
asset_id: string;
|
|
1171
1175
|
}, headers?: AxiosRequestHeaders): AxiosPromise<object>;
|
|
1172
1176
|
/**
|
|
1173
1177
|
* Gets the asset metadata from the specified asset.
|
|
1174
1178
|
*/
|
|
1175
1179
|
export declare function getAssetMeta({ asset_container, asset_id, }: {
|
|
1176
|
-
asset_container: 'action_maps' | '
|
|
1180
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1177
1181
|
asset_id: string;
|
|
1178
1182
|
}, headers?: AxiosRequestHeaders): AxiosPromise<object>;
|
|
1179
1183
|
/**
|
|
1180
1184
|
* Gets the code of the specified asset.
|
|
1181
1185
|
*/
|
|
1182
1186
|
export declare function getAssetCode({ asset_container_with_code, asset_id, }: {
|
|
1183
|
-
asset_container_with_code: '
|
|
1187
|
+
asset_container_with_code: 'animation_sequences' | 'modules' | 'scripts' | 'shaders';
|
|
1184
1188
|
asset_id: string;
|
|
1185
1189
|
}, headers?: AxiosRequestHeaders): AxiosPromise<string>;
|
|
1186
1190
|
/**
|
|
1187
1191
|
* Gets the asset thumbnail from the specified asset.
|
|
1188
1192
|
*/
|
|
1189
1193
|
export declare function getAssetThumbnail<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container, asset_id, size, default_url, }: {
|
|
1190
|
-
asset_container: 'action_maps' | '
|
|
1194
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1191
1195
|
asset_id: string;
|
|
1192
1196
|
size: 'large' | 'medium' | 'small' | 'tiny';
|
|
1193
1197
|
default_url?: string;
|
|
@@ -1196,10 +1200,10 @@ export declare function getAssetThumbnail<T extends 'arraybuffer' | 'stream' | '
|
|
|
1196
1200
|
* Assigns a thumbnail to the specified asset.
|
|
1197
1201
|
*/
|
|
1198
1202
|
export declare function setAssetThumbnail({ asset_container, asset_id, body, }: {
|
|
1199
|
-
asset_container: 'action_maps' | '
|
|
1203
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1200
1204
|
asset_id: string;
|
|
1201
1205
|
body: ArrayBuffer | ReadableStream;
|
|
1202
|
-
}, contentType: 'image/jpg' | 'image/png', headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
1206
|
+
}, contentType: 'image/jpg' | 'image/png', headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
1203
1207
|
/**
|
|
1204
1208
|
* Gets the asset custom types from the specified asset recursively.
|
|
1205
1209
|
*/
|
|
@@ -1211,7 +1215,7 @@ export declare function getAssetCustomTypes({ asset_container_with_custom_types,
|
|
|
1211
1215
|
* Packages and downloads the target asset.
|
|
1212
1216
|
*/
|
|
1213
1217
|
export declare function packageAsset<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container, asset_id, }: {
|
|
1214
|
-
asset_container: 'action_maps' | '
|
|
1218
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1215
1219
|
asset_id: string;
|
|
1216
1220
|
}, headers?: AxiosRequestHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
|
1217
1221
|
/**
|
|
@@ -1239,7 +1243,7 @@ export type GetSceneSessions_Session = {
|
|
|
1239
1243
|
};
|
|
1240
1244
|
export type GetSceneSessions_Client_UserInfo = {
|
|
1241
1245
|
client_id?: string;
|
|
1242
|
-
client_type?:
|
|
1246
|
+
client_type?: 'user' | 'guest';
|
|
1243
1247
|
user_id: string;
|
|
1244
1248
|
username: string;
|
|
1245
1249
|
};
|
|
@@ -2313,14 +2317,14 @@ export declare function updateEntity({ scene_id, entity_id, entity_components, }
|
|
|
2313
2317
|
scene_id: string;
|
|
2314
2318
|
entity_id: string;
|
|
2315
2319
|
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;
|
|
2316
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
2320
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
2317
2321
|
/**
|
|
2318
2322
|
* Delete a specific entity from a scene.
|
|
2319
2323
|
*/
|
|
2320
2324
|
export declare function deleteEntity({ scene_id, entity_id, }: {
|
|
2321
2325
|
scene_id: string;
|
|
2322
2326
|
entity_id: string;
|
|
2323
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
2327
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
2324
2328
|
/**
|
|
2325
2329
|
* Get the settings of a scene.
|
|
2326
2330
|
*/
|
|
@@ -2347,7 +2351,7 @@ export type GetRunningSessions_Session = {
|
|
|
2347
2351
|
};
|
|
2348
2352
|
export type GetRunningSessions_Client_UserInfo = {
|
|
2349
2353
|
client_id?: string;
|
|
2350
|
-
client_type?:
|
|
2354
|
+
client_type?: 'user' | 'guest';
|
|
2351
2355
|
user_id: string;
|
|
2352
2356
|
username: string;
|
|
2353
2357
|
};
|
|
@@ -2384,7 +2388,7 @@ export type GetSession_Session = {
|
|
|
2384
2388
|
};
|
|
2385
2389
|
export type GetSession_Client_UserInfo = {
|
|
2386
2390
|
client_id?: string;
|
|
2387
|
-
client_type?:
|
|
2391
|
+
client_type?: 'user' | 'guest';
|
|
2388
2392
|
user_id: string;
|
|
2389
2393
|
username: string;
|
|
2390
2394
|
};
|
|
@@ -2399,7 +2403,7 @@ export declare function getSession({ session_id, }: {
|
|
|
2399
2403
|
*/
|
|
2400
2404
|
export declare function killSession({ session_id, }: {
|
|
2401
2405
|
session_id: string;
|
|
2402
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
2406
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
2403
2407
|
export type JoinSession_SessionToken = {
|
|
2404
2408
|
session_token: string;
|
|
2405
2409
|
endpoint_info: JoinSession_Object;
|
|
@@ -2412,12 +2416,13 @@ export type JoinSession_Object = {
|
|
|
2412
2416
|
/**
|
|
2413
2417
|
* Creates a new client for the user and returns a token to join the session.
|
|
2414
2418
|
*/
|
|
2415
|
-
export declare function joinSession({ session_id, }: {
|
|
2419
|
+
export declare function joinSession({ session_id, is_headless, }: {
|
|
2416
2420
|
session_id: string;
|
|
2421
|
+
is_headless?: boolean;
|
|
2417
2422
|
}, headers?: AxiosRequestHeaders): AxiosPromise<JoinSession_SessionToken>;
|
|
2418
2423
|
export type GetClient_Client_UserInfo = {
|
|
2419
2424
|
client_id?: string;
|
|
2420
|
-
client_type?:
|
|
2425
|
+
client_type?: 'user' | 'guest';
|
|
2421
2426
|
user_id: string;
|
|
2422
2427
|
username: string;
|
|
2423
2428
|
};
|
|
@@ -2434,7 +2439,7 @@ export declare function getClient({ session_id, client_id, }: {
|
|
|
2434
2439
|
export declare function kickClientFromSession({ session_id, client_id, }: {
|
|
2435
2440
|
session_id: string;
|
|
2436
2441
|
client_id: string;
|
|
2437
|
-
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
|
|
2442
|
+
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
2438
2443
|
export type JoinSessionAsGuest_SessionToken = {
|
|
2439
2444
|
session_token: string;
|
|
2440
2445
|
endpoint_info: JoinSessionAsGuest_Object;
|
package/dist/index.js
CHANGED
|
@@ -27,8 +27,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
|
|
|
27
27
|
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
28
28
|
|
|
29
29
|
// index.ts
|
|
30
|
-
var
|
|
31
|
-
__export(
|
|
30
|
+
var index_exports = {};
|
|
31
|
+
__export(index_exports, {
|
|
32
32
|
ApiError: () => ApiError,
|
|
33
33
|
UnexpectedServiceError: () => UnexpectedServiceError,
|
|
34
34
|
axiosInstance: () => axiosInstance,
|
|
@@ -116,7 +116,7 @@ __export(library_exports, {
|
|
|
116
116
|
updateUser: () => updateUser,
|
|
117
117
|
uploadSourceFiles: () => uploadSourceFiles
|
|
118
118
|
});
|
|
119
|
-
module.exports = __toCommonJS(
|
|
119
|
+
module.exports = __toCommonJS(index_exports);
|
|
120
120
|
var import_axios_retry = __toESM(require("axios-retry"));
|
|
121
121
|
|
|
122
122
|
// _prebuild/wrapper.ts
|
|
@@ -1078,11 +1078,15 @@ function killSession({
|
|
|
1078
1078
|
});
|
|
1079
1079
|
}
|
|
1080
1080
|
function joinSession({
|
|
1081
|
-
session_id
|
|
1081
|
+
session_id,
|
|
1082
|
+
is_headless = false
|
|
1082
1083
|
}, headers) {
|
|
1083
1084
|
return axiosInstance({
|
|
1084
1085
|
method: "post",
|
|
1085
1086
|
url: "/sessions/" + session_id + "/clients",
|
|
1087
|
+
data: {
|
|
1088
|
+
is_headless
|
|
1089
|
+
},
|
|
1086
1090
|
headers
|
|
1087
1091
|
});
|
|
1088
1092
|
}
|