@rtsdk/topia 0.3.0 → 0.3.2

package/dist/index.d.ts

@@ -1,20 +1,3 @@
-/**
- * BSD 3-Clause License
- *
- * Copyright (c) 2023, metaversecloud.com | topia.io
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- *
- * - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- *
- * - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- *
- * - Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
 import * as axios from 'axios';
 import { AxiosResponse, AxiosInstance, AxiosError } from 'axios';
 import jwt from 'jsonwebtoken';
@@ -445,7 +428,7 @@ declare class World extends SDKController implements WorldInterface {
      *
      * @usage
      * ```ts
-     * await world.fetchDroppedAssets();
+     * await world.fetchDroppedAssetsWithUniqueName();
      * const assets = world.droppedAssets;
      * ```
      */
@@ -454,6 +437,23 @@ declare class World extends SDKController implements WorldInterface {
         isPartial?: boolean;
         isReversed?: boolean;
     }): Promise<DroppedAsset[]>;
+    /**
+     * @summary
+     * Retrieve all assets dropped in a world matching dropSceneId.
+     *
+     * @usage
+     * ```ts
+     * await world.fetchDroppedAssetsBySceneDropId({
+     *   sceneDropId: "sceneDropIdExample",
+     *   uniqueName: "optionalUniqueNameExample",
+     * });
+     * const assets = world.droppedAssets;
+     * ```
+     */
+    fetchDroppedAssetsBySceneDropId({ sceneDropId, uniqueName, }: {
+        sceneDropId: string;
+        uniqueName?: string;
+    }): Promise<DroppedAsset[]>;
     /**
      * @summary
      * Update multiple custom text dropped assets with a single style while preserving text for specified dropped assets only.
@@ -676,7 +676,7 @@ declare class User extends SDKController implements UserInterface {
      *
      * @usage
      * ```ts
-     * await user.updateUserDataObject({
+     * await user.updateDataObject({
      *   "exampleKey": "exampleValue",
      * });
      * ```
@@ -787,7 +787,7 @@ declare class Visitor extends User implements VisitorInterface {
      *
      * @usage
      * ```ts
-     * const dataObject = await visitor.fetchVisitorDataObject();
+     * const dataObject = await visitor.fetchDataObject();
      * ```
      */
     fetchDataObject(): Promise<void | ResponseType>;
@@ -799,7 +799,7 @@ declare class Visitor extends User implements VisitorInterface {
      *
      * @usage
      * ```ts
-     * await visitor.setVisitorDataObject({
+     * await visitor.setDataObject({
      *   "exampleKey": "exampleValue",
      * });
      * ```
@@ -818,7 +818,7 @@ declare class Visitor extends User implements VisitorInterface {
      *
      * @usage
      * ```ts
-     * await visitor.updateVisitorDataObject({
+     * await visitor.updateDataObject({
      *   "exampleKey": "exampleValue",
      * });
      * ```
@@ -1437,4 +1437,4 @@ declare class WorldFactory {
     create(urlSlug: string, options?: WorldOptionalInterface): World;
 }
 
-export { AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, FireToastInterface, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, ResponseType, SDKInterface, SceneFactory, SceneInterface, SceneOptionalInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, UserFactory, UserInterface, UserOptionalInterface, UserOptions, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WorldActivityFactory, WorldActivityOptionalInterface, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions };
+export { Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, FireToastInterface, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions };