@3dverse/api 0.8.9 → 0.8.10

package/dist/_prebuild/wrapper.d.ts

@@ -1,14 +1,14 @@
 /**
- * 3dverse Asset API v1.0
- * # Getting Started
+ * Asset API v1.0
+ * ## Getting Started
  *
- *Welcome to the 3dverse Asset API. This is the reference for the REST API endpoints.
+ *This is the reference for the REST API endpoints.
  *
- *## NPM package
+ *### NPM package
  *
  *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).
  *
- *## Authentication
+ *### Authentication
  *
  *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.
  *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, }: {
 export declare function updateUser({ user_id, username, }: {
     user_id: string;
     username: string;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 export type DeleteUser_Object = {
     deleted_assets?: DeleteUser_Object;
 };
@@ -193,13 +193,13 @@ export declare function updateGroupDescription({ group_id, name, description, }:
     group_id: string;
     name: string;
     description: string;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 /**
  * Deletes a group and all its access rights.
  */
 export declare function deleteGroup({ group_id, }: {
     group_id: string;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 /**
  * Grants member access to the group.
  */
@@ -209,7 +209,7 @@ export declare function grantMemberAccessToGroup({ group_id, member_type, member
     member_id: string;
     group_access: 'read' | 'write' | 'manage';
     folder_access: 'read' | 'write' | 'manage';
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 /**
  * Revoke requested user access to group.
  */
@@ -217,7 +217,7 @@ export declare function revokeMemberAccessToGroup({ group_id, member_type, membe
     group_id: string;
     member_type: 'users' | 'groups';
     member_id: string;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 export type ListFolders_Folder = {
     folder_id: string;
     parent_folder_id?: string;
@@ -293,20 +293,20 @@ export declare function getFolderInfo({ folder_id, }: {
 export declare function moveFolders({ folder_id, folder_ids, }: {
     folder_id: string;
     folder_ids: Array<string>;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 /**
  * Updates the folder details.
  */
 export declare function updateFolder({ folder_id, name, }: {
     folder_id: string;
     name?: string;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 /**
  * Deletes the requested folder. The target folder must be empty.
  */
 export declare function deleteFolder({ folder_id, }: {
     folder_id: string;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 export type ListFolderAccesses_Object = {
     users?: Array<ListFolderAccesses_UserInfo_FolderAccess>;
     groups?: Array<ListFolderAccesses_GroupInfo_FolderAccess>;
@@ -335,7 +335,7 @@ export declare function grantMemberAccessToFolder({ folder_id, member_type, memb
     member_type: 'users' | 'groups';
     member_id: string;
     access: 'read' | 'write' | 'manage';
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 /**
  * Revokes member access to a target folder.
  */
@@ -343,7 +343,7 @@ export declare function revokeMemberAccessToFolder({ folder_id, member_type, mem
     folder_id: string;
     member_type: 'users' | 'groups';
     member_id: string;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 export type CreateSubfolder_Folder = {
     name: string;
     subfolders?: Array<CreateSubfolder_Folder>;
@@ -397,6 +397,14 @@ export type UploadSourceFiles_Object = {
 };
 /**
  * Uploads the specified source file(s).
+ * The supported file formats are:
+ *   - Scene :
+ *     - 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`
+ *     - Point cloud : `e57, ptx, xyz, las, laz`
+ *     - Volume : `dcm`
+ *   - Texture : `jpg, jpeg, png, tga, dds, tif, tiff, bmp, rgbe`
+ *   - Cubemap : `hdr`
+ *   - Sound : `wav, mp3, ogg, flac`.
  */
 export declare function uploadSourceFiles({ folder_id, body, }: {
     folder_id: string;
@@ -426,7 +434,7 @@ export declare function getSourceFilesInFolder({ folder_id, offset, limit, filte
 export declare function moveSourceFiles({ folder_id, source_file_ids, }: {
     folder_id: string;
     source_file_ids: Array<string>;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 export type GetUploadTasksInFolder_UploadTask = {
     upload_task_id: string;
     folder_id: string;
@@ -540,7 +548,7 @@ export declare function createAsset({ folder_id, asset_creation_options, }: {
 export declare function moveAssets({ folder_id, asset_ids, }: {
     folder_id: string;
     asset_ids: Array<string>;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 export type CreateMaterial_Object = {
     asset_id: string;
 };
@@ -610,7 +618,7 @@ export type ImportAssets_AssetIds = {
  */
 export declare function importAssets({ folder_id, overwrite, body, }: {
     folder_id: string;
-    overwrite?: StrictUnion<'never' | 'only-specified' | 'always'>;
+    overwrite?: 'never' | 'only-specified' | 'always';
     body: ArrayBuffer | ReadableStream;
 }, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void, headers?: AxiosRequestHeaders): AxiosPromise<ImportAssets__index_ImportAssetsResponse_ImportAssetsResponse>;
 export type GetSessionsInFolder_Session = {
@@ -628,7 +636,7 @@ export type GetSessionsInFolder_Session = {
 };
 export type GetSessionsInFolder_Client_UserInfo = {
     client_id?: string;
-    client_type?: StrictUnion<'user' | 'guest'>;
+    client_type?: 'user' | 'guest';
     user_id: string;
     username: string;
 };
@@ -661,7 +669,7 @@ export declare function listSourceFiles({ offset, limit, filters, }: {
 export declare function deleteSourceFiles({ source_file_ids, delete_assets, }: {
     source_file_ids: Array<string>;
     delete_assets?: boolean;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 /**
  * Downloads the target source file.
  */
@@ -686,7 +694,7 @@ export declare function getSourceFileDetails({ source_file_id, }: {
 export declare function updateSourceFileDetails({ source_file_id, name, }: {
     source_file_id: string;
     name: string;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 export type GetSourceFileAssets__index_AssetList_AssetList = {
     action_maps?: Array<GetSourceFileAssets_Object>;
     algorithms?: Array<GetSourceFileAssets_Object>;
@@ -811,14 +819,14 @@ export declare function listAssets({ offset, limit, filter, }: {
  */
 export declare function deleteAssets({ asset_ids, }: {
     asset_ids: Array<string>;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 /**
  * Deletes the asset.
  */
 export declare function deleteAsset({ asset_container, asset_id, }: {
     asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
     asset_id: string;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 export type GetAssetSourceFile_SourceFile = {
     source_file_id: string;
     source_file_original_name: string;
@@ -888,7 +896,7 @@ export declare function getAssetFolder({ asset_container, asset_id, }: {
 export type GetAssetDependencies_Filter = {
     with_asset_types?: Array<'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
     without_asset_types?: Array<'action_map' | 'algorithm' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
-    public?: StrictUnion<'include' | 'exclude' | 'restrict-to'>;
+    public?: 'include' | 'exclude' | 'restrict-to';
 };
 export type GetAssetDependencies_Asset = {
     asset_id: string;
@@ -922,7 +930,7 @@ export declare function getAssetDependencies({ asset_container, asset_id, offset
     limit?: number;
     depth?: 'all' | 'direct' | number;
     filters?: GetAssetDependencies_Filter;
-    properties?: Array<StrictUnion<'name' | 'dependencies' | 'count' | 'public' | 'accessible' | 'payload_info'>>;
+    properties?: Array<'name' | 'dependencies' | 'count' | 'public' | 'accessible' | 'payload_info'>;
 }, headers?: AxiosRequestHeaders): AxiosPromise<Array<GetAssetDependencies_Asset>>;
 export type GetAssetReferences_Asset = {
     asset_id: string;
@@ -942,7 +950,7 @@ export declare function getAssetReferences({ asset_container, asset_id, offset,
     asset_id: string;
     offset?: number;
     limit?: number;
-    properties?: Array<StrictUnion<'name' | 'count' | 'public'>>;
+    properties?: Array<'name' | 'count' | 'public'>;
 }, headers?: AxiosRequestHeaders): AxiosPromise<Array<GetAssetReferences_Asset>>;
 export type GetAssetDescription_ActionMap = {
     actions: GetAssetDescription_Object;
@@ -1017,6 +1025,7 @@ export type GetAssetDescription_Submesh = {
     aabb: GetAssetDescription_BoundingBox;
     channels: Array<GetAssetDescription_Channel>;
     indexCount: number;
+    morphTargets?: Array<GetAssetDescription_MorphTarget>;
     vertexCount: number;
 };
 export type GetAssetDescription_BoundingBox = {
@@ -1031,6 +1040,14 @@ export type GetAssetDescription_Channel = {
     elementType: StrictUnion<0 | 1 | 2> & number;
     semantic: StrictUnion<'index' | 'position' | 'normal' | 'uv' | 'color' | 'bone_id' | 'weight'>;
 };
+export type GetAssetDescription_MorphTarget = {
+    aabb: GetAssetDescription_Aabb;
+    channels: Array<GetAssetDescription_Channel>;
+};
+export type GetAssetDescription_Aabb = {
+    max: Array<number>;
+    min: Array<number>;
+};
 export type GetAssetDescription_Module = {
     functions: GetAssetDescription_Object;
     name: string;
@@ -1066,10 +1083,6 @@ export type GetAssetDescription_Scene = {
     triangleCount?: number;
     uuid: string;
 };
-export type GetAssetDescription_Aabb = {
-    max: Array<number>;
-    min: Array<number>;
-};
 export type GetAssetDescription_Script = {
     eventNames: Array<string>;
     inputDescriptor?: Array<GetAssetDescription_Object>;
@@ -1153,7 +1166,7 @@ export declare function renameAsset({ asset_container, asset_id, name, }: {
     asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
     asset_id: string;
     name?: string;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 /**
  * Gets the asset payload from the specified asset.
  */
@@ -1199,7 +1212,7 @@ export declare function setAssetThumbnail({ asset_container, asset_id, body, }:
     asset_container: 'action_maps' | 'algorithms' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
     asset_id: string;
     body: ArrayBuffer | ReadableStream;
-}, contentType: 'image/jpg' | 'image/png', headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, contentType: 'image/jpg' | 'image/png', headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 /**
  * Gets the asset custom types from the specified asset recursively.
  */
@@ -1239,7 +1252,7 @@ export type GetSceneSessions_Session = {
 };
 export type GetSceneSessions_Client_UserInfo = {
     client_id?: string;
-    client_type?: StrictUnion<'user' | 'guest'>;
+    client_type?: 'user' | 'guest';
     user_id: string;
     username: string;
 };
@@ -2313,14 +2326,14 @@ export declare function updateEntity({ scene_id, entity_id, entity_components, }
     scene_id: string;
     entity_id: string;
     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;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 /**
  * Delete a specific entity from a scene.
  */
 export declare function deleteEntity({ scene_id, entity_id, }: {
     scene_id: string;
     entity_id: string;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 /**
  * Get the settings of a scene.
  */
@@ -2347,7 +2360,7 @@ export type GetRunningSessions_Session = {
 };
 export type GetRunningSessions_Client_UserInfo = {
     client_id?: string;
-    client_type?: StrictUnion<'user' | 'guest'>;
+    client_type?: 'user' | 'guest';
     user_id: string;
     username: string;
 };
@@ -2384,7 +2397,7 @@ export type GetSession_Session = {
 };
 export type GetSession_Client_UserInfo = {
     client_id?: string;
-    client_type?: StrictUnion<'user' | 'guest'>;
+    client_type?: 'user' | 'guest';
     user_id: string;
     username: string;
 };
@@ -2399,7 +2412,7 @@ export declare function getSession({ session_id, }: {
  */
 export declare function killSession({ session_id, }: {
     session_id: string;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 export type JoinSession_SessionToken = {
     session_token: string;
     endpoint_info: JoinSession_Object;
@@ -2412,12 +2425,13 @@ export type JoinSession_Object = {
 /**
  * Creates a new client for the user and returns a token to join the session.
  */
-export declare function joinSession({ session_id, }: {
+export declare function joinSession({ session_id, is_headless, }: {
     session_id: string;
+    is_headless?: boolean;
 }, headers?: AxiosRequestHeaders): AxiosPromise<JoinSession_SessionToken>;
 export type GetClient_Client_UserInfo = {
     client_id?: string;
-    client_type?: StrictUnion<'user' | 'guest'>;
+    client_type?: 'user' | 'guest';
     user_id: string;
     username: string;
 };
@@ -2434,7 +2448,7 @@ export declare function getClient({ session_id, client_id, }: {
 export declare function kickClientFromSession({ session_id, client_id, }: {
     session_id: string;
     client_id: string;
-}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any>>;
+}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
 export type JoinSessionAsGuest_SessionToken = {
     session_token: string;
     endpoint_info: JoinSessionAsGuest_Object;

package/dist/index.js

@@ -27,8 +27,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // index.ts
-var library_exports = {};
-__export(library_exports, {
+var index_exports = {};
+__export(index_exports, {
   ApiError: () => ApiError,
   UnexpectedServiceError: () => UnexpectedServiceError,
   axiosInstance: () => axiosInstance,
@@ -116,7 +116,7 @@ __export(library_exports, {
   updateUser: () => updateUser,
   uploadSourceFiles: () => uploadSourceFiles
 });
-module.exports = __toCommonJS(library_exports);
+module.exports = __toCommonJS(index_exports);
 var import_axios_retry = __toESM(require("axios-retry"));
 
 // _prebuild/wrapper.ts
@@ -1078,11 +1078,15 @@ function killSession({
   });
 }
 function joinSession({
-  session_id
+  session_id,
+  is_headless = false
 }, headers) {
   return axiosInstance({
     method: "post",
     url: "/sessions/" + session_id + "/clients",
+    data: {
+      is_headless
+    },
     headers
   });
 }