@rtsdk/topia 0.16.3 → 0.17.0

package/dist/index.cjs

@@ -40042,7 +40042,6 @@ class DroppedAsset extends Asset {
      * });
      * ```
      */
-    // get dropped asset
     updateDataObject(dataObject, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
@@ -40141,6 +40140,95 @@ class DroppedAsset extends Asset {
             throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.updateClickType" });
         }
     }
+    /**
+     * @summary
+     * Adds an array of links to an asset. Maximum is 20 links.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.setClickableLinkMulti({
+     *   clickableLinks: [
+     *     {
+     *       clickableLink: "https://example_one.com",
+     *       clickableLinkTitle: "Example One Link",
+     *       isForceLinkInIframe: true,
+     *       isOpenLinkInDrawer: false,
+     *     },
+     *     {
+     *       clickableLink: "https://example two.com",
+     *       clickableLinkTitle: "Example Two Link",
+     *       isForceLinkInIframe: false,
+     *       isOpenLinkInDrawer: false,
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    setClickableLinkMulti({ clickableLinks }) {
+        const params = {
+            clickType: exports.DroppedAssetClickType.LINK,
+            clickableLinks,
+        };
+        try {
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "set-clickable-link-multi");
+        }
+        catch (error) {
+            throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.setClickableLinkMulti" });
+        }
+    }
+    /**
+     * @summary
+     * Updates multiple clickable links for a dropped asset.
+     * Pass in an 'existingLinkId' to edit an existing link.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateClickableLinkMulti({
+     *   clickableLink: "https://example.com",
+     *   clickableLinkTitle: "Example Link",
+     *   isForceLinkInIframe: true,
+     *   isOpenLinkInDrawer: false,
+     *   existingLinkId: "abcd"
+     * });
+     * ```
+     */
+    updateClickableLinkMulti({ clickableLink, clickableLinkTitle, isForceLinkInIframe, isOpenLinkInDrawer, existingLinkId, linkSamlQueryParams, }) {
+        const params = {
+            clickType: exports.DroppedAssetClickType.LINK,
+            clickableLink,
+            clickableLinkTitle,
+            isForceLinkInIframe,
+            isOpenLinkInDrawer,
+            existingLinkId,
+            linkSamlQueryParams,
+        };
+        try {
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "update-clickable-link-multi");
+        }
+        catch (error) {
+            throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.updateClickableLinkMulti" });
+        }
+    }
+    /**
+     * @summary
+     * Removes a clickable link from a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.removeClickableLink({ linkId: "link-id" });
+     * ```
+     */
+    removeClickableLink({ linkId }) {
+        const params = {
+            linkId,
+        };
+        try {
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "remove-clickable-link");
+        }
+        catch (error) {
+            throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.removeClickableLink" });
+        }
+    }
     /**
      * @summary
      * Updates text and style of a dropped asset.
@@ -40910,8 +40998,7 @@ class World extends SDKController {
      *
      * @usage
      * ```ts
-     * await world.fetchDroppedAssetsWithUniqueName();
-     * const assets = world.droppedAssets;
+     * const droppedAssets = await world.fetchDroppedAssetsWithUniqueName({u niqueName: "exampleUniqueName", isPartial: true });
      * ```
      */
     fetchDroppedAssetsWithUniqueName({ uniqueName, isPartial = false, isReversed = false, }) {
@@ -42699,6 +42786,9 @@ class DroppedAssetFactory extends SDKController {
      * ```
      * 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.
      */
     getWithUniqueName(uniqueName, urlSlug, interactiveSecret, credentials) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/index.d.ts

@@ -59,6 +59,14 @@ declare enum DroppedAssetMediaType {
     NONE = "none",
     LINK = "link"
 }
+type DroppedAssetLinkType = {
+    clickableLink: string;
+    clickableLinkTitle?: string;
+    isForceLinkInIframe?: boolean;
+    isOpenLinkInDrawer?: boolean;
+    existingLinkId?: string;
+    linkSamlQueryParams?: string;
+};
 
 type InteractiveCredentials = {
     apiKey?: string;
@@ -319,6 +327,58 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, isForceLinkInIframe, isOpenLinkInDrawer, portalName, position, }: UpdateClickTypeInterface): Promise<void | ResponseType$1>;
+    /**
+     * @summary
+     * Adds an array of links to an asset. Maximum is 20 links.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.setClickableLinkMulti({
+     *   clickableLinks: [
+     *     {
+     *       clickableLink: "https://example_one.com",
+     *       clickableLinkTitle: "Example One Link",
+     *       isForceLinkInIframe: true,
+     *       isOpenLinkInDrawer: false,
+     *     },
+     *     {
+     *       clickableLink: "https://example two.com",
+     *       clickableLinkTitle: "Example Two Link",
+     *       isForceLinkInIframe: false,
+     *       isOpenLinkInDrawer: false,
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    setClickableLinkMulti({ clickableLinks }: SetClickableLinkMultiInterface): Promise<void | ResponseType$1>;
+    /**
+     * @summary
+     * Updates multiple clickable links for a dropped asset.
+     * Pass in an 'existingLinkId' to edit an existing link.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateClickableLinkMulti({
+     *   clickableLink: "https://example.com",
+     *   clickableLinkTitle: "Example Link",
+     *   isForceLinkInIframe: true,
+     *   isOpenLinkInDrawer: false,
+     *   existingLinkId: "abcd"
+     * });
+     * ```
+     */
+    updateClickableLinkMulti({ clickableLink, clickableLinkTitle, isForceLinkInIframe, isOpenLinkInDrawer, existingLinkId, linkSamlQueryParams, }: UpdateClickableLinkMultiInterface): Promise<void | ResponseType$1>;
+    /**
+     * @summary
+     * Removes a clickable link from a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.removeClickableLink({ linkId: "link-id" });
+     * ```
+     */
+    removeClickableLink({ linkId }: RemoveClickableLinkInterface): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Updates text and style of a dropped asset.
@@ -620,8 +680,7 @@ declare class World extends SDKController implements WorldInterface {
      *
      * @usage
      * ```ts
-     * await world.fetchDroppedAssetsWithUniqueName();
-     * const assets = world.droppedAssets;
+     * const droppedAssets = await world.fetchDroppedAssetsWithUniqueName({u niqueName: "exampleUniqueName", isPartial: true });
      * ```
      */
     fetchDroppedAssetsWithUniqueName({ uniqueName, isPartial, isReversed, }: {
@@ -1803,6 +1862,20 @@ interface UpdateClickTypeInterface {
         y: number;
     };
 }
+interface SetClickableLinkMultiInterface {
+    clickableLinks: DroppedAssetLinkType[];
+}
+interface UpdateClickableLinkMultiInterface {
+    clickableLink: string;
+    clickableLinkTitle?: string;
+    isForceLinkInIframe?: boolean;
+    isOpenLinkInDrawer?: boolean;
+    existingLinkId?: string;
+    linkSamlQueryParams?: string;
+}
+interface RemoveClickableLinkInterface {
+    linkId: string;
+}
 interface UpdateMediaTypeInterface {
     audioRadius: number;
     audioSliderVolume: number;
@@ -2470,6 +2543,9 @@ declare class DroppedAssetFactory extends SDKController {
      * ```
      * 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.
      */
     getWithUniqueName(uniqueName: string, urlSlug: string, interactiveSecret: string, credentials: InteractiveCredentials): Promise<DroppedAsset>;
     /**
@@ -2707,4 +2783,4 @@ declare class WorldFactory extends SDKController {
     }>;
 }
 
-export { AnalyticType, AnimationMetaType, Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, AssetType, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, Ecosystem, EcosystemFactory, EcosystemInterface, EcosystemOptionalInterface, FireToastInterface, FrameType, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, ResponseType$1 as ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateDroppedAssetInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WebRTCConnector, WebRTCConnectorFactory, WebRTCConnectorInterface, WebRTCConnectorOptionalInterface, WebhookInterface, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldActivityType, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };
+export { AnalyticType, AnimationMetaType, Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, AssetType, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetLinkType, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, Ecosystem, EcosystemFactory, EcosystemInterface, EcosystemOptionalInterface, FireToastInterface, FrameType, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, RemoveClickableLinkInterface, ResponseType$1 as ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, SetClickableLinkMultiInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateClickableLinkMultiInterface, UpdateDroppedAssetInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WebRTCConnector, WebRTCConnectorFactory, WebRTCConnectorInterface, WebRTCConnectorOptionalInterface, WebhookInterface, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldActivityType, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };

package/dist/index.js

@@ -40040,7 +40040,6 @@ class DroppedAsset extends Asset {
      * });
      * ```
      */
-    // get dropped asset
     updateDataObject(dataObject, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
@@ -40139,6 +40138,95 @@ class DroppedAsset extends Asset {
             throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.updateClickType" });
         }
     }
+    /**
+     * @summary
+     * Adds an array of links to an asset. Maximum is 20 links.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.setClickableLinkMulti({
+     *   clickableLinks: [
+     *     {
+     *       clickableLink: "https://example_one.com",
+     *       clickableLinkTitle: "Example One Link",
+     *       isForceLinkInIframe: true,
+     *       isOpenLinkInDrawer: false,
+     *     },
+     *     {
+     *       clickableLink: "https://example two.com",
+     *       clickableLinkTitle: "Example Two Link",
+     *       isForceLinkInIframe: false,
+     *       isOpenLinkInDrawer: false,
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    setClickableLinkMulti({ clickableLinks }) {
+        const params = {
+            clickType: DroppedAssetClickType.LINK,
+            clickableLinks,
+        };
+        try {
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "set-clickable-link-multi");
+        }
+        catch (error) {
+            throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.setClickableLinkMulti" });
+        }
+    }
+    /**
+     * @summary
+     * Updates multiple clickable links for a dropped asset.
+     * Pass in an 'existingLinkId' to edit an existing link.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateClickableLinkMulti({
+     *   clickableLink: "https://example.com",
+     *   clickableLinkTitle: "Example Link",
+     *   isForceLinkInIframe: true,
+     *   isOpenLinkInDrawer: false,
+     *   existingLinkId: "abcd"
+     * });
+     * ```
+     */
+    updateClickableLinkMulti({ clickableLink, clickableLinkTitle, isForceLinkInIframe, isOpenLinkInDrawer, existingLinkId, linkSamlQueryParams, }) {
+        const params = {
+            clickType: DroppedAssetClickType.LINK,
+            clickableLink,
+            clickableLinkTitle,
+            isForceLinkInIframe,
+            isOpenLinkInDrawer,
+            existingLinkId,
+            linkSamlQueryParams,
+        };
+        try {
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "update-clickable-link-multi");
+        }
+        catch (error) {
+            throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.updateClickableLinkMulti" });
+        }
+    }
+    /**
+     * @summary
+     * Removes a clickable link from a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.removeClickableLink({ linkId: "link-id" });
+     * ```
+     */
+    removeClickableLink({ linkId }) {
+        const params = {
+            linkId,
+        };
+        try {
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "remove-clickable-link");
+        }
+        catch (error) {
+            throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.removeClickableLink" });
+        }
+    }
     /**
      * @summary
      * Updates text and style of a dropped asset.
@@ -40908,8 +40996,7 @@ class World extends SDKController {
      *
      * @usage
      * ```ts
-     * await world.fetchDroppedAssetsWithUniqueName();
-     * const assets = world.droppedAssets;
+     * const droppedAssets = await world.fetchDroppedAssetsWithUniqueName({u niqueName: "exampleUniqueName", isPartial: true });
      * ```
      */
     fetchDroppedAssetsWithUniqueName({ uniqueName, isPartial = false, isReversed = false, }) {
@@ -42697,6 +42784,9 @@ class DroppedAssetFactory extends SDKController {
      * ```
      * 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.
      */
     getWithUniqueName(uniqueName, urlSlug, interactiveSecret, credentials) {
         return __awaiter(this, void 0, void 0, function* () {

package/package.json

@@ -60,5 +60,5 @@
     "yalc-push": "yarn build && yalc publish --push --dev --no-scripts"
   },
   "type": "module",
-  "version": "0.16.03"
+  "version": "0.17.00"
 }