@rtsdk/topia 0.8.4 → 0.9.0

package/dist/index.d.ts

@@ -44,7 +44,7 @@ type WorldOptions = {
     credentials?: InteractiveCredentials | undefined;
 };
 
-type ResponseType = {
+type ResponseType$1 = {
     message: string;
     success: boolean;
 };
@@ -64,7 +64,17 @@ type ResponseType = {
 declare class Scene extends SDKController implements SceneInterface {
     readonly id: string;
     constructor(topia: Topia, id: string, options?: SceneOptionalInterface);
-    fetchSceneById(): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Retrieves scene details.
+     *
+     * @usage
+     * ```ts
+     * await scene.fetchSceneById();
+     * const { name } = scene;
+     * ```
+     */
+    fetchSceneById(): Promise<void | ResponseType$1>;
 }
 
 /**
@@ -81,12 +91,16 @@ declare class Scene extends SDKController implements SceneInterface {
  */
 declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     #private;
-    dataObject?: object | null;
     readonly id?: string | undefined;
-    text?: string | null | undefined;
-    urlSlug: string;
+    dataObject?: object | null;
     isInteractive?: boolean | null;
     interactivePublicKey?: string | null;
+    position?: {
+        x: number;
+        y: number;
+    };
+    text?: string | null | undefined;
+    urlSlug: string;
     constructor(topia: Topia, id: string, urlSlug: string, options?: DroppedAssetOptionalInterface);
     /**
      * @summary
@@ -98,7 +112,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * const { assetName } = droppedAsset;
      * ```
      */
-    fetchDroppedAssetById(): Promise<void | ResponseType>;
+    fetchDroppedAssetById(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Delete dropped asset.
@@ -108,7 +122,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * await droppedAsset.deleteDroppedAsset();
      * ```
      */
-    deleteDroppedAsset(): Promise<void | ResponseType>;
+    deleteDroppedAsset(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Retrieves the data object for a dropped asset.
@@ -118,7 +132,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * const dataObject = await droppedAsset.fetchDataObject();
      * ```
      */
-    fetchDataObject(): Promise<void | ResponseType>;
+    fetchDataObject(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Sets the data object for a dropped asset.
@@ -133,11 +147,12 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     setDataObject(dataObject: object, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-    }): Promise<void | ResponseType>;
+    }): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Updates the data object for a dropped asset.
@@ -152,11 +167,12 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-    }): Promise<void | ResponseType>;
+    }): 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.
@@ -172,11 +188,12 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-    }): Promise<void | ResponseType>;
+    }): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Updates broadcast options for a dropped asset.
@@ -190,7 +207,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * });
      * ```
      */
-    updateBroadcast({ assetBroadcast, assetBroadcastAll, broadcasterEmail, }: UpdateBroadcastInterface): Promise<void | ResponseType>;
+    updateBroadcast({ assetBroadcast, assetBroadcastAll, broadcasterEmail, }: UpdateBroadcastInterface): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Updates click options for a dropped asset.
@@ -211,7 +228,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * });
      * ```
      */
-    updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, isForceLinkInIframe, isOpenLinkInDrawer, portalName, position, }: UpdateClickTypeInterface): Promise<void | ResponseType>;
+    updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, isForceLinkInIframe, isOpenLinkInDrawer, portalName, position, }: UpdateClickTypeInterface): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Updates text and style of a dropped asset.
@@ -228,7 +245,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * await droppedAsset.updateCustomTextAsset(style, "hello world");
      * ```
      */
-    updateCustomTextAsset(style: object | undefined | null, text: string | null | undefined): Promise<void | ResponseType>;
+    updateCustomTextAsset(style: object | undefined | null, text: string | null | undefined): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Updates media options for a dropped asset.
@@ -247,7 +264,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * });
      * ```
      */
-    updateMediaType({ audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia, }: UpdateMediaTypeInterface): Promise<void | ResponseType>;
+    updateMediaType({ audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia, }: UpdateMediaTypeInterface): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Updates mute zone options for a dropped asset.
@@ -257,7 +274,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * await droppedAsset.updateMuteZone(true);
      * ```
      */
-    updateMuteZone(isMutezone: boolean): Promise<void | ResponseType>;
+    updateMuteZone(isMutezone: boolean): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Updates webhook zone options for a dropped asset.
@@ -267,7 +284,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * await droppedAsset.updateWebhookZone(true);
      * ```
      */
-    updateWebhookZone(isWebhookZoneEnabled: boolean): Promise<void | ResponseType>;
+    updateWebhookZone(isWebhookZoneEnabled: boolean): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Moves a dropped asset to specified coordinates.
@@ -277,7 +294,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * await droppedAsset.updatePosition(100,200);
      * ```
      */
-    updatePosition(x: number, y: number, yOrderAdjust?: number): Promise<void | ResponseType>;
+    updatePosition(x: number, y: number, yOrderAdjust?: number): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Updates private zone options for a dropped asset.
@@ -291,7 +308,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * });
      * ```
      */
-    updatePrivateZone({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap, }: UpdatePrivateZoneInterface): Promise<void | ResponseType>;
+    updatePrivateZone({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap, }: UpdatePrivateZoneInterface): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Updates the size of a dropped asset.
@@ -301,7 +318,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * await droppedAsset.assetScale(.5);
      * ```
      */
-    updateScale(assetScale: number): Promise<void | ResponseType>;
+    updateScale(assetScale: number): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Flip an dropped asset.
@@ -311,7 +328,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * await droppedAsset.flip(.5);
      * ```
      */
-    flip(): Promise<void | ResponseType>;
+    flip(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Change or remove media embedded in a dropped asset.
@@ -321,7 +338,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * await droppedAsset.updateUploadedMediaSelected("LVWyxwNxI96eLjnXWwYO");
      * ```
      */
-    updateUploadedMediaSelected(mediaId: string): Promise<void | ResponseType>;
+    updateUploadedMediaSelected(mediaId: string): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Change or remove top and bottom layers of a dropped asset.
@@ -331,7 +348,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * await droppedAsset.updateWebImageLayers("","https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg");
      * ```
      */
-    updateWebImageLayers(bottom: string, top: string): Promise<void | ResponseType>;
+    updateWebImageLayers(bottom: string, top: string): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Add a webhook to a dropped asset
@@ -339,7 +356,6 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * @usage
      * ```ts
      * await droppedAsset.addWebhook({
-     *   active: true,
      *   dataObject: {},
      *   description: "Webhook desc",
      *   enteredBy: "you",
@@ -347,7 +363,6 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      *   title: "title",
      *   type: "type",
      *   url: "https://url.com",
-     *   urlSlug: "world",
      * });
      * ```
      */
@@ -376,7 +391,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
     setInteractiveSettings({ isInteractive, interactivePublicKey, }: {
         isInteractive?: boolean;
         interactivePublicKey: string;
-    }): Promise<void | ResponseType>;
+    }): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Retrieve analytics for a dropped asset by day, week, month, quarter, or year
@@ -394,7 +409,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
         periodType: "week" | "month" | "quarter" | "year";
         dateValue: number;
         year: number;
-    }): Promise<void | ResponseType>;
+    }): Promise<void | ResponseType$1>;
 }
 
 /**
@@ -430,7 +445,7 @@ declare class World extends SDKController implements WorldInterface {
      * const { name } = world;
      * ```
      */
-    fetchDetails(): Promise<void | ResponseType>;
+    fetchDetails(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Update details of a world.
@@ -453,7 +468,33 @@ declare class World extends SDKController implements WorldInterface {
      * });
      * ```
      */
-    updateDetails({ controls, description, forceAuthOnLogin, height, name, spawnPosition, width, }: WorldDetailsInterface): Promise<void | ResponseType>;
+    updateDetails({ controls, description, forceAuthOnLogin, height, name, spawnPosition, width, }: WorldDetailsInterface): Promise<void | ResponseType$1>;
+    /**
+     * @summary
+     * Set close world settings
+     *
+     * @usage
+     * ```ts
+     * await world.updateCloseWorldSettings({
+     *   controls: {
+     *     allowMuteAll: true,
+     *     disableHideVideo: true,
+     *     isMobileDisabled: false,
+     *     isShowingCurrentGuests: false,
+     *   },
+     *   description: 'Welcome to my world.',
+     *   forceAuthOnLogin: false,
+     *   height: 2000,
+     *   name: 'Example',
+     *   spawnPosition: { x: 100, y: 100 },
+     *   width: 2000
+     * });
+     * ```
+     */
+    updateCloseWorldSettings({ closeWorldDescription, isWorldClosed, }: {
+        closeWorldDescription: string;
+        isWorldClosed: boolean;
+    }): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Retrieve all assets dropped in a world.
@@ -464,7 +505,7 @@ declare class World extends SDKController implements WorldInterface {
      * const assets = world.droppedAssets;
      * ```
      */
-    fetchDroppedAssets(): Promise<void | ResponseType>;
+    fetchDroppedAssets(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Retrieve all assets dropped in a world matching uniqueName.
@@ -534,7 +575,7 @@ declare class World extends SDKController implements WorldInterface {
      * { sceneDropIds: [] }
      * ```
      */
-    fetchSceneDropIds(): Promise<object | ResponseType>;
+    fetchSceneDropIds(): Promise<object | ResponseType$1>;
     /**
      * @summary
      * Fetch a list of all scene drop ids and dropped assets in a world
@@ -563,7 +604,7 @@ declare class World extends SDKController implements WorldInterface {
      * }
      * ```
      */
-    fetchScenes(): Promise<object | ResponseType>;
+    fetchScenes(): Promise<object | ResponseType$1>;
     /**
      * @summary
      * Drops a scene in a world and returns sceneDropId.
@@ -589,7 +630,7 @@ declare class World extends SDKController implements WorldInterface {
         assetSuffix: string;
         position: object;
         sceneId: string;
-    }): Promise<object | ResponseType>;
+    }): Promise<object | ResponseType$1>;
     /**
      * @summary
      * Replace the current scene of a world.
@@ -607,7 +648,7 @@ declare class World extends SDKController implements WorldInterface {
      * await world.replaceScene(SCENE_ID);
      * ```
      */
-    replaceScene(sceneId: string): Promise<void | ResponseType>;
+    replaceScene(sceneId: string): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Retrieves the data object for a world. Must have valid interactive credentials from a visitor in the world.
@@ -618,7 +659,7 @@ declare class World extends SDKController implements WorldInterface {
      * const { dataObject } = world;
      * ```
      */
-    fetchDataObject: () => Promise<void | ResponseType>;
+    fetchDataObject: () => Promise<void | ResponseType$1>;
     /**
      * @summary
      * Sets the data object for a user. Must have valid interactive credentials from a visitor in the world.
@@ -634,11 +675,12 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     setDataObject: (dataObject: object | null | undefined, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-    }) => Promise<void | ResponseType>;
+    }) => Promise<void | ResponseType$1>;
     /**
      * @summary
      * Updates the data object for a world. Must have valid interactive credentials from a visitor in the world.
@@ -654,11 +696,12 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     updateDataObject: (dataObject: object, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-    }) => Promise<void | ResponseType>;
+    }) => 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.
@@ -674,11 +717,12 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-    }): Promise<void | ResponseType>;
+    }): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Retrieve all webhooks in a world.
@@ -689,7 +733,7 @@ declare class World extends SDKController implements WorldInterface {
      * const webhooks = world.webhooks;
      * ```
      */
-    fetchWebhooks(): Promise<void | ResponseType>;
+    fetchWebhooks(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Retrieve world analytics by day, week, month, quarter, or year
@@ -707,7 +751,7 @@ declare class World extends SDKController implements WorldInterface {
         periodType: "week" | "month" | "quarter" | "year";
         dateValue: number;
         year: number;
-    }): Promise<void | ResponseType>;
+    }): Promise<void | ResponseType$1>;
 }
 
 /**
@@ -743,13 +787,35 @@ declare class User extends SDKController implements UserInterface {
     /**
      * @summary
      * Returns all assets owned by User when an email address is provided.
+     *
+     * @usage
+     * ```ts
+     * await user.fetchAssets();
+     * const userAssets = user.assets;
+     * ```
+     */
+    fetchAssets(): Promise<void | ResponseType$1>;
+    /**
+     * @summary
+     * Returns all platform assets.
+     *
+     * @usage
+     * ```ts
+     * const assets = await user.fetchPlatformAssets();
+     * ```
      */
-    fetchAssets(): Promise<void | ResponseType>;
+    fetchPlatformAssets(): Promise<object | ResponseType$1>;
     /**
      * @summary
-     * Returns all scenes owned by User
+     * Returns all scenes owned by User.
+     *
+     * @usage
+     * ```ts
+     * await user.fetchScenes();
+     * const userScenes = user.scenes;
+     * ```
      */
-    fetchScenes(): Promise<void | ResponseType>;
+    fetchScenes(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Retrieves all worlds owned by user with matching API Key,
@@ -767,7 +833,7 @@ declare class User extends SDKController implements UserInterface {
      * { urlSlug: new World({ apiKey, worldArgs, urlSlug }) }
      * ```
      */
-    fetchWorldsByKey(): Promise<void | ResponseType>;
+    fetchWorldsByKey(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Retrieves all worlds a user with matching API Key is an admin in,
@@ -780,7 +846,7 @@ declare class User extends SDKController implements UserInterface {
      * const adminWorlds = user.adminWorlds;
      * ```
      */
-    fetchAdminWorldsByKey(): Promise<void | ResponseType>;
+    fetchAdminWorldsByKey(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Retrieves ids of all dropped assets in all worlds with a matching interactivePublicKey.
@@ -791,7 +857,7 @@ declare class User extends SDKController implements UserInterface {
      * const interactiveWorlds = user.interactiveWorlds;
      * ```
      */
-    fetchInteractiveWorldsByKey(interactivePublicKey: string): Promise<object | ResponseType>;
+    fetchInteractiveWorldsByKey(interactivePublicKey: string): Promise<object | ResponseType$1>;
     /**
      * @summary
      * Retrieves the data object for a user.
@@ -801,7 +867,7 @@ declare class User extends SDKController implements UserInterface {
      * const dataObject = await user.fetchDataObject();
      * ```
      */
-    fetchDataObject(): Promise<void | ResponseType>;
+    fetchDataObject(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Sets the data object for a user.
@@ -816,11 +882,12 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-    }): Promise<void | ResponseType>;
+    }): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Updates the data object for a user.
@@ -835,11 +902,12 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-    }): Promise<void | ResponseType>;
+    }): 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.
@@ -855,11 +923,12 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-    }): Promise<void | ResponseType>;
+    }): Promise<void | ResponseType$1>;
 }
 
 /**
@@ -888,7 +957,7 @@ declare class Visitor extends User implements VisitorInterface {
      * @result
      * Returns details for a visitor in a world by id and urlSlug
      */
-    fetchVisitor(): Promise<void | ResponseType>;
+    fetchVisitor(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Teleport or walk a visitor currently in a world to a single set of coordinates.
@@ -905,7 +974,7 @@ declare class Visitor extends User implements VisitorInterface {
      * @result
      * Updates each Visitor instance and world.visitors map.
      */
-    moveVisitor({ shouldTeleportVisitor, x, y }: MoveVisitorInterface): Promise<void | ResponseType>;
+    moveVisitor({ shouldTeleportVisitor, x, y }: MoveVisitorInterface): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Display a message via a toast to a visitor currently in a world.
@@ -919,7 +988,7 @@ declare class Visitor extends User implements VisitorInterface {
      * });
      * ```
      */
-    fireToast({ groupId, title, text }: FireToastInterface): Promise<void | ResponseType>;
+    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.
@@ -934,7 +1003,7 @@ declare class Visitor extends User implements VisitorInterface {
      * });
      * ```
      */
-    openIframe({ droppedAssetId, link, shouldOpenInDrawer, title, }: OpenIframeInterface): Promise<void | ResponseType>;
+    openIframe({ droppedAssetId, link, shouldOpenInDrawer, title, }: OpenIframeInterface): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Reload an iframe for a visitor currently in a world.
@@ -944,7 +1013,7 @@ declare class Visitor extends User implements VisitorInterface {
      * await visitor.reloadIframe("droppedAssetId");
      * ```
      */
-    reloadIframe(droppedAssetId: string): Promise<void | ResponseType>;
+    reloadIframe(droppedAssetId: string): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Close an iframe for a visitor currently in a world.
@@ -954,7 +1023,7 @@ declare class Visitor extends User implements VisitorInterface {
      * await visitor.closeIframe("droppedAssetId");
      * ```
      */
-    closeIframe(droppedAssetId: string): Promise<void | ResponseType>;
+    closeIframe(droppedAssetId: string): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Mute and turn video off for a visitor currently in a world.
@@ -964,7 +1033,7 @@ declare class Visitor extends User implements VisitorInterface {
      * await visitor.turnAVOff();
      * ```
      */
-    turnAVOff(): Promise<void | ResponseType>;
+    turnAVOff(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Grant expression to a visitor by id or name.
@@ -977,7 +1046,7 @@ declare class Visitor extends User implements VisitorInterface {
     grantExpression({ id, name }: {
         id?: string;
         name?: string;
-    }): Promise<object | ResponseType>;
+    }): Promise<object | ResponseType$1>;
     /**
      * @summary
      * Retrieves the data object for a visitor.
@@ -987,7 +1056,7 @@ declare class Visitor extends User implements VisitorInterface {
      * const dataObject = await visitor.fetchDataObject();
      * ```
      */
-    fetchDataObject(): Promise<void | ResponseType>;
+    fetchDataObject(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Sets the data object for a visitor.
@@ -1002,11 +1071,12 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-    }): Promise<void | ResponseType>;
+    }): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Updates the data object for a visitor.
@@ -1021,11 +1091,12 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-    }): Promise<void | ResponseType>;
+    }): 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.
@@ -1041,11 +1112,12 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-    }): Promise<void | ResponseType>;
+    }): Promise<void | ResponseType$1>;
 }
 
 type VisitorType = {
@@ -1089,7 +1161,7 @@ interface SDKInterface {
 }
 
 interface AssetInterface extends SDKInterface {
-    fetchPlatformAssets(): Promise<object>;
+    fetchAssetById(): Promise<object | ResponseType>;
     addedOn?: string;
     assetName?: string;
     creatorTags?: object;
@@ -1114,23 +1186,23 @@ type AssetOptionalInterface = {
 };
 
 interface DroppedAssetInterface extends AssetInterface {
-    fetchDroppedAssetById(): Promise<void | ResponseType>;
-    deleteDroppedAsset(): Promise<void | ResponseType>;
-    fetchDataObject(): Promise<void | ResponseType>;
-    setDataObject(dataObject: object, options: object): Promise<void | ResponseType>;
-    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType>;
-    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType>;
-    updateBroadcast({ assetBroadcast, assetBroadcastAll, broadcasterEmail, }: UpdateBroadcastInterface): Promise<void | ResponseType>;
-    updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, isForceLinkInIframe, isOpenLinkInDrawer, portalName, position, }: UpdateClickTypeInterface): Promise<void | ResponseType>;
-    updateCustomTextAsset(style: object | undefined | null, text: string | null | undefined): Promise<void | ResponseType>;
-    updateMediaType({ audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia, }: UpdateMediaTypeInterface): Promise<void | ResponseType>;
-    updateMuteZone(isMutezone: boolean): Promise<void | ResponseType>;
-    updateWebhookZone(isWebhookZoneEnabled: boolean): Promise<void | ResponseType>;
-    updatePosition(x: number, y: number, yOrderAdjust: number): Promise<void | ResponseType>;
-    updatePrivateZone({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap, }: UpdatePrivateZoneInterface): Promise<void | ResponseType>;
-    updateScale(assetScale: number): Promise<void | ResponseType>;
-    updateUploadedMediaSelected(mediaId: string): Promise<void | ResponseType>;
-    updateWebImageLayers(bottom: string, top: string): Promise<void | ResponseType>;
+    fetchDroppedAssetById(): Promise<void | ResponseType$1>;
+    deleteDroppedAsset(): Promise<void | ResponseType$1>;
+    fetchDataObject(): Promise<void | ResponseType$1>;
+    setDataObject(dataObject: object, options: object): Promise<void | ResponseType$1>;
+    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType$1>;
+    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
+    updateBroadcast({ assetBroadcast, assetBroadcastAll, broadcasterEmail, }: UpdateBroadcastInterface): Promise<void | ResponseType$1>;
+    updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, isForceLinkInIframe, isOpenLinkInDrawer, portalName, position, }: UpdateClickTypeInterface): Promise<void | ResponseType$1>;
+    updateCustomTextAsset(style: object | undefined | null, text: string | null | undefined): Promise<void | ResponseType$1>;
+    updateMediaType({ audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia, }: UpdateMediaTypeInterface): Promise<void | ResponseType$1>;
+    updateMuteZone(isMutezone: boolean): Promise<void | ResponseType$1>;
+    updateWebhookZone(isWebhookZoneEnabled: boolean): Promise<void | ResponseType$1>;
+    updatePosition(x: number, y: number, yOrderAdjust: number): Promise<void | ResponseType$1>;
+    updatePrivateZone({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap, }: UpdatePrivateZoneInterface): Promise<void | ResponseType$1>;
+    updateScale(assetScale: number): Promise<void | ResponseType$1>;
+    updateUploadedMediaSelected(mediaId: string): Promise<void | ResponseType$1>;
+    updateWebImageLayers(bottom: string, top: string): Promise<void | ResponseType$1>;
     addWebhook({ dataObject, description, isUniqueOnly, title, type, url, }: {
         dataObject: object;
         description: string;
@@ -1142,7 +1214,7 @@ interface DroppedAssetInterface extends AssetInterface {
     setInteractiveSettings({ isInteractive, interactivePublicKey, }: {
         isInteractive?: boolean;
         interactivePublicKey: string;
-    }): Promise<void | ResponseType>;
+    }): Promise<void | ResponseType$1>;
     id?: string;
     assetId?: string;
     assetScale?: number | null;
@@ -1247,7 +1319,7 @@ interface UpdatePrivateZoneInterface {
 }
 
 interface SceneInterface {
-    fetchSceneById(): Promise<void | ResponseType>;
+    fetchSceneById(): Promise<void | ResponseType$1>;
     id: string;
     background?: null;
     description?: string;
@@ -1284,12 +1356,13 @@ interface TopiaInterface {
 }
 
 interface UserInterface {
-    fetchAssets(): Promise<void | ResponseType>;
-    fetchScenes(): Promise<void | ResponseType>;
-    fetchWorldsByKey(): Promise<void | ResponseType>;
-    fetchDataObject(): Promise<void | ResponseType>;
-    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType>;
-    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType>;
+    fetchAssets(): Promise<void | ResponseType$1>;
+    fetchPlatformAssets(): Promise<object | ResponseType$1>;
+    fetchScenes(): Promise<void | ResponseType$1>;
+    fetchWorldsByKey(): Promise<void | ResponseType$1>;
+    fetchDataObject(): Promise<void | ResponseType$1>;
+    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType$1>;
+    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
     dataObject?: object | null;
 }
 interface UserOptionalInterface {
@@ -1300,14 +1373,14 @@ interface UserOptionalInterface {
 }
 
 interface VisitorInterface extends SDKInterface {
-    fetchVisitor(): Promise<void | ResponseType>;
-    moveVisitor({ shouldTeleportVisitor, x, y }: MoveVisitorInterface): Promise<void | ResponseType>;
-    fireToast({ groupId, title, text }: FireToastInterface): Promise<void | ResponseType>;
-    openIframe({ link, shouldOpenInDrawer, title }: OpenIframeInterface): Promise<void | ResponseType>;
-    fetchDataObject(): Promise<void | ResponseType>;
-    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType>;
-    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType>;
-    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType>;
+    fetchVisitor(): Promise<void | ResponseType$1>;
+    moveVisitor({ shouldTeleportVisitor, x, y }: MoveVisitorInterface): Promise<void | ResponseType$1>;
+    fireToast({ groupId, title, text }: FireToastInterface): Promise<void | ResponseType$1>;
+    openIframe({ link, shouldOpenInDrawer, title }: OpenIframeInterface): Promise<void | ResponseType$1>;
+    fetchDataObject(): Promise<void | ResponseType$1>;
+    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType$1>;
+    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType$1>;
+    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
     color?: string;
     dataObject?: object | null | undefined;
     displayName?: string;
@@ -1408,9 +1481,9 @@ interface WorldDetailsInterface {
     width?: number;
 }
 interface WorldInterface extends SDKInterface, WorldDetailsInterface {
-    fetchDetails(): Promise<void | ResponseType>;
-    updateDetails({ controls, description, forceAuthOnLogin, height, name, spawnPosition, width, }: WorldDetailsInterface): Promise<void | ResponseType>;
-    fetchDroppedAssets(): Promise<void | ResponseType>;
+    fetchDetails(): Promise<void | ResponseType$1>;
+    updateDetails({ controls, description, forceAuthOnLogin, height, name, spawnPosition, width, }: WorldDetailsInterface): Promise<void | ResponseType$1>;
+    fetchDroppedAssets(): Promise<void | ResponseType$1>;
     fetchDroppedAssetsWithUniqueName({ uniqueName, isPartial, isReversed, }: {
         uniqueName: string;
         isPartial?: boolean;
@@ -1421,12 +1494,12 @@ interface WorldInterface extends SDKInterface, WorldDetailsInterface {
         assetSuffix: string;
         position: object;
         sceneId: string;
-    }): Promise<object | ResponseType>;
-    replaceScene(sceneId: string): Promise<void | ResponseType>;
-    fetchDataObject(): Promise<void | ResponseType>;
-    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType>;
-    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType>;
-    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType>;
+    }): Promise<object | ResponseType$1>;
+    replaceScene(sceneId: string): Promise<void | ResponseType$1>;
+    fetchDataObject(): Promise<void | ResponseType$1>;
+    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType$1>;
+    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType$1>;
+    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
     dataObject?: object | null;
 }
 interface WorldOptionalInterface {
@@ -1489,7 +1562,7 @@ declare class Topia implements TopiaInterface {
  * await new SDKController({ credentials, topia });
  * ```
  */
-declare class SDKController implements SDKInterface {
+declare abstract class SDKController implements SDKInterface {
     credentials: InteractiveCredentials | undefined;
     jwt?: string;
     requestOptions: object;
@@ -1529,8 +1602,19 @@ declare class SDKController implements SDKInterface {
  */
 declare class Asset extends SDKController implements AssetInterface {
     readonly id?: string;
+    urlSlug?: string;
     constructor(topia: Topia, id: string, options?: AssetOptionalInterface);
-    fetchPlatformAssets(): Promise<object | ResponseType>;
+    /**
+     * @summary
+     * Retrieves platform asset details.
+     *
+     * @usage
+     * ```ts
+     * await asset.fetchAssetById();
+     * const { assetName } = asset;
+     * ```
+     */
+    fetchAssetById(): Promise<object | ResponseType$1>;
 }
 
 /**
@@ -1587,7 +1671,7 @@ declare class WorldActivity extends SDKController {
      * @result
      * Updates each Visitor instance and worldActivity.visitors map.
      */
-    moveAllVisitors({ shouldFetchVisitors, shouldTeleportVisitors, scatterVisitorsBy, x, y, }: MoveAllVisitorsInterface): Promise<(void | ResponseType)[] | undefined>;
+    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.
@@ -1613,20 +1697,92 @@ declare class WorldActivity extends SDKController {
      * @result
      * Updates each Visitor instance and worldActivity.visitors map.
      */
-    moveVisitors(visitorsToMove: VisitorsToMoveArrayType): Promise<(void | ResponseType)[]>;
+    moveVisitors(visitorsToMove: VisitorsToMoveArrayType): Promise<(void | ResponseType$1)[]>;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const Asset = new AssetFactory(myTopiaInstance);
+ * ```
+ */
 declare class AssetFactory {
     topia: Topia;
     constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of Asset class.
+     *
+     * @usage
+     * ```
+     * const assetInstance = await Asset.create(id, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(id: string, options?: AssetOptionalInterface): Asset;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const DroppedAsset = new DroppedAssetFactory(myTopiaInstance);
+ * ```
+ */
 declare class DroppedAssetFactory extends SDKController {
     constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of DroppedAsset class.
+     *
+     * @usage
+     * ```
+     * const droppedAssetInstance = await DroppedAsset.create(assetId, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(id: string, urlSlug: string, options?: DroppedAssetOptionalInterface): DroppedAsset;
+    /**
+     * @summary
+     * Instantiate a new instance of DroppedAsset class and retrieve all properties.
+     *
+     * @usage
+     * ```
+     * const droppedAssetInstance = await DroppedAsset.get(assetId, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     get(id: string, urlSlug: string, options?: DroppedAssetOptionalInterface): Promise<DroppedAsset>;
-    getWithUniqueName(uniqueName: string, urlSlug: string, interactivePublicKey: string, interactiveSecret: string): 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
+     * ```
+     * const droppedAssetInstance = await DroppedAsset.getWithUniqueName("exampleUniqueName", urlSlug, { interactivePublicKey, interactiveSecret });
+     * ```
+     */
+    getWithUniqueName(uniqueName: string, urlSlug: string, credentials: {
+        apiKey?: string;
+        interactivePublicKey?: string;
+        interactiveSecret?: string;
+    }): Promise<DroppedAsset>;
+    /**
+     * @summary
+     * Drops an asset in a world and returns a new instance of DroppedAsset class with all properties.
+     *
+     * @usage
+     * ```
+     * const assetInstance = await Asset.create(id, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * const droppedAssetInstance = await DroppedAsset.get(assetInstance, {
+          assetScale: 1.5,
+          flipped: true,
+          layer0: "",
+          layer1: "https://pathtoimage.png",
+          interactivePublicKey,
+          isInteractive: true,
+          position: { x: 0, y: 0 },
+          uniqueName: "exampleUniqueName",
+          urlSlug,
+        });
+     * ```
+     */
     drop(asset: Asset, { assetScale, flipped, interactivePublicKey, isInteractive, layer0, layer1, position: { x, y }, sceneDropId, text, textColor, textSize, textWeight, textWidth, uniqueName, urlSlug, yOrderAdjust, }: {
         assetScale?: number;
         flipped?: boolean;
@@ -1650,38 +1806,144 @@ declare class DroppedAssetFactory extends SDKController {
     }): Promise<DroppedAsset>;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const Scene = new SceneFactory(myTopiaInstance);
+ * ```
+ */
 declare class SceneFactory {
     topia: Topia;
     constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of Scene class.
+     *
+     * @usage
+     * ```
+     * const sceneInstance = await Scene.create(id, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(id: string, options?: SceneOptionalInterface): Scene;
+    /**
+     * @summary
+     * Instantiate a new instance of Scene class and retrieve all properties.
+     *
+     * @usage
+     * ```
+     * const sceneInstance = await Scene.get(id, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     get(id: string, options?: SceneOptionalInterface): Promise<Scene>;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const User = new UserFactory(myTopiaInstance);
+ * ```
+ */
 declare class UserFactory {
     topia: Topia;
     constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of User class.
+     *
+     * @usage
+     * ```
+     * const userInstance = await User.create({ credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(options?: UserOptionalInterface): User;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const Visitor = new VisitorFactory(myTopiaInstance);
+ * ```
+ */
 declare class VisitorFactory {
     topia: Topia;
     constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of Visitor class.
+     *
+     * @usage
+     * ```
+     * const visitorInstance = await Visitor.create(id, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(id: number, urlSlug: string, options?: VisitorOptionalInterface): Visitor;
+    /**
+     * @summary
+     * Instantiate a new instance of Visitor class and retrieve all properties.
+     *
+     * @usage
+     * ```
+     * const visitorInstance = await Visitor.get(id, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     get(id: number, urlSlug: string, options?: VisitorOptionalInterface): Promise<Visitor>;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const WorldActivity = new WorldActivityFactory(myTopiaInstance);
+ * ```
+ */
 declare class WorldActivityFactory {
     topia: Topia;
     constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of WorldActivity class.
+     *
+     * @usage
+     * ```
+     * const worldActivityInstance = await WorldActivity.create(urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(urlSlug: string, options?: WorldOptionalInterface): WorldActivity;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const World = new WorldFactory(myTopiaInstance);
+ * ```
+ */
 declare class WorldFactory extends SDKController {
     constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of World class.
+     *
+     * @usage
+     * ```
+     * const worldInstance = await World.create(urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(urlSlug: string, options?: WorldOptionalInterface): World;
-    deleteDroppedAssets(urlSlug: string, droppedAssetIds: string[], interactivePublicKey: string, interactiveSecret: string): Promise<{
+    /**
+     * @summary
+     * Deletes an array of Dropped Assets from within a world and returns success: true
+     *
+     * @usage
+     * ```
+     * await World.deleteDroppedAssets(urlSlug, ["exampleDroppedAssetId1", "exampleDroppedAssetId2"], { interactiveNonce, interactivePublicKey, visitorId });
+     * ```
+     */
+    deleteDroppedAssets(urlSlug: string, droppedAssetIds: string[], credentials: {
+        apiKey?: string;
+        interactivePublicKey?: string;
+        interactiveSecret?: string;
+    }): Promise<{
         success: boolean;
     }>;
 }
 
-export { Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, FireToastInterface, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WebhookInterface, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };
+export { Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, FireToastInterface, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, ResponseType$1 as ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WebhookInterface, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };