@rtsdk/topia 0.17.0 → 0.17.2

package/dist/index.d.ts

@@ -59,6 +59,12 @@ declare enum DroppedAssetMediaType {
     NONE = "none",
     LINK = "link"
 }
+declare enum DroppedAssetMediaVolumeRadius {
+    CLOSE = 0,
+    MEDIUM = 1,
+    FAR = 2,
+    EVERYWHERE = 3
+}
 type DroppedAssetLinkType = {
     clickableLink: string;
     clickableLinkTitle?: string;
@@ -107,12 +113,11 @@ type ResponseType$1 = {
 };
 
 /**
- * @summary
  * Create an instance of Scene class with a given scene id and optional attributes and session credentials.
  *
- * @usage
+ * @example
  * ```ts
- * await new Scene(topia, "sceneId", {
+ * const scene = await new Scene(topia, "sceneId", {
  *   attributes: { name: "My Scene" },
  *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
  * });
@@ -122,10 +127,9 @@ declare class Scene extends SDKController implements SceneInterface {
     readonly id: string;
     constructor(topia: Topia, id: string, options?: SceneOptionalInterface);
     /**
-     * @summary
-     * Retrieves scene details.
+     * Retrieves scene details and assigns response data to the instance.
      *
-     * @usage
+     * @example
      * ```ts
      * await scene.fetchSceneById();
      * const { name } = scene;
@@ -135,12 +139,11 @@ declare class Scene extends SDKController implements SceneInterface {
 }
 
 /**
- * @summary
  * Create an instance of Dropped Asset class with a given dropped asset id, url slug, and optional attributes and session credentials.
  *
- * @usage
+ * @example
  * ```ts
- * await new DroppedAsset(topia, "1giFZb0sQ3X27L7uGyQX", "example", {
+ * const droppedAsset = await new DroppedAsset(topia, "1giFZb0sQ3X27L7uGyQX", "example", {
  *   attributes: { text: "My Dropped Asset" },
  *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
  * });
@@ -160,10 +163,9 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     urlSlug: string;
     constructor(topia: Topia, id: string, urlSlug: string, options?: DroppedAssetOptionalInterface);
     /**
-     * @summary
-     * Retrieves dropped asset details.
+     * Retrieves dropped asset details and assigns response data to the instance.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.fetchDroppedAssetById();
      * const { assetName } = droppedAsset;
@@ -171,10 +173,9 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      */
     fetchDroppedAssetById(): Promise<void | ResponseType$1>;
     /**
-     * @summary
-     * Updates dropped asset details.
+     * Updates dropped asset details and assigns the response data to the instance. Requires Public Key to have the `canUpdateDroppedAssets` permission.
      *
-     * @usage
+     * @example
      * ```ts
      * const payload = {
      * assetScale: 1,
@@ -201,38 +202,48 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * const { assetName } = droppedAsset;
      * ```
      */
-    updateDroppedAsset({ assetScale, clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, flipped, isInteractive, isTextTopLayer, interactivePublicKey, layer0, layer1, position, specialType, text, textColor, textSize, textWeight, textWidth, uniqueName, yOrderAdjust, }: UpdateDroppedAssetInterface): Promise<void | ResponseType$1>;
+    updateDroppedAsset({ assetScale, audioRadius, audioSliderVolume, clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, flipped, isInteractive, isTextTopLayer, isVideo, interactivePublicKey, layer0, layer1, mediaLink, mediaName, mediaType, portalName, position, specialType, syncUserMedia, text, textColor, textSize, textWeight, textWidth, uniqueName, yOrderAdjust, }: UpdateDroppedAssetInterface): Promise<void | ResponseType$1>;
     /**
-     * @summary
-     * Delete dropped asset.
+     * Deletes the dropped asset (removes it from the world).
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.deleteDroppedAsset();
      * ```
      */
     deleteDroppedAsset(): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Retrieves the data object for a dropped asset.
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
      * const dataObject = await droppedAsset.fetchDataObject();
      * ```
+     *
+     * @returns {Promise<object | ResponseType>} Returns the data object or an error response.
      */
     fetchDataObject(appPublicKey?: string, appJWT?: string): Promise<void | ResponseType$1>;
     /**
-     * @summary
-     * Sets the data object for a dropped asset.
+     * Sets the data object for a dropped asset and assigns the response data to the instance.
      *
+     * @remarks
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
-     * await droppedAsset.setDataObject({
-     *   "exampleKey": "exampleValue",
-     * });
+     * await droppedAsset.setDataObject(
+     *   { resetCount: 0 },
+     *   {
+     *     analytics: [{ analyticName: "resets"} ],
+     *     lock: { lockId: `${assetId}-${resetCount}-${new Date(Math.round(new Date().getTime() / 10000) * 10000)}` },
+     *   },
+     * );
+     *
+     * const { resetCount } = droppedAsset.dataObject;
      * ```
      */
     setDataObject(dataObject: object, options?: {
@@ -247,16 +258,21 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
         };
     }): Promise<void | ResponseType$1>;
     /**
-     * @summary
-     * Updates the data object for a dropped asset.
+     * Updates the data object for a dropped asset and assigns the response data to the instance.
      *
+     * @remarks
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
      * await droppedAsset.updateDataObject({
-     *   "exampleKey": "exampleValue",
+     *   [`profiles.${profileId}.itemsCollectedByUser`]: { [dateKey]: { count: 1 }, total: 1 },
+     *   [`profileMapper.${profileId}`]: username,
      * });
+     *
+     * const { profiles } = droppedAsset.dataObject;
      * ```
      */
     updateDataObject(dataObject: object, options?: {
@@ -271,12 +287,14 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
         };
     }): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Increments a specific value in the data object for a dropped asset by the amount specified. Must have valid interactive credentials from a visitor in the world.
      *
+     * @remarks
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
      * await droppedAsset.incrementDataObjectValue("key", 1);
      * ```
@@ -293,10 +311,9 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
         };
     }): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Updates broadcast options for a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updateBroadcast({
      *   assetBroadcast: true,
@@ -304,13 +321,14 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      *   broadcasterEmail: "example@email.com"
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateBroadcast({ assetBroadcast, assetBroadcastAll, broadcasterEmail, }: UpdateBroadcastInterface): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Updates click options for a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updateClickType({
      *   "clickType": "portal",
@@ -325,13 +343,14 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      *   "portalName": "community"
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, isForceLinkInIframe, isOpenLinkInDrawer, portalName, position, }: UpdateClickTypeInterface): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Adds an array of links to an asset. Maximum is 20 links.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.setClickableLinkMulti({
      *   clickableLinks: [
@@ -350,14 +369,17 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      *   ],
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     setClickableLinkMulti({ clickableLinks }: SetClickableLinkMultiInterface): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Updates multiple clickable links for a dropped asset.
+     *
+     * @remarks
      * Pass in an 'existingLinkId' to edit an existing link.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updateClickableLinkMulti({
      *   clickableLink: "https://example.com",
@@ -367,23 +389,25 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      *   existingLinkId: "abcd"
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateClickableLinkMulti({ clickableLink, clickableLinkTitle, isForceLinkInIframe, isOpenLinkInDrawer, existingLinkId, linkSamlQueryParams, }: UpdateClickableLinkMultiInterface): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Removes a clickable link from a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.removeClickableLink({ linkId: "link-id" });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     removeClickableLink({ linkId }: RemoveClickableLinkInterface): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Updates text and style of a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * const style = {
      *   "textColor": "#abc123",
@@ -394,13 +418,14 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * };
      * await droppedAsset.updateCustomTextAsset(style, "hello world");
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateCustomTextAsset(style: object | undefined | null, text: string | null | undefined): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Updates media options for a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updateMediaType({
      *   "mediaType": "link",
@@ -413,23 +438,25 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      *   "mediaName": "string"
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateMediaType({ audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia, }: UpdateMediaTypeInterface): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Updates mute zone options for a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updateMuteZone(true);
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateMuteZone(isMutezone: boolean): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Updates landmark zone options for a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updateLandmarkZone({
      *  isLandmarkZoneEnabled: true,
@@ -437,6 +464,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      *  landmarkZoneIsVisible: true,
      *});
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateLandmarkZone({ isLandmarkZoneEnabled, landmarkZoneName, landmarkZoneIsVisible, }: {
         isLandmarkZoneEnabled: boolean;
@@ -444,30 +473,31 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
         landmarkZoneIsVisible?: boolean;
     }): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Updates webhook zone options for a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updateWebhookZone(true);
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateWebhookZone(isWebhookZoneEnabled: boolean): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Moves a dropped asset to specified coordinates.
      *
-     * @usage
+     * @example
      * ```ts
-     * await droppedAsset.updatePosition(100,200);
+     * await droppedAsset.updatePosition(100, 200, 100);
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updatePosition(x: number, y: number, yOrderAdjust?: number): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Updates private zone options for a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updatePrivateZone({
      *   "isPrivateZone": false,
@@ -475,53 +505,58 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      *   "privateZoneUserCap": 10
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updatePrivateZone({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap, }: UpdatePrivateZoneInterface): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Updates the size of a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.assetScale(.5);
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateScale(assetScale: number): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Flip an dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.flip(.5);
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     flip(): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Change or remove media embedded in a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updateUploadedMediaSelected("LVWyxwNxI96eLjnXWwYO");
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateUploadedMediaSelected(mediaId: string): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Change or remove top and bottom layers of a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updateWebImageLayers("","https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg");
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateWebImageLayers(bottom: string, top: string): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Add a webhook to a dropped asset
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.addWebhook({
      *   dataObject: {},
@@ -533,6 +568,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      *   url: "https://url.com",
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the new `webhookId` or an error.
      */
     addWebhook({ dataObject, description, isUniqueOnly, shouldSetClickType, shouldSetIsInteractive, title, type, url, }: {
         dataObject: object;
@@ -545,10 +582,9 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
         url: string;
     }): Promise<void | AxiosResponse>;
     /**
-     * @summary
      * Set the interactive settings on a dropped asset
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.setInteractiveSettings({
      *   isInteractive: true,
@@ -561,10 +597,9 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
         interactivePublicKey: string;
     }): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Retrieve analytics for a dropped asset by day, week, month, quarter, or year
      *
-     * @usage
+     * @example
      * ```ts
      * const analytics = await droppedAsset.fetchDroppedAssetAnalytics({
      *   periodType: "quarter",
@@ -572,6 +607,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      *   year: 2023,
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the analytics data or an error.
      */
     fetchDroppedAssetAnalytics({ periodType, dateValue, year, }: {
         periodType: "week" | "month" | "quarter" | "year";
@@ -581,12 +618,11 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
 }
 
 /**
- * @summary
  * Create an instance of World class with a given url slug and optional attributes and session credentials.
  *
- * @usage
+ * @example
  * ```ts
- * await new World(topia, "exampleWorld", {
+ * const world = await new World(topia, "exampleWorld", {
  *   attributes: { name: "Example World" },
  *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
  * });
@@ -604,10 +640,9 @@ declare class World extends SDKController implements WorldInterface {
         [key: string]: DroppedAsset;
     };
     /**
-     * @summary
      * Retrieves details of a world.
      *
-     * @usage
+     * @example
      * ```ts
      * await world.fetchDetails();
      * const { name } = world;
@@ -615,10 +650,9 @@ declare class World extends SDKController implements WorldInterface {
      */
     fetchDetails(): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Update details of a world.
      *
-     * @usage
+     * @example
      * ```ts
      * await world.updateDetails({
      *   controls: {
@@ -634,14 +668,15 @@ declare class World extends SDKController implements WorldInterface {
      *   spawnPosition: { x: 100, y: 100 },
      *   width: 2000
      * });
+     *
+     * const { name, description } = world;
      * ```
      */
     updateDetails({ controls, description, forceAuthOnLogin, height, name, spawnPosition, width, }: WorldDetailsInterface): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Set close world settings
      *
-     * @usage
+     * @example
      * ```ts
      * await world.updateCloseWorldSettings({
      *   controls: {
@@ -658,16 +693,19 @@ declare class World extends SDKController implements WorldInterface {
      *   width: 2000
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns `{ success: true }` or an error.
      */
     updateCloseWorldSettings({ closeWorldDescription, isWorldClosed, }: {
         closeWorldDescription: string;
         isWorldClosed: boolean;
     }): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Retrieve all assets dropped in a world.
      *
-     * @usage
+     * @category Dropped Assets
+     *
+     * @example
      * ```ts
      * await world.fetchDroppedAssets();
      * const assets = world.droppedAssets;
@@ -675,13 +713,16 @@ declare class World extends SDKController implements WorldInterface {
      */
     fetchDroppedAssets(): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Retrieve all assets dropped in a world matching uniqueName.
      *
-     * @usage
+     * @category Dropped Assets
+     *
+     * @example
      * ```ts
-     * const droppedAssets = await world.fetchDroppedAssetsWithUniqueName({u niqueName: "exampleUniqueName", isPartial: true });
+     * const droppedAssets = await world.fetchDroppedAssetsWithUniqueName({ uniqueName: "exampleUniqueName", isPartial: true });
      * ```
+     *
+     * @returns {Promise<DroppedAsset[]>} Returns an array of DroppedAsset instances.
      */
     fetchDroppedAssetsWithUniqueName({ uniqueName, isPartial, isReversed, }: {
         uniqueName: string;
@@ -689,37 +730,30 @@ declare class World extends SDKController implements WorldInterface {
         isReversed?: boolean;
     }): Promise<DroppedAsset[]>;
     /**
-     * @summary
-     * Retrieve all landmark zone assets dropped in a world.
-     *
-     * @usage
-     * ```ts
-     * const zones = await world.fetchLandmarkZones("optionalLandmarkZoneName", "optionalSceneDropIdExample");
-     * ```
-     */
-    fetchLandmarkZones(landmarkZoneName?: string, sceneDropId?: string): Promise<DroppedAsset[]>;
-    /**
-     * @summary
      * Retrieve all assets dropped in a world matching sceneDropId.
      *
-     * @usage
+     * @category Dropped Assets
+     *
+     * @example
      * ```ts
-     * await world.fetchDroppedAssetsBySceneDropId({
+     * const droppedAssets = await world.fetchDroppedAssetsBySceneDropId({
      *   sceneDropId: "sceneDropIdExample",
      *   uniqueName: "optionalUniqueNameExample",
      * });
-     * const assets = world.droppedAssets;
      * ```
+     *
+     * @returns {Promise<DroppedAsset[]>} Returns an array of DroppedAsset instances.
      */
     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.
      *
-     * @usage
+     * @category Dropped Assets
+     *
+     * @example
      * ```ts
      * const droppedAssetsToUpdate = [world.droppedAssets["6"], world.droppedAssets["12"]];
      * const style = {
@@ -732,37 +766,50 @@ declare class World extends SDKController implements WorldInterface {
      * await world.updateCustomText(droppedAssetsToUpdate, style);
      * ```
      *
-     * @result
+     * @returns
      * Updates each DroppedAsset instance and world.droppedAssets map.
      */
     updateCustomTextDroppedAssets(droppedAssetsToUpdate: Array<DroppedAsset>, style: object): Promise<object>;
+    /**
+     * Retrieve all landmark zone assets dropped in a world.
+     *
+     * @category Dropped Assets
+     *
+     * @example
+     * ```ts
+     * const zones = await world.fetchLandmarkZones("optionalLandmarkZoneName", "optionalSceneDropIdExample");
+     * ```
+     *
+     * @returns {Promise<DroppedAsset[]>} Returns an array of DroppedAsset instances.
+     */
+    fetchLandmarkZones(landmarkZoneName?: string, sceneDropId?: string): Promise<DroppedAsset[]>;
     /**
      * @deprecated Use {@link fetchScenes} instead.
      *
-     * @summary
      * Fetch a list of all scene drop ids in a world that include at least one asset with an interactivePublicKey
      *
-     * @usage
+     * @example
      * ```ts
      * await world.fetchSceneDropIds();
      * ```
      *
-     * @result
+     * @returns
      * ```ts
      * { sceneDropIds: [] }
      * ```
      */
     fetchSceneDropIds(): Promise<object | ResponseType$1>;
     /**
-     * @summary
      * Fetch a list of all scene drop ids and dropped assets in a world
      *
-     * @usage
+     * @category Scenes
+     *
+     * @example
      * ```ts
      * await world.fetchScenes();
      * ```
      *
-     * @result
+     * @returns
      * ```ts
      * { "scenes": {
      *     "sceneDropId_1": {
@@ -783,10 +830,11 @@ declare class World extends SDKController implements WorldInterface {
      */
     fetchScenes(): Promise<object | ResponseType$1>;
     /**
-     * @summary
      * Drops a scene in a world and returns sceneDropId.
      *
-     * @usage
+     * @category Scenes
+     *
+     * @example
      * ```ts
      * await world.dropScene({
      *   "sceneId": "string",
@@ -798,7 +846,7 @@ declare class World extends SDKController implements WorldInterface {
      * });
      * ```
      *
-     * @result
+     * @returns
      * ```ts
      * { sceneDropId: sceneId-timestamp, success: true }
      * ```
@@ -811,10 +859,11 @@ declare class World extends SDKController implements WorldInterface {
         sceneId: string;
     }): Promise<ResponseType$1>;
     /**
-     * @summary
      * Replace the current scene of a world.
      *
-     * @usage
+     * @category Scenes
+     *
+     * @example
      * ```ts
      * const droppedAssetsToUpdate = [world.droppedAssets["6"], world.droppedAssets["12"]]
      * const style = {
@@ -826,26 +875,34 @@ declare class World extends SDKController implements WorldInterface {
      * }
      * await world.replaceScene(SCENE_ID);
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns `{ success: true }` or an error.
      */
     replaceScene(sceneId: string): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Get all particles available
      *
-     * @usage
+     * @category Particles
+     *
+     * @example
      * ```ts
      * await world.getAllParticles();
+     *
+     * @returns {Promise<ResponseType>} Returns an array of particles or an error response.
      * ```
      */
     getAllParticles(): Promise<object | ResponseType$1>;
     /**
-     * @summary
      * Trigger a particle effect at a position in the world
      *
-     * @usage
+     * @category Particles
+     *
+     * @example
      * ```ts
      * await world.triggerParticle({ name: "Flame" });
      * ```
+     *
+     * @returns {Promise<ResponseType | string>} Returns `{ success: true }` or a message if no particleId is found.
      */
     triggerParticle({ id, name, duration, position, }: {
         id?: string;
@@ -854,14 +911,15 @@ declare class World extends SDKController implements WorldInterface {
         position?: object;
     }): Promise<ResponseType$1 | string>;
     /**
-     * @summary
      * Add an activity to a world
      * excludeFromNotification is an array of visitorIds to exclude from the notification
      *
-     * @usage
+     * @example
      * ```ts
      * await world.triggerActivity({ type: "GAME_ON", assetId: "abc123" });
      * ```
+     *
+     * @returns {Promise<ResponseType | string>} Returns the `activityId` or an error response.
      */
     triggerActivity({ type, assetId, excludeFromNotification, }: {
         type: WorldActivityType;
@@ -869,10 +927,9 @@ declare class World extends SDKController implements WorldInterface {
         excludeFromNotification?: (string | number)[];
     }): Promise<ResponseType$1 | string>;
     /**
-     * @summary
      * Display a message via a toast to all visitors currently in a world.
      *
-     * @usage
+     * @example
      * ```ts
      * await world.fireToast({
      *   groupId: "custom-message",
@@ -880,13 +937,16 @@ declare class World extends SDKController implements WorldInterface {
      *   text: "Thank you for participating!",
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns `{ success: true }` or an error.
      */
     fireToast({ groupId, title, text }: FireToastInterface): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Retrieves the data object for a world. Must have valid interactive credentials from a visitor in the world.
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
      * await world.fetchDataObject();
      * const { dataObject } = world;
@@ -894,17 +954,23 @@ declare class World extends SDKController implements WorldInterface {
      */
     fetchDataObject: (appPublicKey?: string, appJWT?: string) => Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Sets the data object for a user. Must have valid interactive credentials from a visitor in the world.
      *
+     * @remarks
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
-     * await world.setDataObject({
-     *   "exampleKey": "exampleValue",
-     * });
-     * const { dataObject } = world;
+      await world.setDataObject(
+        {
+          ...defaultGameData,
+          keyAssetId: droppedAsset.id,
+        },
+        { lock: { lock: { lockId: `${keyAssetId}-${new Date(Math.round(new Date().getTime() / 10000) * 10000)}` }, releaseLock: true } },
+      );
+     * const { profileMapper } = world.dataObject;
      * ```
      */
     setDataObject: (dataObject: object | null | undefined, options?: {
@@ -919,17 +985,20 @@ declare class World extends SDKController implements WorldInterface {
         };
     }) => Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Updates the data object for a world. Must have valid interactive credentials from a visitor in the world.
      *
+     * @remarks
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
      * await world.updateDataObject({
-     *   "exampleKey": "exampleValue",
+     *   [`keyAssets.${keyAssetId}.itemsCollectedByUser.${profileId}`]: { [dateKey]: { count: 1 }, total: 1 },
+     *   [`profileMapper.${profileId}`]: username,
      * });
-     * const { dataObject } = world;
+     * const { profileMapper } = world.dataObject;
      * ```
      */
     updateDataObject: (dataObject: object, options?: {
@@ -944,14 +1013,16 @@ declare class World extends SDKController implements WorldInterface {
         };
     }) => Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Increments a specific value in the data object for a world by the amount specified. Must have valid interactive credentials from a visitor in the world.
      *
+     * @remarks
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
-     * await world.incrementDataObjectValue("key", 1);
+     * await world.incrementDataObjectValue([`keyAssets.${keyAssetId}.totalItemsCollected.count`], 1);
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
@@ -966,10 +1037,11 @@ declare class World extends SDKController implements WorldInterface {
         };
     }): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Retrieve all webhooks in a world.
      *
-     * @usage
+     * @category Webhooks
+     *
+     * @example
      * ```ts
      * await world.fetchWebhooks();
      * const webhooks = world.webhooks;
@@ -977,10 +1049,11 @@ declare class World extends SDKController implements WorldInterface {
      */
     fetchWebhooks(): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Retrieve world analytics by day, week, month, quarter, or year
      *
-     * @usage
+     * @category Analytics
+     *
+     * @example
      * ```ts
      * const analytics = await world.fetchWorldAnalytics({
      *   periodType: "week",
@@ -997,12 +1070,11 @@ declare class World extends SDKController implements WorldInterface {
 }
 
 /**
- * @summary
  * Create an instance of User class with optional session credentials.
  *
- * @usage
+ * @example
  * ```ts
- * await new User(topia, {
+ * const user = await new User(topia, {
  *   profileId: 1,
  *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
  * });
@@ -1026,31 +1098,26 @@ declare class User extends SDKController implements UserInterface {
     get worlds(): {
         [key: string]: World;
     };
-    /**
-     * @summary
-     * Verify user has valid interactive credentials
-     *
-     * @usage
-     * ```ts
-     * await user.checkInteractiveCredentials();
-     * ```
-     */
     checkInteractiveCredentials(): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Returns all avatars owned by User
      *
-     * @usage
+     * @category Avatars
+     *
+     * @example
      * ```ts
      * const avatars = await user.fetchAvatars();
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the avatars or an error.
      */
     fetchAvatars(): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Add a new avatar
      *
-     * @usage
+     * @category Avatars
+     *
+     * @example
      * ```ts
      * const animationMeta = {
      *   "emote": { "loop": false, "x": 0, "y": 0, "hideLoop": true }
@@ -1118,10 +1185,11 @@ declare class User extends SDKController implements UserInterface {
      */
     addAvatar(formData: FormData): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Update avatar and sprite sheet records and upload files to existing sprite sheet and avatar storage buckets
      *
-     * @usage
+     * @category Avatars
+     *
+     * @example
      * ```ts
      * const animationMeta = {
      *   "emote": { "loop": false, "x": 0, "y": 0, "hideLoop": true }
@@ -1189,20 +1257,22 @@ declare class User extends SDKController implements UserInterface {
      */
     updateAvatar(avatarId: string, formData: FormData): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Update avatar and sprite sheet records and upload files to existing sprite sheet and avatar storage buckets
      *
-     * @usage
+     * @category Avatars
+     *
+     * @example
      * ```ts
      * await user.deleteAvatar("exampleAvatarId");
      * ```
      */
     deleteAvatar(avatarId: string): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Returns all assets owned by User when an email address is provided.
      *
-     * @usage
+     * @category Assets
+     *
+     * @example
      * ```ts
      * await user.fetchAssets();
      * const userAssets = user.assets;
@@ -1210,20 +1280,24 @@ declare class User extends SDKController implements UserInterface {
      */
     fetchAssets(): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Returns all platform assets.
      *
-     * @usage
+     * @category Assets
+     *
+     * @example
      * ```ts
      * const assets = await user.fetchPlatformAssets();
      * ```
+     *
+     * @returns {Promise<object | ResponseType>} Returns the platform assets or an error response.
      */
     fetchPlatformAssets(): Promise<object | ResponseType$1>;
     /**
-     * @summary
      * Returns all scenes owned by User.
      *
-     * @usage
+     * @category Scenes
+     *
+     * @example
      * ```ts
      * await user.fetchScenes();
      * const userScenes = user.scenes;
@@ -1231,30 +1305,28 @@ declare class User extends SDKController implements UserInterface {
      */
     fetchScenes(): Promise<void | ResponseType$1>;
     /**
-     * @summary
-     * Retrieves all worlds owned by user with matching API Key,
-     * creates a new World object for each,
-     * and creates new map of Worlds accessible via user.worlds.
+     * Retrieves all worlds owned by user with matching API Key, creates a new World object for each, and creates new map of Worlds accessible via user.worlds.
+     *
+     * @category Worlds
      *
-     * @usage
+     * @example
      * ```ts
      * await user.fetchWorldsByKey();
      * const userWorlds = user.worlds;
      * ```
      *
-     * @result
+     * @returns
      * ```ts
      * { urlSlug: new World({ apiKey, worldArgs, urlSlug }) }
      * ```
      */
     fetchWorldsByKey(): Promise<void | ResponseType$1>;
     /**
-     * @summary
-     * Retrieves all worlds a user with matching API Key is an admin in,
-     * creates a new World object for each,
-     * and creates new map of Worlds accessible via user.adminWorlds.
+     * Retrieves all worlds a user with matching API Key is an admin in, creates a new World object for each, and creates new map of Worlds accessible via user.adminWorlds.
+     *
+     * @category Worlds
      *
-     * @usage
+     * @example
      * ```ts
      * await user.fetchAdminWorldsByKey();
      * const adminWorlds = user.adminWorlds;
@@ -1262,25 +1334,29 @@ declare class User extends SDKController implements UserInterface {
      */
     fetchAdminWorldsByKey(): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Retrieves ids of all dropped assets in all worlds with a matching interactivePublicKey.
      *
-     * @usage
+     * @category Dropped Assets
+     *
+     * @example
      * ```ts
      * await user.fetchInteractiveWorldsByKey("interactivePublicKeyExample");
      * const interactiveWorlds = user.interactiveWorlds;
      * ```
+     *
+     * @returns {Promise<object | ResponseType>} Returns the `urlSlugs` of worlds where the Public Key is found or an error response.
      */
     fetchInteractiveWorldsByKey(interactivePublicKey: string): Promise<object | ResponseType$1>;
     /**
-     * @summary
      * Send an email
      *
-     * @usage
+     * @example
      * ```ts
      * const html = `<p><b>Hello World!</b></p><p>This email is being sent from via SDK.</p>`
      * await user.sendEmail({ html, subject: "Example", to: "example@email.io" });
      * ```
+     *
+     * @returns {Promise<object | ResponseType>} Returns `{ success: true }` if the email is sent successfully or an error response.
      */
     sendEmail({ html, subject, to, }: {
         html: string;
@@ -1288,39 +1364,53 @@ declare class User extends SDKController implements UserInterface {
         to: string;
     }): Promise<object | ResponseType$1>;
     /**
-     * @summary
      * Get expressions
      *
-     * @usage
+     * @category Expressions
+     *
+     * @example
      * ```ts
      * await user.getExpressions({ getUnlockablesOnly: true, });
      * ```
+     *
+     * @returns {Promise<ResponseType>} Returns an array of expressions or an error response.
      */
     getExpressions({ name, getUnlockablesOnly, }: {
         name?: string;
         getUnlockablesOnly?: boolean;
     }): Promise<ResponseType$1>;
     /**
-     * @summary
      * Retrieves the data object for a user.
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
      * const dataObject = await user.fetchDataObject();
      * ```
+     *
+     * @returns {Promise<object | ResponseType>} Returns the data object or an error response.
      */
     fetchDataObject(appPublicKey?: string, appJWT?: string): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Sets the data object for a user.
      *
+     * @remarks
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
-     * await user.setDataObject({
-     *   "exampleKey": "exampleValue",
-     * });
+     * await user.setDataObject(
+     *   { itemsCollected: 0 },
+     *   {
+     *     analytics: [{ analyticName: "resets"} ],
+     *     lock: { lockId: `${assetId}-${itemsCollected}-${new Date(Math.round(new Date().getTime() / 10000) * 10000)}` },
+     *   },
+     * );
+     *
+     * const { itemsCollected } = user.dataObject;
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
@@ -1335,16 +1425,22 @@ declare class User extends SDKController implements UserInterface {
         };
     }): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Updates the data object for a user.
      *
+     * @remarks
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
+     * const theme = "exampleTheme";
+     *
      * await user.updateDataObject({
-     *   "exampleKey": "exampleValue",
+     *   [`${theme}.itemsCollectedByUser`]: { [dateKey]: { count: 1 }, total: 1 },
      * });
+     *
+     * const { exampleTheme } = user.dataObject;
      * ```
      */
     updateDataObject(dataObject: object, options?: {
@@ -1359,12 +1455,14 @@ declare class User extends SDKController implements UserInterface {
         };
     }): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Increments a specific value in the data object for a user by the amount specified. Must have valid interactive credentials from a visitor in the world.
      *
+     * @remarks
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
      * await user.incrementDataObjectValue("key", 1);
      * ```
@@ -1383,12 +1481,11 @@ declare class User extends SDKController implements UserInterface {
 }
 
 /**
- * @summary
  * Create an instance of Visitor class with a given id and optional attributes and session credentials.
  *
- * @usage
+ * @example
  * ```ts
- * await new Visitor(topia, id, urlSlug, { attributes: { moveTo: { x: 0, y: 0 } }, credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" } });
+ * const visitor = await new Visitor(topia, id, urlSlug, { attributes: { moveTo: { x: 0, y: 0 } }, credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" } });
  * ```
  */
 declare class Visitor extends User implements VisitorInterface {
@@ -1397,23 +1494,21 @@ declare class Visitor extends User implements VisitorInterface {
     user?: User;
     constructor(topia: Topia, id: number, urlSlug: string, options?: VisitorOptionalInterface);
     /**
-     * @summary
      * Get a single visitor from a world
      *
-     * @usage
+     * @example
      * ```ts
      * await visitor.fetchVisitor();
      * ```
      *
-     * @result
+     * @returns
      * Returns details for a visitor in a world by id and urlSlug
      */
     fetchVisitor(): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Teleport or walk a visitor currently in a world to a single set of coordinates.
      *
-     * @usage
+     * @example
      * ```ts
      * await visitor.moveVisitor({
      *   shouldTeleportVisitor: true,
@@ -1422,15 +1517,14 @@ declare class Visitor extends User implements VisitorInterface {
      * });
      * ```
      *
-     * @result
-     * Updates each Visitor instance and world.visitors map.
+     * @returns
+     * Returns `{ success: true }` if the visitor was moved successfully.
      */
     moveVisitor({ shouldTeleportVisitor, x, y }: MoveVisitorInterface): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Display a message via a toast to a visitor currently in a world.
      *
-     * @usage
+     * @example
      * ```ts
      * await visitor.fireToast({
      *   groupId: "custom-message",
@@ -1438,13 +1532,16 @@ declare class Visitor extends User implements VisitorInterface {
      *   text: "Thank you for participating!",
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns `{ success: true }` or an error.
      */
     fireToast({ groupId, title, text }: FireToastInterface): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Open an iframe in a drawer or modal for a visitor currently in a world.
      *
-     * @usage
+     * @category iframes
+     *
+     * @example
      * ```ts
      * await visitor.openIframe({
      *   droppedAssetId: "droppedAssetId",
@@ -1453,83 +1550,103 @@ declare class Visitor extends User implements VisitorInterface {
      *   title: "Hello World",
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns `{ success: true }` or an error.
      */
     openIframe({ droppedAssetId, link, shouldOpenInDrawer, title, }: OpenIframeInterface): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Reload an iframe for a visitor currently in a world.
      *
-     * @usage
+     * @category iframes
+     *
+     * @example
      * ```ts
      * await visitor.reloadIframe("droppedAssetId");
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns `{ success: true }` or an error.
      */
     reloadIframe(droppedAssetId: string): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Close an iframe for a visitor currently in a world.
      *
-     * @usage
+     * @category iframes
+     *
+     * @example
      * ```ts
      * await visitor.closeIframe("droppedAssetId");
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns `{ success: true }` or an error.
      */
     closeIframe(droppedAssetId: string): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Mute and turn video off for a visitor currently in a world.
      *
-     * @usage
+     * @example
      * ```ts
      * await visitor.turnAVOff();
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns `{ success: true }` or an error.
      */
     turnAVOff(): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Get expressions
      *
-     * @usage
+     * @category Expressions
+     *
+     * @example
      * ```ts
      * await visitor.getExpressions({ getUnlockablesOnly: true, });
      * ```
+     * @returns {Promise<ResponseType>} Returns an array of expressions or an error response.
      */
     getExpressions({ name, getUnlockablesOnly, }: {
         name?: string;
         getUnlockablesOnly?: boolean;
     }): Promise<ResponseType$1>;
     /**
-     * @summary
      * Grant expression to a visitor by id or name.
      *
-     * @usage
+     * @category Expressions
+     *
+     * @example
      * ```ts
      * await visitor.grantExpression({ id: "exampleExpressionId" });
      * await visitor.grantExpression({ name: "exampleExpressionName" });
      * ```
+     *
+     * @returns {Promise<ResponseType>} Returns `{ success: true }` if the expression was granted successfully or an error response.
      */
     grantExpression({ id, name }: {
         id?: string;
         name?: string;
     }): Promise<ResponseType$1>;
     /**
-     * @summary
      * Get all particles available
      *
-     * @usage
+     * @category Particle Effects
+     *
+     * @example
      * ```ts
      * await visitor.getAllParticles();
      * ```
+     *
+     * @returns {Promise<ResponseType>} Returns an array of particles or an error response.
      */
     getAllParticles(): Promise<ResponseType$1>;
     /**
-     * @summary
      * Trigger a particle effect on a visitor
      *
-     * @usage
+     * @category Particle Effects
+     *
+     * @example
      * ```ts
      * await visitor.triggerParticle({ name: "Flame" });
      * ```
+     *
+     * @returns {Promise<ResponseType | string>} Returns `{ success: true }` or a message if no particleId is found.
      */
     triggerParticle({ id, name, duration, }: {
         id?: string;
@@ -1537,26 +1654,37 @@ declare class Visitor extends User implements VisitorInterface {
         duration?: number;
     }): Promise<ResponseType$1 | string>;
     /**
-     * @summary
      * Retrieves the data object for a visitor.
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
      * const dataObject = await visitor.fetchDataObject();
      * ```
+     *
+     * @returns {Promise<object | ResponseType>} Returns the data object or an error response.
      */
     fetchDataObject(appPublicKey?: string, appJWT?: string): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Sets the data object for a visitor.
      *
+     * @remarks
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
-     * await visitor.setDataObject({
-     *   "exampleKey": "exampleValue",
-     * });
+     * await visitor.setDataObject(
+     *   { itemsCollected: 0 },
+     *   {
+     *     analytics: [{ analyticName: "resets"} ],
+     *     lock: { lockId: `${assetId}-${itemsCollected}-${new Date(Math.round(new Date().getTime() / 10000) * 10000)}` },
+     *   },
+     * );
+     *
+     * const { itemsCollected } = visitor.dataObject;
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
@@ -1571,16 +1699,22 @@ declare class Visitor extends User implements VisitorInterface {
         };
     }): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Updates the data object for a visitor.
      *
+     * @remarks
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
+     * const theme = "exampleTheme";
+     *
      * await visitor.updateDataObject({
-     *   "exampleKey": "exampleValue",
+     *   [`${theme}.itemsCollectedByUser`]: { [dateKey]: { count: 1 }, total: 1 },
      * });
+     *
+     * const { exampleTheme } = visitor.dataObject;
      * ```
      */
     updateDataObject(dataObject: object, options?: {
@@ -1595,12 +1729,14 @@ declare class Visitor extends User implements VisitorInterface {
         };
     }): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Increments a specific value in the data object for a visitor by the amount specified. Must have valid interactive credentials from a visitor in the world.
      *
+     * @remarks
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
      * await visitor.incrementDataObjectValue("key", 1);
      * ```
@@ -1617,20 +1753,18 @@ declare class Visitor extends User implements VisitorInterface {
         };
     }): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Update analytics for a given public key. Must have valid interactive credentials from a visitor in the world.
      *
-     * @usage
+     * @example
      * ```ts
      * await visitor.updatePublicKeyAnalytics([{ analyticName: "joins", profileId, uniqueKey: profileId, urlSlug }]);
      * ```
      */
     updatePublicKeyAnalytics(analytics?: AnalyticType[]): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Setup signal to visitor
      *
-     * @usage
+     * @example
      * ```ts
      * await visitor.sendSignalToVisitor(iceServers);
      * ```
@@ -1745,7 +1879,7 @@ interface DroppedAssetInterface extends AssetInterface {
     assetId?: string;
     assetScale?: number | null;
     assetPodium?: boolean | null;
-    audioRadius?: number | null;
+    audioRadius?: DroppedAssetMediaVolumeRadius | number | null;
     assetBroadcastAll?: boolean | null;
     assetPrivateConversation?: boolean | null;
     assetPrivateZoneChannelDisabled?: boolean | null;
@@ -1753,6 +1887,7 @@ interface DroppedAssetInterface extends AssetInterface {
     audioSliderVolume?: number | null;
     bottomLayerURL?: string | null;
     broadcasterEmail?: string | null;
+    clickableLinks?: Array<DroppedAssetClickType> | null;
     clickType?: string | null;
     clickableLink?: string | null;
     clickableLinkTitle?: string | null;
@@ -1824,6 +1959,8 @@ interface UpdateBroadcastInterface {
 }
 interface UpdateDroppedAssetInterface {
     assetScale?: number;
+    audioRadius?: DroppedAssetMediaVolumeRadius | number;
+    audioSliderVolume?: number;
     clickType?: DroppedAssetClickType;
     clickableLink?: string;
     clickableLinkTitle?: string;
@@ -1832,14 +1969,20 @@ interface UpdateDroppedAssetInterface {
     flipped?: boolean;
     isInteractive?: boolean;
     isTextTopLayer?: boolean;
+    isVideo?: boolean;
     interactivePublicKey?: string;
     layer0?: string;
     layer1?: string;
+    mediaLink?: string;
+    mediaName?: string;
+    mediaType?: DroppedAssetMediaType;
     position?: {
         x: number;
         y: number;
     };
+    portalName?: string;
     specialType?: string;
+    syncUserMedia?: boolean;
     text?: string | null;
     textColor?: string | null;
     textSize?: number | null;
@@ -1877,7 +2020,7 @@ interface RemoveClickableLinkInterface {
     linkId: string;
 }
 interface UpdateMediaTypeInterface {
-    audioRadius: number;
+    audioRadius: DroppedAssetMediaVolumeRadius | number;
     audioSliderVolume: number;
     isVideo: boolean;
     mediaLink: string;
@@ -2109,10 +2252,9 @@ interface WorldWebhooksInterface {
 }
 
 /**
- * @summary
  * Create a single instance of Topia axios used for all calls to the public API in all classes
  *
- * @usage
+ * @example
  * ```ts
  * const topia = await new Topia({
  *   apiDomain: "api.topia.io",
@@ -2141,10 +2283,9 @@ declare class Topia implements TopiaInterface {
 }
 
 /**
- * @summary
  * Create an instance of SDKController class with credentials.
  *
- * @usage
+ * @example
  * ```ts
  * const credentials = {
  *   assetId: "exampleAsset",
@@ -2189,12 +2330,11 @@ declare abstract class SDKController implements SDKInterface {
 }
 
 /**
- * @summary
  * Create an instance of Asset class with a given asset id and optional attributes and session credentials.
  *
- * @usage
+ * @example
  * ```ts
- * await new Asset(topia, "id", {
+ * const asset = await new Asset(topia, "id", {
  *   attributes: { assetName: "My Asset", isPublic: false },
  *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
  * });
@@ -2204,21 +2344,21 @@ declare class Asset extends SDKController implements AssetInterface {
     readonly id?: string;
     constructor(topia: Topia, id: string, options?: AssetOptionalInterface);
     /**
-     * @summary
-     * Retrieves platform asset details.
+     * Retrieves platform asset details and assigns response data to the instance.
      *
-     * @usage
+     * @example
      * ```ts
      * await asset.fetchAssetById();
      * const { assetName } = asset;
      * ```
+     *
+     * @returns {Promise<object | ResponseType>} Returns the asset details or an error response.
      */
     fetchAssetById(): Promise<object | ResponseType$1>;
     /**
-     * @summary
      * Updates platform asset details.
      *
-     * @usage
+     * @example
      * ```ts
      * await asset.updateAsset({
      *   assetName: "exampleAsset",
@@ -2244,12 +2384,11 @@ declare class Asset extends SDKController implements AssetInterface {
 }
 
 /**
- * @summary
  * Create an instance of Ecosystem class with optional session credentials
  *
- * @usage
+ * @example
  * ```ts
- * await new Ecosystem(topia, {
+ * const ecosystem =await new Ecosystem(topia, {
  *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
  * });
  * ```
@@ -2258,27 +2397,35 @@ declare class Ecosystem extends SDKController {
     dataObject?: object | null | undefined;
     constructor(topia: Topia, options?: EcosystemOptionalInterface);
     /**
-     * @summary
      * Retrieves the data object for a Topia ecosystem. Requires canUpdateEcosystemDataObjects permission to be set to true for the public key.
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
      * const dataObject = await ecosystem.fetchDataObject("exampleAppPublicKey", "exampleAppPublicKeyJWT");
      * ```
+     *
+     * @returns {Promise<object | ResponseType>} Returns the data object or an error response.
      */
     fetchDataObject(appPublicKey?: string, appJWT?: string): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Sets the data object for a Topia ecosystem.
      *
+     * @remarks
+     * This method also allows you to set a data object on behalf of another Public Key. It requires `canUpdateEcosystemDataObjects` permission to be set to true for the Public Key.
+     *
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
      * await ecosystem.setDataObject({ "exampleKey": "exampleValue" }, {
      *   sharedAppPublicKey: "exampleAppPublicKey",
      *   sharedAppJWT: "exampleAppPublicKeyJWT",}
      * });
+     * const { exampleKey } = ecosystem.dataObject;
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
@@ -2293,17 +2440,28 @@ declare class Ecosystem extends SDKController {
         };
     }): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Updates the data object for a Topia ecosystem.
      *
+     * @remarks
+     * This method also allows you to update a data object on behalf of another Public Key. It requires `canUpdateEcosystemDataObjects` permission to be set to true for the Public Key.
+     *
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
-     * await ecosystem.updateDataObject({ "exampleKey": "exampleValue" }, {
-     *   sharedAppPublicKey: "exampleAppPublicKey",
-     *   sharedAppJWT: "exampleAppPublicKeyJWT",}
+     * await ecosystem.updateDataObject({
+     *    [`profiles.${profileId}.itemsCollectedByUser`]: { [dateKey]: { count: 1 }, total: 1 },
+     *    [`profileMapper.${profileId}`]: username,
+     *  }, {
+     *    sharedAppPublicKey: "exampleAppPublicKey",
+     *    sharedAppJWT: "exampleAppPublicKeyJWT",
+     *    analytics: [{ analyticName: "itemCollected", profileId, uniqueKey: profileId, urlSlug } ],
+     *    lock: { lockId: `${assetId}-${resetCount}-${new Date(Math.round(new Date().getTime() / 10000) * 10000)}` },
+     *  }
      * });
+     * const { exampleKey } = ecosystem.dataObject;
      * ```
      */
     updateDataObject(dataObject: object, options?: {
@@ -2318,12 +2476,16 @@ declare class Ecosystem extends SDKController {
         };
     }): Promise<void | ResponseType$1>;
     /**
-     * @summary
      * Increments a specific value in the data object for a Topia ecosystem by the amount specified. Must have valid interactive credentials from a visitor in the world.
      *
+     * @remarks
+     * This method also allows you to increment a data object value on behalf of another Public Key. It requires `canUpdateEcosystemDataObjects` permission to be set to true for the Public Key.
+     *
      * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
      *
-     * @usage
+     * @category Data Objects
+     *
+     * @example
      * ```ts
      * await ecosystem.incrementDataObjectValue("key", 1, {
      *   sharedAppPublicKey: "exampleAppPublicKey",
@@ -2345,12 +2507,11 @@ declare class Ecosystem extends SDKController {
 }
 
 /**
- * @summary
  * Create an instance of WebRTCConnector class with optional session credentials.
  *
- * @usage
+ * @example
  * ```ts
- * await new WebRTCConnector(topia, {
+ * const webRTC = await new WebRTCConnector(topia, {
  *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
  * });
  * ```
@@ -2360,10 +2521,9 @@ declare class WebRTCConnector extends SDKController implements WebRTCConnectorIn
     urlSlug: string;
     constructor(topia: Topia, urlSlug: string, options?: WebRTCConnectorOptionalInterface);
     /**
-     * @summary
      * Get twilio
      *
-     * @usage
+     * @example
      * ```ts
      * await webRTCConnector.getTwilioConfig();
      * ```
@@ -2372,14 +2532,14 @@ declare class WebRTCConnector extends SDKController implements WebRTCConnectorIn
 }
 
 /**
- * @summary
  * Create an instance of WorldActivity class with a given url slug and optional attributes and session credentials.
  *
+ * @remarks
  * This class is responsible for all activity of a specified world including editing dropped assets, moving current visitors, etc.
  *
- * @usage
+ * @example
  * ```ts
- * await new WorldActivity(topia, "exampleWorld", {
+ * const activity = await new WorldActivity(topia, "exampleWorld", {
  *   attributes: { name: "Example World" },
  *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
  * });
@@ -2394,25 +2554,31 @@ declare class WorldActivity extends SDKController {
     };
     private fetchVisitors;
     /**
-     * @summary
      * Retrieve all visitors currently in a world.
      *
-     * @usage
+     * @category Visitors
+     *
+     * @example
      * ```ts
      * const visitors = await worldActivity.currentVisitors("exampleLandmarkZoneId", true);
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the an object containing current visitors keyed by visitorId or an error.
      */
     currentVisitors(shouldIncludeAdminPermissions?: boolean): Promise<{
         [key: string]: Visitor;
     }>;
     /**
-     * @summary
      * Retrieve all visitors currently in a Landmark Zone.
      *
-     * @usage
+     * @category Visitors
+     *
+     * @example
      * ```ts
      * const visitors = await worldActivity.fetchVisitorsInZone({ droppedAssetId: "exampleDroppedAssetId" });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the an object containing current visitors keyed by visitorId or an error.
      */
     fetchVisitorsInZone({ droppedAssetId, shouldIncludeAdminPermissions, }: {
         droppedAssetId?: string;
@@ -2421,12 +2587,15 @@ declare class WorldActivity extends SDKController {
         [key: string]: Visitor;
     }>;
     /**
-     * @summary
      * Move all visitors currently in a world to a single set of coordinates.
+     *
+     * @remarks
      * Optionally refetch visitors, teleport or walk visitors to new location,
      * and scatter visitors by any number so that they don't all move to the exact same location.
      *
-     * @usage
+     * @category Visitors
+     *
+     * @example
      * ```ts
      * await worldActivity.moveAllVisitors({
      *   shouldFetchVisitors: true,
@@ -2437,15 +2606,16 @@ declare class WorldActivity extends SDKController {
      * });
      * ```
      *
-     * @result
+     * @returns
      * Updates each Visitor instance and worldActivity.visitors map.
      */
     moveAllVisitors({ shouldFetchVisitors, shouldTeleportVisitors, scatterVisitorsBy, x, y, }: MoveAllVisitorsInterface): Promise<(void | ResponseType$1)[] | undefined>;
     /**
-     * @summary
      * Teleport or walk a list of visitors currently in a world to various coordinates.
      *
-     * @usage
+     * @category Visitors
+     *
+     * @example
      * ```ts
      * const visitorsToMove = [
      *   {
@@ -2463,14 +2633,14 @@ declare class WorldActivity extends SDKController {
      * await worldActivity.moveVisitors(visitorsToMove);
      * ```
      *
-     * @result
+     * @returns
      * Updates each Visitor instance and worldActivity.visitors map.
      */
     moveVisitors(visitorsToMove: VisitorsToMoveArrayType): Promise<(void | ResponseType$1)[]>;
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const Asset = new AssetFactory(myTopiaInstance);
  * ```
@@ -2478,20 +2648,20 @@ declare class WorldActivity extends SDKController {
 declare class AssetFactory extends SDKController {
     constructor(topia: Topia);
     /**
-     * @summary
      * Instantiate a new instance of Asset class.
      *
-     * @usage
+     * @example
      * ```
      * const assetInstance = await Asset.create(id, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
      * ```
+     *
+     * @returns {Asset} Returns a new Asset object with the asset id.
      */
     create(id: string, options?: AssetOptionalInterface): Asset;
     /**
-     * @summary
      * Upload a new Asset and return a new instance of Asset class.
      *
-     * @usage
+     * @example
      * ```
      * const assetPayload = {
      *   assetName: "exampleAssetName"
@@ -2503,12 +2673,14 @@ declare class AssetFactory extends SDKController {
      * }
      * const asset = await Asset.upload(assetPayload, apiKey);
      * ```
+     *
+     * @returns {AssetType} Returns a new Asset object with the asset details.
      */
     upload(assetPayload: AssetType, apiKey: string): Promise<Asset>;
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const DroppedAsset = new DroppedAssetFactory(myTopiaInstance);
  * ```
@@ -2516,43 +2688,45 @@ declare class AssetFactory extends SDKController {
 declare class DroppedAssetFactory extends SDKController {
     constructor(topia: Topia);
     /**
-     * @summary
      * Instantiate a new instance of DroppedAsset class.
      *
-     * @usage
+     * @example
      * ```
      * const droppedAssetInstance = await DroppedAsset.create(assetId, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
      * ```
+     *
+     * @returns {DroppedAsset} Returns a new DroppedAsset object.
      */
     create(id: string, urlSlug: string, options?: DroppedAssetOptionalInterface): DroppedAsset;
     /**
-     * @summary
      * Instantiate a new instance of DroppedAsset class and retrieve all properties.
      *
-     * @usage
+     * @example
      * ```
      * const droppedAssetInstance = await DroppedAsset.get(assetId, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
      * ```
+     *
+     * @returns {Promise<DroppedAsset>} Returns a new DroppedAsset object with all properties.
      */
     get(id: string, urlSlug: string, options?: DroppedAssetOptionalInterface): Promise<DroppedAsset>;
     /**
-     * @summary
      * Searches dropped assets within a world by a provide `uniqueName`. If a single match is found, a new instance of DroppedAsset class is returned all properties.
      *
-     * @usage
+     * @remarks
+     * This method leverages the handleGetDroppedAssetByUniqueName endpoint in the Public API and assumes there is exactly one dropped asset with matching uniqueName for the given urlSlug.
+     *
+     * @example
      * ```
      * const droppedAssetInstance = await DroppedAsset.getWithUniqueName("exampleUniqueName", urlSlug, interactiveSecret, credentials);
      * ```
      *
-     * @notes
-     * This method leverages the handleGetDroppedAssetByUniqueName endpoint in the Public API and assumes there is exactly one dropped asset with matching uniqueName for the given urlSlug.
+     * @returns {Promise<DroppedAsset>} Returns a new DroppedAsset object with all properties.
      */
     getWithUniqueName(uniqueName: string, urlSlug: string, interactiveSecret: string, credentials: InteractiveCredentials): Promise<DroppedAsset>;
     /**
-     * @summary
      * Drops an asset in a world and returns a new instance of DroppedAsset class with all properties.
      *
-     * @usage
+     * @example
      * ```
      * const assetInstance = await Asset.create(id, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
      * const droppedAssetInstance = await DroppedAsset.get(assetInstance, {
@@ -2567,6 +2741,8 @@ declare class DroppedAssetFactory extends SDKController {
           urlSlug,
         });
      * ```
+     *
+     * @returns {Promise<DroppedAsset>} Returns a new DroppedAsset object with all properties.
      */
     drop(asset: Asset, { assetScale, clickType, clickableDisplayTextDescription, clickableDisplayTextHeadline, clickableLink, clickableLinkTitle, flipped, interactivePublicKey, isInteractive, isForceLinkInIframe, isOpenLinkInDrawer, isTextTopLayer, layer0, layer1, position: { x, y }, sceneDropId, text, textColor, textFontFamily, textSize, textWeight, textWidth, uniqueName, urlSlug, yOrderAdjust, }: {
         assetScale?: number;
@@ -2601,7 +2777,7 @@ declare class DroppedAssetFactory extends SDKController {
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const Ecosystem = new EcosystemFactory(myTopiaInstance);
  * ```
@@ -2610,19 +2786,20 @@ declare class EcosystemFactory {
     topia: Topia;
     constructor(topia: Topia);
     /**
-     * @summary
      * Instantiate a new instance of Ecosystem class.
      *
-     * @usage
+     * @example
      * ```
      * const ecosystemInstance = await Ecosystem.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId }});
      * ```
+     *
+     * @returns {Ecosystem} Returns a new Ecosystem object.
      */
     create(options?: EcosystemOptionalInterface): Ecosystem;
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const Scene = new SceneFactory(myTopiaInstance);
  * ```
@@ -2631,29 +2808,31 @@ declare class SceneFactory {
     topia: Topia;
     constructor(topia: Topia);
     /**
-     * @summary
      * Instantiate a new instance of Scene class.
      *
-     * @usage
+     * @example
      * ```
      * const sceneInstance = await Scene.create(id, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
      * ```
+     *
+     * @returns {Scene} Returns a new Scene object.
      */
     create(id: string, options?: SceneOptionalInterface): Scene;
     /**
-     * @summary
      * Instantiate a new instance of Scene class and retrieve all properties.
      *
-     * @usage
+     * @example
      * ```
      * const sceneInstance = await Scene.get(id, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
      * ```
+     *
+     * @returns {Promise<Scene>} Returns a new Scene object with all properties.
      */
     get(id: string, options?: SceneOptionalInterface): Promise<Scene>;
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const User = new UserFactory(myTopiaInstance);
  * ```
@@ -2662,19 +2841,20 @@ declare class UserFactory {
     topia: Topia;
     constructor(topia: Topia);
     /**
-     * @summary
      * Instantiate a new instance of User class.
      *
-     * @usage
+     * @example
      * ```
      * const userInstance = await User.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
      * ```
+     *
+     * @returns {User} Returns a new User object.
      */
     create(options?: UserOptionalInterface): User;
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const Visitor = new VisitorFactory(myTopiaInstance);
  * ```
@@ -2683,29 +2863,31 @@ declare class VisitorFactory {
     topia: Topia;
     constructor(topia: Topia);
     /**
-     * @summary
      * Instantiate a new instance of Visitor class.
      *
-     * @usage
+     * @example
      * ```
      * const visitorInstance = await Visitor.create(id, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
      * ```
+     *
+     * @returns {Visitor} Returns a new Visitor object.
      */
     create(id: number, urlSlug: string, options?: VisitorOptionalInterface): Visitor;
     /**
-     * @summary
      * Instantiate a new instance of Visitor class and retrieve all properties.
      *
-     * @usage
+     * @example
      * ```
      * const visitorInstance = await Visitor.get(id, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
      * ```
+     *
+     * @returns {Promise<Visitor>} Returns a new Visitor object with all properties.
      */
     get(id: number, urlSlug: string, options?: VisitorOptionalInterface): Promise<Visitor>;
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const WebRTCConnector = new WebRTCConnectorFactory(myTopiaInstance);
  * ```
@@ -2714,19 +2896,20 @@ declare class WebRTCConnectorFactory {
     topia: Topia;
     constructor(topia: Topia);
     /**
-     * @summary
      * Instantiate a new instance of WebRTCConnector class.
      *
-     * @usage
+     * @example
      * ```
      * const webRTCInstance = await WebRTCConnector.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId }, twilioConfig: {} });
      * ```
+     *
+     * @returns {WebRTCConnector} Returns a new WebRTCConnector object.
      */
     create(urlSlug: string, options?: WebRTCConnectorOptionalInterface): WebRTCConnector;
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const WorldActivity = new WorldActivityFactory(myTopiaInstance);
  * ```
@@ -2735,19 +2918,20 @@ declare class WorldActivityFactory {
     topia: Topia;
     constructor(topia: Topia);
     /**
-     * @summary
      * Instantiate a new instance of WorldActivity class.
      *
-     * @usage
+     * @example
      * ```
      * const worldActivityInstance = await WorldActivity.create(urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
      * ```
+     *
+     * @returns {WorldActivity} Returns a new WorldActivity object.
      */
     create(urlSlug: string, options?: WorldOptionalInterface): WorldActivity;
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const World = new WorldFactory(myTopiaInstance);
  * ```
@@ -2755,23 +2939,25 @@ declare class WorldActivityFactory {
 declare class WorldFactory extends SDKController {
     constructor(topia: Topia);
     /**
-     * @summary
      * Instantiate a new instance of World class.
      *
-     * @usage
+     * @example
      * ```
      * const worldInstance = await World.create(urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
      * ```
+     *
+     * @returns {World} Returns a new World object.
      */
     create(urlSlug: string, options?: WorldOptionalInterface): World;
     /**
-     * @summary
      * Deletes an array of Dropped Assets from within a world and returns success: true
      *
-     * @usage
+     * @example
      * ```
      * await World.deleteDroppedAssets(urlSlug, ["exampleDroppedAssetId1", "exampleDroppedAssetId2"], interactiveSecret, credentials);
      * ```
+     *
+     * @returns {Promise<{ success: boolean }>} Returns `{ success: true }` or an error.
      */
     deleteDroppedAssets(urlSlug: string, droppedAssetIds: string[], interactiveSecret: string, credentials: {
         apiKey?: string;
@@ -2783,4 +2969,4 @@ declare class WorldFactory extends SDKController {
     }>;
 }
 
-export { AnalyticType, AnimationMetaType, Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, AssetType, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetLinkType, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, Ecosystem, EcosystemFactory, EcosystemInterface, EcosystemOptionalInterface, FireToastInterface, FrameType, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, RemoveClickableLinkInterface, ResponseType$1 as ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, SetClickableLinkMultiInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateClickableLinkMultiInterface, UpdateDroppedAssetInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WebRTCConnector, WebRTCConnectorFactory, WebRTCConnectorInterface, WebRTCConnectorOptionalInterface, WebhookInterface, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldActivityType, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };
+export { AnalyticType, AnimationMetaType, Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, AssetType, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetLinkType, DroppedAssetMediaType, DroppedAssetMediaVolumeRadius, DroppedAssetOptionalInterface, DroppedAssetOptions, Ecosystem, EcosystemFactory, EcosystemInterface, EcosystemOptionalInterface, FireToastInterface, FrameType, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, RemoveClickableLinkInterface, ResponseType$1 as ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, SetClickableLinkMultiInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateClickableLinkMultiInterface, UpdateDroppedAssetInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WebRTCConnector, WebRTCConnectorFactory, WebRTCConnectorInterface, WebRTCConnectorOptionalInterface, WebhookInterface, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldActivityType, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };