@rtsdk/topia 0.17.0 → 0.17.2

package/dist/index.js

@@ -39612,10 +39612,9 @@ const {
 
 // utils
 /**
- * @summary
  * Create an instance of SDKController class with credentials.
  *
- * @usage
+ * @example
  * ```ts
  * const credentials = {
  *   assetId: "exampleAsset",
@@ -39710,12 +39709,11 @@ class SDKController {
 }
 
 /**
- * @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" }
  * });
@@ -39729,14 +39727,15 @@ class Asset extends SDKController {
         Object.assign(this, options.attributes);
     }
     /**
-     * @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() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -39751,10 +39750,9 @@ class Asset extends SDKController {
         });
     }
     /**
-     * @summary
      * Updates platform asset details.
      *
-     * @usage
+     * @example
      * ```ts
      * await asset.updateAsset({
      *   assetName: "exampleAsset",
@@ -39802,7 +39800,14 @@ var DroppedAssetMediaType;
 (function (DroppedAssetMediaType) {
     DroppedAssetMediaType["NONE"] = "none";
     DroppedAssetMediaType["LINK"] = "link";
-})(DroppedAssetMediaType || (DroppedAssetMediaType = {}));
+})(DroppedAssetMediaType || (DroppedAssetMediaType = {}));
+var DroppedAssetMediaVolumeRadius;
+(function (DroppedAssetMediaVolumeRadius) {
+    DroppedAssetMediaVolumeRadius[DroppedAssetMediaVolumeRadius["CLOSE"] = 0] = "CLOSE";
+    DroppedAssetMediaVolumeRadius[DroppedAssetMediaVolumeRadius["MEDIUM"] = 1] = "MEDIUM";
+    DroppedAssetMediaVolumeRadius[DroppedAssetMediaVolumeRadius["FAR"] = 2] = "FAR";
+    DroppedAssetMediaVolumeRadius[DroppedAssetMediaVolumeRadius["EVERYWHERE"] = 3] = "EVERYWHERE";
+})(DroppedAssetMediaVolumeRadius || (DroppedAssetMediaVolumeRadius = {}));
 
 var WorldActivityType;
 (function (WorldActivityType) {
@@ -39840,12 +39845,11 @@ const scatterVisitors = (original, scatterBy) => {
 
 var _DroppedAsset_updateDroppedAsset;
 /**
- * @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" }
  * });
@@ -39858,7 +39862,9 @@ class DroppedAsset extends Asset {
         // private methods
         _DroppedAsset_updateDroppedAsset.set(this, (payload, updateType) => __awaiter(this, void 0, void 0, function* () {
             try {
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/${updateType}`, Object.assign({}, payload), this.requestOptions);
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/${updateType}`, Object.assign({}, payload), this.requestOptions);
+                Object.assign(this, response.data);
+                return response.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params: { payload, updateType }, sdkMethod: "DroppedAsset.updateDroppedAsset" });
@@ -39871,10 +39877,9 @@ class DroppedAsset extends Asset {
         this.position = ((_b = options.attributes) === null || _b === void 0 ? void 0 : _b.position) || { x: 0, y: 0 };
     }
     /**
-     * @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;
@@ -39894,10 +39899,9 @@ class DroppedAsset extends Asset {
         });
     }
     /**
-     * @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,
@@ -39924,10 +39928,12 @@ class DroppedAsset extends Asset {
      * 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, }) {
+    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, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const params = {
                 assetScale,
+                audioRadius,
+                audioSliderVolume,
                 clickType,
                 clickableLink,
                 clickableLinkTitle,
@@ -39936,11 +39942,17 @@ class DroppedAsset extends Asset {
                 flipped,
                 isInteractive,
                 isTextTopLayer,
+                isVideo,
                 interactivePublicKey,
                 layer0,
                 layer1,
+                mediaLink,
+                mediaName,
+                mediaType,
+                portalName,
                 position,
                 specialType,
+                syncUserMedia,
                 text,
                 textColor,
                 textSize,
@@ -39961,10 +39973,9 @@ class DroppedAsset extends Asset {
         });
     }
     /**
-     * @summary
-     * Delete dropped asset.
+     * Deletes the dropped asset (removes it from the world).
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.deleteDroppedAsset();
      * ```
@@ -39980,13 +39991,16 @@ class DroppedAsset extends Asset {
         });
     }
     /**
-     * @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, appJWT) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -40004,16 +40018,24 @@ class DroppedAsset extends Asset {
         });
     }
     /**
-     * @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, options = {}) {
@@ -40028,16 +40050,21 @@ class DroppedAsset extends Asset {
         });
     }
     /**
-     * @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, options = {}) {
@@ -40052,12 +40079,14 @@ class DroppedAsset extends Asset {
         });
     }
     /**
-     * @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);
      * ```
@@ -40076,12 +40105,10 @@ class DroppedAsset extends Asset {
             }
         });
     }
-    // update dropped assets
     /**
-     * @summary
      * Updates broadcast options for a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updateBroadcast({
      *   assetBroadcast: true,
@@ -40089,6 +40116,8 @@ class DroppedAsset extends Asset {
      *   broadcasterEmail: "example@email.com"
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateBroadcast({ assetBroadcast, assetBroadcastAll, broadcasterEmail, }) {
         const params = { assetBroadcast, assetBroadcastAll, broadcasterEmail };
@@ -40100,10 +40129,9 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @summary
      * Updates click options for a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updateClickType({
      *   "clickType": "portal",
@@ -40118,6 +40146,8 @@ class DroppedAsset extends Asset {
      *   "portalName": "community"
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateClickType({ clickType = DroppedAssetClickType.LINK, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, isForceLinkInIframe, isOpenLinkInDrawer, portalName, position, }) {
         const params = {
@@ -40139,10 +40169,9 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @summary
      * Adds an array of links to an asset. Maximum is 20 links.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.setClickableLinkMulti({
      *   clickableLinks: [
@@ -40161,6 +40190,8 @@ class DroppedAsset extends Asset {
      *   ],
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     setClickableLinkMulti({ clickableLinks }) {
         const params = {
@@ -40175,11 +40206,12 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @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",
@@ -40189,6 +40221,8 @@ class DroppedAsset extends Asset {
      *   existingLinkId: "abcd"
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateClickableLinkMulti({ clickableLink, clickableLinkTitle, isForceLinkInIframe, isOpenLinkInDrawer, existingLinkId, linkSamlQueryParams, }) {
         const params = {
@@ -40208,13 +40242,14 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @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 }) {
         const params = {
@@ -40228,10 +40263,9 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @summary
      * Updates text and style of a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * const style = {
      *   "textColor": "#abc123",
@@ -40242,6 +40276,8 @@ class DroppedAsset extends Asset {
      * };
      * await droppedAsset.updateCustomTextAsset(style, "hello world");
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateCustomTextAsset(style, text) {
         const params = { style, text };
@@ -40253,10 +40289,9 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @summary
      * Updates media options for a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updateMediaType({
      *   "mediaType": "link",
@@ -40269,6 +40304,8 @@ class DroppedAsset extends Asset {
      *   "mediaName": "string"
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateMediaType({ audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia, }) {
         const params = {
@@ -40289,13 +40326,14 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @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) {
         try {
@@ -40306,10 +40344,9 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @summary
      * Updates landmark zone options for a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updateLandmarkZone({
      *  isLandmarkZoneEnabled: true,
@@ -40317,6 +40354,8 @@ class DroppedAsset extends Asset {
      *  landmarkZoneIsVisible: true,
      *});
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updateLandmarkZone({ isLandmarkZoneEnabled, landmarkZoneName, landmarkZoneIsVisible, }) {
         const params = { isLandmarkZoneEnabled, landmarkZoneName, landmarkZoneIsVisible };
@@ -40328,13 +40367,14 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @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) {
         try {
@@ -40345,13 +40385,14 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @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, y, yOrderAdjust) {
         const params = { x, y, yOrderAdjust };
@@ -40363,10 +40404,9 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @summary
      * Updates private zone options for a dropped asset.
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.updatePrivateZone({
      *   "isPrivateZone": false,
@@ -40374,6 +40414,8 @@ class DroppedAsset extends Asset {
      *   "privateZoneUserCap": 10
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the updated dropped asset or an error.
      */
     updatePrivateZone({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap, }) {
         const params = { isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap };
@@ -40385,13 +40427,14 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @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) {
         try {
@@ -40402,13 +40445,14 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @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() {
         try {
@@ -40419,13 +40463,14 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @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) {
         try {
@@ -40436,13 +40481,14 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @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, top) {
         const params = { bottom, top };
@@ -40454,10 +40500,9 @@ class DroppedAsset extends Asset {
         }
     }
     /**
-     * @summary
      * Add a webhook to a dropped asset
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.addWebhook({
      *   dataObject: {},
@@ -40469,6 +40514,8 @@ class DroppedAsset extends Asset {
      *   url: "https://url.com",
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the new `webhookId` or an error.
      */
     addWebhook({ dataObject, description, isUniqueOnly, shouldSetClickType, shouldSetIsInteractive, title, type, url, }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -40492,10 +40539,9 @@ class DroppedAsset extends Asset {
         });
     }
     /**
-     * @summary
      * Set the interactive settings on a dropped asset
      *
-     * @usage
+     * @example
      * ```ts
      * await droppedAsset.setInteractiveSettings({
      *   isInteractive: true,
@@ -40519,12 +40565,10 @@ class DroppedAsset extends Asset {
             }
         });
     }
-    ////////// analytics
     /**
-     * @summary
      * Retrieve analytics for a dropped asset by day, week, month, quarter, or year
      *
-     * @usage
+     * @example
      * ```ts
      * const analytics = await droppedAsset.fetchDroppedAssetAnalytics({
      *   periodType: "quarter",
@@ -40532,6 +40576,8 @@ class DroppedAsset extends Asset {
      *   year: 2023,
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns the analytics data or an error.
      */
     fetchDroppedAssetAnalytics({ periodType, dateValue, year, }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -40566,12 +40612,11 @@ class DroppedAsset extends Asset {
 _DroppedAsset_updateDroppedAsset = new WeakMap();
 
 /**
- * @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" }
  * });
  * ```
@@ -40582,13 +40627,16 @@ class Ecosystem extends SDKController {
         this.dataObject = {};
     }
     /**
-     * @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, appJWT) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -40606,17 +40654,22 @@ class Ecosystem extends SDKController {
         });
     }
     /**
-     * @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, options = {}) {
@@ -40631,17 +40684,28 @@ class Ecosystem extends SDKController {
         });
     }
     /**
-     * @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, options = {}) {
@@ -40656,12 +40720,16 @@ class Ecosystem extends SDKController {
         });
     }
     /**
-     * @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",
@@ -40686,12 +40754,11 @@ class Ecosystem extends SDKController {
 }
 
 /**
- * @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" }
  * });
@@ -40704,10 +40771,9 @@ class Scene extends SDKController {
         Object.assign(this, options.attributes);
     }
     /**
-     * @summary
-     * Retrieves scene details.
+     * Retrieves scene details and assigns response data to the instance.
      *
-     * @usage
+     * @example
      * ```ts
      * await scene.fetchSceneById();
      * const { name } = scene;
@@ -40727,10 +40793,9 @@ class Scene extends SDKController {
 }
 
 /**
- * @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",
@@ -40766,12 +40831,11 @@ class Topia {
 
 var _World_droppedAssetsMap;
 /**
- * @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" }
  * });
@@ -40784,10 +40848,11 @@ class World extends SDKController {
         _World_droppedAssetsMap.set(this, void 0);
         ////////// data objects
         /**
-         * @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;
@@ -40807,17 +40872,23 @@ class World extends SDKController {
             }
         });
         /**
-         * @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;
          * ```
          */
         this.setDataObject = (dataObject, options = {}) => __awaiter(this, void 0, void 0, function* () {
@@ -40830,17 +40901,20 @@ class World extends SDKController {
             }
         });
         /**
-         * @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;
          * ```
          */
         this.updateDataObject = (dataObject, options = {}) => __awaiter(this, void 0, void 0, function* () {
@@ -40861,10 +40935,9 @@ class World extends SDKController {
     }
     //////// world details
     /**
-     * @summary
      * Retrieves details of a world.
      *
-     * @usage
+     * @example
      * ```ts
      * await world.fetchDetails();
      * const { name } = world;
@@ -40882,10 +40955,9 @@ class World extends SDKController {
         });
     }
     /**
-     * @summary
      * Update details of a world.
      *
-     * @usage
+     * @example
      * ```ts
      * await world.updateDetails({
      *   controls: {
@@ -40901,6 +40973,8 @@ class World extends SDKController {
      *   spawnPosition: { x: 100, y: 100 },
      *   width: 2000
      * });
+     *
+     * const { name, description } = world;
      * ```
      */
     updateDetails({ controls, description, forceAuthOnLogin, height, name, spawnPosition, width, }) {
@@ -40925,10 +40999,9 @@ class World extends SDKController {
         });
     }
     /**
-     * @summary
      * Set close world settings
      *
-     * @usage
+     * @example
      * ```ts
      * await world.updateCloseWorldSettings({
      *   controls: {
@@ -40945,6 +41018,8 @@ class World extends SDKController {
      *   width: 2000
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns `{ success: true }` or an error.
      */
     updateCloseWorldSettings({ closeWorldDescription, isWorldClosed, }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -40953,7 +41028,8 @@ class World extends SDKController {
                 isWorldClosed,
             };
             try {
-                return yield this.topiaPublicApi().put(`/world/${this.urlSlug}/set-close-world-settings`, params, this.requestOptions);
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/set-close-world-settings`, params, this.requestOptions);
+                return response.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params, sdkMethod: "World.updateCloseWorldSettings" });
@@ -40962,10 +41038,11 @@ class World extends SDKController {
     }
     ////////// dropped assets
     /**
-     * @summary
      * Retrieve all assets dropped in a world.
      *
-     * @usage
+     * @category Dropped Assets
+     *
+     * @example
      * ```ts
      * await world.fetchDroppedAssets();
      * const assets = world.droppedAssets;
@@ -40991,13 +41068,16 @@ class World extends SDKController {
         });
     }
     /**
-     * @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 = false, isReversed = false, }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -41022,57 +41102,19 @@ class World extends SDKController {
         });
     }
     /**
-     * @summary
-     * Retrieve all landmark zone assets dropped in a world.
-     *
-     * @usage
-     * ```ts
-     * const zones = await world.fetchLandmarkZones("optionalLandmarkZoneName", "optionalSceneDropIdExample");
-     * ```
-     */
-    fetchLandmarkZones(landmarkZoneName, sceneDropId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                let queryParams = "";
-                if (landmarkZoneName) {
-                    queryParams = `?landmarkZoneName=${landmarkZoneName}`;
-                    if (sceneDropId)
-                        queryParams += `&sceneDropId=${sceneDropId}`;
-                }
-                else if (sceneDropId) {
-                    queryParams = `?sceneDropId=${sceneDropId}`;
-                }
-                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/landmark-zones${queryParams}`, this.requestOptions);
-                const droppedAssets = [];
-                for (const asset of response.data.assets) {
-                    droppedAssets.push(new DroppedAsset(this.topia, asset.id, this.urlSlug, {
-                        attributes: asset,
-                        credentials: this.credentials,
-                    }));
-                }
-                return droppedAssets;
-            }
-            catch (error) {
-                throw this.errorHandler({
-                    error,
-                    params: { landmarkZoneName, sceneDropId },
-                    sdkMethod: "World.fetchLandmarkZones",
-                });
-            }
-        });
-    }
-    /**
-     * @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, }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -41100,10 +41142,11 @@ class World extends SDKController {
         });
     }
     /**
-     * @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 = {
@@ -41116,7 +41159,7 @@ class World extends SDKController {
      * await world.updateCustomText(droppedAssetsToUpdate, style);
      * ```
      *
-     * @result
+     * @returns
      * Updates each DroppedAsset instance and world.droppedAssets map.
      */
     updateCustomTextDroppedAssets(droppedAssetsToUpdate, style) {
@@ -41129,19 +41172,61 @@ class World extends SDKController {
             return outcomes;
         });
     }
+    /**
+     * 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, sceneDropId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let queryParams = "";
+                if (landmarkZoneName) {
+                    queryParams = `?landmarkZoneName=${landmarkZoneName}`;
+                    if (sceneDropId)
+                        queryParams += `&sceneDropId=${sceneDropId}`;
+                }
+                else if (sceneDropId) {
+                    queryParams = `?sceneDropId=${sceneDropId}`;
+                }
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/landmark-zones${queryParams}`, this.requestOptions);
+                const droppedAssets = [];
+                for (const asset of response.data.assets) {
+                    droppedAssets.push(new DroppedAsset(this.topia, asset.id, this.urlSlug, {
+                        attributes: asset,
+                        credentials: this.credentials,
+                    }));
+                }
+                return droppedAssets;
+            }
+            catch (error) {
+                throw this.errorHandler({
+                    error,
+                    params: { landmarkZoneName, sceneDropId },
+                    sdkMethod: "World.fetchLandmarkZones",
+                });
+            }
+        });
+    }
     // scenes
     /**
      * @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: [] }
      * ```
@@ -41159,15 +41244,16 @@ class World extends SDKController {
         });
     }
     /**
-     * @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": {
@@ -41199,10 +41285,11 @@ class World extends SDKController {
         });
     }
     /**
-     * @summary
      * Drops a scene in a world and returns sceneDropId.
      *
-     * @usage
+     * @category Scenes
+     *
+     * @example
      * ```ts
      * await world.dropScene({
      *   "sceneId": "string",
@@ -41214,7 +41301,7 @@ class World extends SDKController {
      * });
      * ```
      *
-     * @result
+     * @returns
      * ```ts
      * { sceneDropId: sceneId-timestamp, success: true }
      * ```
@@ -41232,10 +41319,11 @@ class World extends SDKController {
         });
     }
     /**
-     * @summary
      * Replace the current scene of a world.
      *
-     * @usage
+     * @category Scenes
+     *
+     * @example
      * ```ts
      * const droppedAssetsToUpdate = [world.droppedAssets["6"], world.droppedAssets["12"]]
      * const style = {
@@ -41247,6 +41335,8 @@ class World extends SDKController {
      * }
      * await world.replaceScene(SCENE_ID);
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns `{ success: true }` or an error.
      */
     replaceScene(sceneId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -41259,12 +41349,15 @@ class World extends SDKController {
         });
     }
     /**
-     * @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() {
@@ -41279,13 +41372,16 @@ class World extends SDKController {
         });
     }
     /**
-     * @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 = 10, position = { x: 1, y: 1 }, }) {
         var _a;
@@ -41309,14 +41405,15 @@ class World extends SDKController {
         });
     }
     /**
-     * @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, }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -41331,10 +41428,9 @@ class World extends SDKController {
         });
     }
     /**
-     * @summary
      * Display a message via a toast to all visitors currently in a world.
      *
-     * @usage
+     * @example
      * ```ts
      * await world.fireToast({
      *   groupId: "custom-message",
@@ -41342,6 +41438,8 @@ class World extends SDKController {
      *   text: "Thank you for participating!",
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns `{ success: true }` or an error.
      */
     fireToast({ groupId, title, text }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -41351,7 +41449,8 @@ class World extends SDKController {
                 text,
             };
             try {
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/fire-toast`, params, this.requestOptions);
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/fire-toast`, params, this.requestOptions);
+                return response.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params, sdkMethod: "Visitor.fireToast" });
@@ -41359,14 +41458,16 @@ class World extends SDKController {
         });
     }
     /**
-     * @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, amount, options = {}) {
@@ -41385,10 +41486,11 @@ class World extends SDKController {
     }
     ////////// webhooks
     /**
-     * @summary
      * Retrieve all webhooks in a world.
      *
-     * @usage
+     * @category Webhooks
+     *
+     * @example
      * ```ts
      * await world.fetchWebhooks();
      * const webhooks = world.webhooks;
@@ -41407,10 +41509,11 @@ class World extends SDKController {
     }
     ////////// analytics
     /**
-     * @summary
      * Retrieve world analytics by day, week, month, quarter, or year
      *
-     * @usage
+     * @category Analytics
+     *
+     * @example
      * ```ts
      * const analytics = await world.fetchWorldAnalytics({
      *   periodType: "week",
@@ -41453,12 +41556,11 @@ _World_droppedAssetsMap = new WeakMap();
 
 var _User_adminWorldsMap, _User_assetsMap, _User_scenesMap, _User_worldsMap;
 /**
- * @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" }
  * });
@@ -41491,14 +41593,15 @@ class User extends SDKController {
     get worlds() {
         return __classPrivateFieldGet(this, _User_worldsMap, "f");
     }
-    /**
-     * @summary
+    /*
      * Verify user has valid interactive credentials
      *
-     * @usage
+     * @example
      * ```ts
      * await user.checkInteractiveCredentials();
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns `{ success: true }` or an error.
      */
     checkInteractiveCredentials() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -41512,13 +41615,16 @@ class User extends SDKController {
         });
     }
     /**
-     * @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() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -41532,10 +41638,11 @@ class User extends SDKController {
         });
     }
     /**
-     * @summary
      * Add a new avatar
      *
-     * @usage
+     * @category Avatars
+     *
+     * @example
      * ```ts
      * const animationMeta = {
      *   "emote": { "loop": false, "x": 0, "y": 0, "hideLoop": true }
@@ -41613,10 +41720,11 @@ class User extends SDKController {
         });
     }
     /**
-     * @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 }
@@ -41694,10 +41802,11 @@ class User extends SDKController {
         });
     }
     /**
-     * @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");
      * ```
@@ -41714,10 +41823,11 @@ class User extends SDKController {
         });
     }
     /**
-     * @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;
@@ -41743,13 +41853,16 @@ class User extends SDKController {
         });
     }
     /**
-     * @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() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -41763,10 +41876,11 @@ class User extends SDKController {
         });
     }
     /**
-     * @summary
      * Returns all scenes owned by User.
      *
-     * @usage
+     * @category Scenes
+     *
+     * @example
      * ```ts
      * await user.fetchScenes();
      * const userScenes = user.scenes;
@@ -41792,18 +41906,17 @@ class User extends SDKController {
         });
     }
     /**
-     * @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 }) }
      * ```
@@ -41828,12 +41941,11 @@ class User extends SDKController {
         });
     }
     /**
-     * @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.
      *
-     * @usage
+     * @category Worlds
+     *
+     * @example
      * ```ts
      * await user.fetchAdminWorldsByKey();
      * const adminWorlds = user.adminWorlds;
@@ -41858,14 +41970,17 @@ class User extends SDKController {
         });
     }
     /**
-     * @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) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -41879,14 +41994,15 @@ class User extends SDKController {
         });
     }
     /**
-     * @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, }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -41901,13 +42017,16 @@ class User extends SDKController {
         });
     }
     /**
-     * @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, }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -41924,13 +42043,16 @@ class User extends SDKController {
         });
     }
     /**
-     * @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, appJWT) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -41950,16 +42072,24 @@ class User extends SDKController {
         });
     }
     /**
-     * @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, options = {}) {
@@ -41976,16 +42106,22 @@ class User extends SDKController {
         });
     }
     /**
-     * @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, options = {}) {
@@ -42002,12 +42138,14 @@ class User extends SDKController {
         });
     }
     /**
-     * @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);
      * ```
@@ -42026,12 +42164,11 @@ class User extends SDKController {
 _User_adminWorldsMap = new WeakMap(), _User_assetsMap = new WeakMap(), _User_scenesMap = new WeakMap(), _User_worldsMap = new WeakMap();
 
 /**
- * @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" } });
  * ```
  */
 class Visitor extends User {
@@ -42042,15 +42179,14 @@ class Visitor extends User {
         this.urlSlug = urlSlug;
     }
     /**
-     * @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() {
@@ -42076,10 +42212,9 @@ class Visitor extends User {
         });
     }
     /**
-     * @summary
      * Teleport or walk a visitor currently in a world to a single set of coordinates.
      *
-     * @usage
+     * @example
      * ```ts
      * await visitor.moveVisitor({
      *   shouldTeleportVisitor: true,
@@ -42088,19 +42223,20 @@ class Visitor extends User {
      * });
      * ```
      *
-     * @result
-     * Updates each Visitor instance and world.visitors map.
+     * @returns
+     * Returns `{ success: true }` if the visitor was moved successfully.
      */
     moveVisitor({ shouldTeleportVisitor, x, y }) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/move`, {
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/move`, {
                     moveTo: {
                         x,
                         y,
                     },
                     teleport: shouldTeleportVisitor,
                 }, this.requestOptions);
+                return response.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params: { shouldTeleportVisitor, x, y }, sdkMethod: "Visitor.moveVisitor" });
@@ -42108,10 +42244,9 @@ class Visitor extends User {
         });
     }
     /**
-     * @summary
      * Display a message via a toast to a visitor currently in a world.
      *
-     * @usage
+     * @example
      * ```ts
      * await visitor.fireToast({
      *   groupId: "custom-message",
@@ -42119,6 +42254,8 @@ class Visitor extends User {
      *   text: "Thank you for participating!",
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns `{ success: true }` or an error.
      */
     fireToast({ groupId, title, text }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -42128,7 +42265,8 @@ class Visitor extends User {
                 text,
             };
             try {
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/fire-toast`, params, this.requestOptions);
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/fire-toast`, params, this.requestOptions);
+                return response.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params, sdkMethod: "Visitor.fireToast" });
@@ -42136,10 +42274,11 @@ class Visitor extends User {
         });
     }
     /**
-     * @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",
@@ -42148,6 +42287,8 @@ class Visitor extends User {
      *   title: "Hello World",
      * });
      * ```
+     *
+     * @returns {Promise<void | ResponseType>} Returns `{ success: true }` or an error.
      */
     openIframe({ droppedAssetId, link, shouldOpenInDrawer, title, }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -42158,7 +42299,8 @@ class Visitor extends User {
                 title,
             };
             try {
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/open-iframe`, params, this.requestOptions);
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/open-iframe`, params, this.requestOptions);
+                return response.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params, sdkMethod: "Visitor.openIframe" });
@@ -42166,18 +42308,22 @@ class Visitor extends User {
         });
     }
     /**
-     * @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) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/reload-iframe`, { droppedAssetId }, this.requestOptions);
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/reload-iframe`, { droppedAssetId }, this.requestOptions);
+                return response.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params: { droppedAssetId }, sdkMethod: "Visitor.reloadIframe" });
@@ -42185,18 +42331,22 @@ class Visitor extends User {
         });
     }
     /**
-     * @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) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/close-iframe`, { droppedAssetId }, this.requestOptions);
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/close-iframe`, { droppedAssetId }, this.requestOptions);
+                return response.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params: { droppedAssetId }, sdkMethod: "Visitor.closeIframe" });
@@ -42204,18 +42354,20 @@ class Visitor extends User {
         });
     }
     /**
-     * @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() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/turn-av-off`, {}, this.requestOptions);
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/turn-av-off`, {}, this.requestOptions);
+                return response.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, sdkMethod: "Visitor.turnAVOff" });
@@ -42223,13 +42375,15 @@ class Visitor extends User {
         });
     }
     /**
-     * @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, }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -42246,14 +42400,17 @@ class Visitor extends User {
         });
     }
     /**
-     * @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 }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -42274,13 +42431,16 @@ class Visitor extends User {
         });
     }
     /**
-     * @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() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -42294,13 +42454,16 @@ class Visitor extends User {
         });
     }
     /**
-     * @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 = 10, }) {
         var _a;
@@ -42324,13 +42487,16 @@ class Visitor extends User {
         });
     }
     /**
-     * @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, appJWT) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -42348,16 +42514,24 @@ class Visitor extends User {
         });
     }
     /**
-     * @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, options = {}) {
@@ -42372,16 +42546,22 @@ class Visitor extends User {
         });
     }
     /**
-     * @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, options = {}) {
@@ -42396,12 +42576,14 @@ class Visitor extends User {
         });
     }
     /**
-     * @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);
      * ```
@@ -42421,10 +42603,9 @@ class Visitor extends User {
         });
     }
     /**
-     * @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 }]);
      * ```
@@ -42444,10 +42625,9 @@ class Visitor extends User {
         });
     }
     /**
-     * @summary
      * Setup signal to visitor
      *
-     * @usage
+     * @example
      * ```ts
      * await visitor.sendSignalToVisitor(iceServers);
      * ```
@@ -42470,12 +42650,11 @@ class Visitor extends User {
 }
 
 /**
- * @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" }
  * });
  * ```
@@ -42488,10 +42667,9 @@ class WebRTCConnector extends SDKController {
         this.urlSlug = urlSlug;
     }
     /**
-     * @summary
      * Get twilio
      *
-     * @usage
+     * @example
      * ```ts
      * await webRTCConnector.getTwilioConfig();
      * ```
@@ -42512,14 +42690,14 @@ class WebRTCConnector extends SDKController {
 
 var _WorldActivity_visitorsMap;
 /**
- * @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" }
  * });
@@ -42566,13 +42744,16 @@ class WorldActivity extends SDKController {
         });
     }
     /**
-     * @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) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -42586,13 +42767,16 @@ class WorldActivity extends SDKController {
         });
     }
     /**
-     * @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, }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -42608,12 +42792,15 @@ class WorldActivity extends SDKController {
         });
     }
     /**
-     * @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,
@@ -42624,7 +42811,7 @@ class WorldActivity extends SDKController {
      * });
      * ```
      *
-     * @result
+     * @returns
      * Updates each Visitor instance and worldActivity.visitors map.
      */
     moveAllVisitors({ shouldFetchVisitors = true, shouldTeleportVisitors = true, scatterVisitorsBy = 0, x, y, }) {
@@ -42645,10 +42832,11 @@ class WorldActivity extends SDKController {
         });
     }
     /**
-     * @summary
      * Teleport or walk a list of visitors currently in a world to various coordinates.
      *
-     * @usage
+     * @category Visitors
+     *
+     * @example
      * ```ts
      * const visitorsToMove = [
      *   {
@@ -42666,7 +42854,7 @@ class WorldActivity extends SDKController {
      * await worldActivity.moveVisitors(visitorsToMove);
      * ```
      *
-     * @result
+     * @returns
      * Updates each Visitor instance and worldActivity.visitors map.
      */
     moveVisitors(visitorsToMove) {
@@ -42683,7 +42871,7 @@ class WorldActivity extends SDKController {
 _WorldActivity_visitorsMap = new WeakMap();
 
 /**
- * @usage
+ * @example
  * ```ts
  * const Asset = new AssetFactory(myTopiaInstance);
  * ```
@@ -42693,22 +42881,22 @@ class AssetFactory extends SDKController {
         super(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, options) {
         return new Asset(this.topia, id, options);
     }
     /**
-     * @summary
      * Upload a new Asset and return a new instance of Asset class.
      *
-     * @usage
+     * @example
      * ```
      * const assetPayload = {
      *   assetName: "exampleAssetName"
@@ -42720,6 +42908,8 @@ class AssetFactory extends SDKController {
      * }
      * const asset = await Asset.upload(assetPayload, apiKey);
      * ```
+     *
+     * @returns {AssetType} Returns a new Asset object with the asset details.
      */
     upload(assetPayload, apiKey) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -42739,7 +42929,7 @@ class AssetFactory extends SDKController {
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const DroppedAsset = new DroppedAssetFactory(myTopiaInstance);
  * ```
@@ -42749,25 +42939,27 @@ class DroppedAssetFactory extends SDKController {
         super(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, urlSlug, options) {
         return new DroppedAsset(this.topia, id, urlSlug, options);
     }
     /**
-     * @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, urlSlug, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -42777,16 +42969,17 @@ class DroppedAssetFactory extends SDKController {
         });
     }
     /**
-     * @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, urlSlug, interactiveSecret, credentials) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -42811,10 +43004,9 @@ class DroppedAssetFactory extends SDKController {
         });
     }
     /**
-     * @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, {
@@ -42829,6 +43021,8 @@ class DroppedAssetFactory extends SDKController {
           urlSlug,
         });
      * ```
+     *
+     * @returns {Promise<DroppedAsset>} Returns a new DroppedAsset object with all properties.
      */
     drop(asset, { assetScale = 1, clickType, clickableDisplayTextDescription, clickableDisplayTextHeadline, clickableLink, clickableLinkTitle, flipped, interactivePublicKey, isInteractive, isForceLinkInIframe, isOpenLinkInDrawer, isTextTopLayer = false, layer0, layer1, position: { x, y }, sceneDropId, text, textColor, textFontFamily, textSize, textWeight, textWidth, uniqueName, urlSlug, yOrderAdjust, }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -42883,7 +43077,7 @@ class DroppedAssetFactory extends SDKController {
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const Ecosystem = new EcosystemFactory(myTopiaInstance);
  * ```
@@ -42893,13 +43087,14 @@ class EcosystemFactory {
         this.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) {
         return new Ecosystem(this.topia, options);
@@ -42907,7 +43102,7 @@ class EcosystemFactory {
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const Scene = new SceneFactory(myTopiaInstance);
  * ```
@@ -42918,25 +43113,27 @@ class SceneFactory {
         this.create;
     }
     /**
-     * @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, options) {
         return new Scene(this.topia, id, options);
     }
     /**
-     * @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, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -42948,7 +43145,7 @@ class SceneFactory {
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const User = new UserFactory(myTopiaInstance);
  * ```
@@ -42958,13 +43155,14 @@ class UserFactory {
         this.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) {
         return new User(this.topia, options);
@@ -42972,7 +43170,7 @@ class UserFactory {
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const Visitor = new VisitorFactory(myTopiaInstance);
  * ```
@@ -42982,25 +43180,27 @@ class VisitorFactory {
         this.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, urlSlug, options) {
         return new Visitor(this.topia, id, urlSlug, options);
     }
     /**
-     * @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, urlSlug, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -43012,7 +43212,7 @@ class VisitorFactory {
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const WebRTCConnector = new WebRTCConnectorFactory(myTopiaInstance);
  * ```
@@ -43022,13 +43222,14 @@ class WebRTCConnectorFactory {
         this.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, options) {
         return new WebRTCConnector(this.topia, urlSlug, options);
@@ -43036,7 +43237,7 @@ class WebRTCConnectorFactory {
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const WorldActivity = new WorldActivityFactory(myTopiaInstance);
  * ```
@@ -43046,13 +43247,14 @@ class WorldActivityFactory {
         this.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, options) {
         return new WorldActivity(this.topia, urlSlug, options);
@@ -43060,7 +43262,7 @@ class WorldActivityFactory {
 }
 
 /**
- * @usage
+ * @example
  * ```ts
  * const World = new WorldFactory(myTopiaInstance);
  * ```
@@ -43070,25 +43272,27 @@ class WorldFactory extends SDKController {
         super(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, options) {
         return new World(this.topia, urlSlug, options);
     }
     /**
-     * @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, droppedAssetIds, interactiveSecret, credentials) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -43145,4 +43349,4 @@ process.on("uncaughtException", function (err) {
     process.exit(1);
 });
 
-export { Asset, AssetFactory, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetMediaType, Ecosystem, EcosystemFactory, SDKController, Scene, SceneFactory, Topia, User, UserFactory, Visitor, VisitorFactory, WebRTCConnector, WebRTCConnectorFactory, World, WorldActivity, WorldActivityFactory, WorldActivityType, WorldFactory };
+export { Asset, AssetFactory, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetMediaType, DroppedAssetMediaVolumeRadius, Ecosystem, EcosystemFactory, SDKController, Scene, SceneFactory, Topia, User, UserFactory, Visitor, VisitorFactory, WebRTCConnector, WebRTCConnectorFactory, World, WorldActivity, WorldActivityFactory, WorldActivityType, WorldFactory };