@3dverse/api 0.6.1 → 0.6.3

package/README.md

@@ -17,10 +17,10 @@ npm i @3dverse/api
 import * as api3dverse from '@3dverse/api';
 ```
 
-or 
+or
 
 ```
-import { createUser } from '3dverse/api';
+import { registerUser } from '@3dverse/api';
 ```
 
 ### Authentication
@@ -28,13 +28,13 @@ import { createUser } from '3dverse/api';
 Only use the API key on the server.
 
 ```
-import { setApiKey, createUser } from '3dverse/api';
+import { setApiKey, registerUser } from '@3dverse/api';
 
 
 setApiKey(MY_3DVERSE_API_KEY);
 
 async () => {
-    const { user_id } = await createUser({ username: 'my_username' }); 
+    const { user_id } = await registerUser({ username: 'my_username' });
 }
 ```
 
@@ -52,4 +52,3 @@ async () => {
     });
 }
 ```
-

package/dist/_prebuild/wrapper.d.ts

@@ -1,10 +1,20 @@
 /**
- * 3dverse v1.0
- * # 3dverse API
+ * 3dverse Asset API v1.0
+ * # Getting Started
  *
- * Welcome to the 3dverse API. The 3dverse API scopes to an API key. Each development environment of an application requires a separate API key.
- * Through the API key, you can manage ownership, access, and permissions for each environment.
- * Each environment has its own set of users, groups, folders, and assets.
+ * Welcome to the 3dverse Asset API. This is the reference for the REST API endpoints.
+ *
+ * ## 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
+ *
+ * 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`.
+ *
+ *
+ * ---
  *
  *
  * Contact: 3dverse Support (support@3dverse.com)
@@ -361,6 +371,7 @@ export declare function getUploadTasksInFolder({ folder_id, offset, limit }: {
 export type GetFolderAssets_Filter = {
     asset_type?: (Array<"action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material"> | "action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material");
     asset_name?: string;
+    include_public_assets?: boolean;
 };
 export type GetFolderAssets__index_AssetList_AssetList = {
     action_maps?: Array<GetFolderAssets_Object>;
@@ -540,6 +551,11 @@ export type GetUploadTask_ConversionTask = {
 export declare function getUploadTask({ upload_task_id }: {
     upload_task_id: string;
 }): AxiosPromise<GetUploadTask_UploadTask>;
+export type ListAssets_Filter = {
+    asset_type?: (Array<"action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material"> | "action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material");
+    asset_name?: string;
+    include_public_assets?: boolean;
+};
 export type ListAssets__index_AssetList_AssetList = {
     action_maps?: Array<ListAssets_Object>;
     algorithms?: Array<ListAssets_Object>;
@@ -569,9 +585,10 @@ export type ListAssets_Object = {
     asset_id: string;
     name: string;
 };
-export declare function listAssets({ offset, limit }: {
+export declare function listAssets({ offset, limit, filter }: {
     offset?: number;
     limit?: number;
+    filter?: ListAssets_Filter;
 }): AxiosPromise<ListAssets__index_AssetList_AssetList>;
 export declare function deleteAssets({ asset_ids }: {
     asset_ids: Array<string>;

package/dist/index.js

@@ -564,14 +564,16 @@ function getUploadTask({
 }
 function listAssets({
   offset = 0,
-  limit = 10
+  limit = 10,
+  filter
 }) {
   return axiosInstance({
     method: "get",
     url: "/assets",
     params: {
       offset,
-      limit
+      limit,
+      filter
     }
   });
 }