@zoom/cobrowsesdk 2.7.1 → 2.8.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zoom/cobrowsesdk",
-  "version": "2.7.1",
+  "version": "2.8.1",
   "description": "ZOOM Cobrowse sdk",
   "files": [
     "esm",

package/types/agent-umd.d.ts

@@ -732,6 +732,70 @@ declare function customer_transferred(payload: {
 	 */
 	version: string;
 }): void;
+declare function remote_assist_accepted(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
+declare function remote_assist_rejected(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
+declare function remote_assist_started(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
+declare function remote_assist_stopped(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
 declare function session_ended(payload: {
 	/**
 	 * reason
@@ -835,6 +899,22 @@ declare namespace Session {
 	 * ```
 	 */
 	function getSessionInfo(): SessionInfo | null;
+	/**
+	 * @description Start remote assistance.
+	 * @example
+	 * ```
+	 * session.startRemoteAssist();
+	 * ```
+	 */
+	function startRemoteAssist(): void;
+	/**
+	 * @description Stop remote assistance
+	 * @example
+	 * ```
+	 * session.stopRemoteAssist();
+	 * ```
+	 */
+	function stopRemoteAssist(): void;
 	/**
 	 * @param event Session ended.
 	 * @param listener Details in {@link session_ended}.
@@ -865,6 +945,26 @@ declare namespace Session {
 	 * @param listener Details in {@link customer_transferred}.
 	 */
 	function on(event: "customer_transferred", listener: typeof customer_transferred): void;
+	/**
+	 * @param event Remote assist accepted.
+	 * @param listener Details in {@link remote_assist_accepted}.
+	 */
+	function on(event: "remote_assist_accepted", listener: typeof remote_assist_accepted): void;
+	/**
+	 * @param event Remote assist rejected.
+	 * @param listener Details in {@link remote_assist_rejected}.
+	 */
+	function on(event: "remote_assist_rejected", listener: typeof remote_assist_rejected): void;
+	/**
+	 * @param event Remote assist started.
+	 * @param listener Details in {@link remote_assist_started}.
+	 */
+	function on(event: "remote_assist_started", listener: typeof remote_assist_started): void;
+	/**
+	 * @param event Remote assist stopped.
+	 * @param listener Details in {@link remote_assist_stopped}.
+	 */
+	function on(event: "remote_assist_stopped", listener: typeof remote_assist_stopped): void;
 }
 /**
  * @description ZoomAgentCobrowseSDK createAgentViewerEndpoint Callback.

package/types/agent.d.ts

@@ -732,6 +732,70 @@ declare function customer_transferred(payload: {
 	 */
 	version: string;
 }): void;
+declare function remote_assist_accepted(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
+declare function remote_assist_rejected(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
+declare function remote_assist_started(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
+declare function remote_assist_stopped(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
 declare function session_ended(payload: {
 	/**
 	 * reason
@@ -829,6 +893,22 @@ declare namespace Session {
 	 * ```
 	 */
 	function getSessionInfo(): SessionInfo | null;
+	/**
+	 * @description Start remote assistance.
+	 * @example
+	 * ```
+	 * session.startRemoteAssist();
+	 * ```
+	 */
+	function startRemoteAssist(): void;
+	/**
+	 * @description Stop remote assistance
+	 * @example
+	 * ```
+	 * session.stopRemoteAssist();
+	 * ```
+	 */
+	function stopRemoteAssist(): void;
 	/**
 	 * @param event Session ended.
 	 * @param listener Details in {@link session_ended}.
@@ -859,6 +939,26 @@ declare namespace Session {
 	 * @param listener Details in {@link customer_transferred}.
 	 */
 	function on(event: "customer_transferred", listener: typeof customer_transferred): void;
+	/**
+	 * @param event Remote assist accepted.
+	 * @param listener Details in {@link remote_assist_accepted}.
+	 */
+	function on(event: "remote_assist_accepted", listener: typeof remote_assist_accepted): void;
+	/**
+	 * @param event Remote assist rejected.
+	 * @param listener Details in {@link remote_assist_rejected}.
+	 */
+	function on(event: "remote_assist_rejected", listener: typeof remote_assist_rejected): void;
+	/**
+	 * @param event Remote assist started.
+	 * @param listener Details in {@link remote_assist_started}.
+	 */
+	function on(event: "remote_assist_started", listener: typeof remote_assist_started): void;
+	/**
+	 * @param event Remote assist stopped.
+	 * @param listener Details in {@link remote_assist_stopped}.
+	 */
+	function on(event: "remote_assist_stopped", listener: typeof remote_assist_stopped): void;
 }
 /**
  * @description ZoomAgentCobrowseSDK createAgentViewerEndpoint Callback.

package/types/customer-umd.d.ts

@@ -493,13 +493,23 @@ declare enum EndReason {
 declare enum InitError {
 	UNKNOWN = "unknown"
 }
+declare enum RemoteAssistUserRole {
+	/**
+	 * Customer role
+	 */
+	CUSTOMER = "1",
+	/**
+	 * Agent role
+	 */
+	AGENT = "2"
+}
 declare enum SessionErrorCode {
 	/**
 	 * @description Start session failed.
 	 */
 	SESSION_START_FAILED = 1001,
 	/**
-	 * @description There is already a session in progress.
+	 * @description Session is connecting.
 	 */
 	SESSION_CONNECTING_IN_PROGRESS = 1002,
 	/**
@@ -527,7 +537,7 @@ declare enum SessionErrorCode {
 	 */
 	NETWORK_ERROR = 1016,
 	/**
-	 * @description There is already a session in progress.
+	 * @description Session is canceling.
 	 */
 	SESSION_CANCELING_IN_PROGRESS = 1017,
 	/**
@@ -659,6 +669,78 @@ declare function pincode_updated(payload: {
 	 */
 	version: string;
 }): void;
+declare function remote_assist_cancelled(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
+declare function remote_assist_requested(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * User info.
+	 */
+	user: {
+		id: string;
+		name: string;
+		role: RemoteAssistUserRole; // '1':CUSTOMER '2':AGENT
+	};
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
+declare function remote_assist_started(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
+declare function remote_assist_stopped(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
 declare function session_ended(payload: {
 	/**
 	 * Reason.
@@ -746,6 +828,14 @@ declare namespace Session {
 	 * ```
 	 */
 	function getSessionInfo(): SessionInfo | null;
+	/**
+	 * @description Stop remote assistance.
+	 * @example
+	 * ```
+	 * session.stopRemoteAssist();
+	 * ```
+	 */
+	function stopRemoteAssist(): void;
 	/**
 	 * @param event Session started
 	 * @param listener Details in {@link session_started}.
@@ -791,6 +881,26 @@ declare namespace Session {
 	 * @param listener Details in {@link current_user_transfer}.
 	 */
 	function on(event: "current_user_transfer", listener: typeof current_user_transfer): void;
+	/**
+	 * @param event Remote assist requested
+	 * @param listener Details in {@link remote_assist_requested}.
+	 */
+	function on(event: "remote_assist_requested", listener: typeof remote_assist_requested): void;
+	/**
+	 * @param event Remote assist cancelled
+	 * @param listener Details in {@link remote_assist_cancelled}.
+	 */
+	function on(event: "remote_assist_cancelled", listener: typeof remote_assist_cancelled): void;
+	/**
+	 * @param event Remote assist started
+	 * @param listener Details in {@link remote_assist_started}.
+	 */
+	function on(event: "remote_assist_started", listener: typeof remote_assist_started): void;
+	/**
+	 * @param event Remote assist stopped
+	 * @param listener Details in {@link remote_assist_stopped}.
+	 */
+	function on(event: "remote_assist_stopped", listener: typeof remote_assist_stopped): void;
 }
 /**
  * @description
@@ -955,6 +1065,10 @@ export type Settings = {
 		 * @description Whether to enable customer consent, the default is true.
 		 */
 		enableCustomerConsent?: boolean;
+		/**
+		 * @description Whether to enable secondary confirmation, the default is false.
+		 */
+		requireStopConfirmation?: boolean;
 		/**
 		 * @description Remote assist type, currently only support 'scroll_page', the default is 'scroll_page'.
 		 */
@@ -963,7 +1077,7 @@ export type Settings = {
 	/**
 	 * @description Session continuation config.
 	 */
-	allowSessionContinuation?: {
+	multiTabSessionPersistence?: {
 		/**
 		 * @description Whether to enable session continuation, the default is false.
 		 */

package/types/customer.d.ts

@@ -493,13 +493,23 @@ declare enum EndReason {
 declare enum InitError {
 	UNKNOWN = "unknown"
 }
+declare enum RemoteAssistUserRole {
+	/**
+	 * Customer role
+	 */
+	CUSTOMER = "1",
+	/**
+	 * Agent role
+	 */
+	AGENT = "2"
+}
 declare enum SessionErrorCode {
 	/**
 	 * @description Start session failed.
 	 */
 	SESSION_START_FAILED = 1001,
 	/**
-	 * @description There is already a session in progress.
+	 * @description Session is connecting.
 	 */
 	SESSION_CONNECTING_IN_PROGRESS = 1002,
 	/**
@@ -527,7 +537,7 @@ declare enum SessionErrorCode {
 	 */
 	NETWORK_ERROR = 1016,
 	/**
-	 * @description There is already a session in progress.
+	 * @description Session is canceling.
 	 */
 	SESSION_CANCELING_IN_PROGRESS = 1017,
 	/**
@@ -659,6 +669,78 @@ declare function pincode_updated(payload: {
 	 */
 	version: string;
 }): void;
+declare function remote_assist_cancelled(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
+declare function remote_assist_requested(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * User info.
+	 */
+	user: {
+		id: string;
+		name: string;
+		role: RemoteAssistUserRole; // '1':CUSTOMER '2':AGENT
+	};
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
+declare function remote_assist_started(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
+declare function remote_assist_stopped(payload: {
+	/**
+	 * Assistance type array. Only supports ['scroll_page'].
+	 */
+	assistType: [
+		"scroll_page"
+	];
+	/**
+	 * Session ID.
+	 */
+	sessionId: string;
+	/**
+	 * SDK version.
+	 */
+	version: string;
+}): void;
 declare function session_ended(payload: {
 	/**
 	 * Reason.
@@ -740,6 +822,14 @@ declare namespace Session {
 	 * ```
 	 */
 	function getSessionInfo(): SessionInfo | null;
+	/**
+	 * @description Stop remote assistance.
+	 * @example
+	 * ```
+	 * session.stopRemoteAssist();
+	 * ```
+	 */
+	function stopRemoteAssist(): void;
 	/**
 	 * @param event Session started
 	 * @param listener Details in {@link session_started}.
@@ -785,6 +875,26 @@ declare namespace Session {
 	 * @param listener Details in {@link current_user_transfer}.
 	 */
 	function on(event: "current_user_transfer", listener: typeof current_user_transfer): void;
+	/**
+	 * @param event Remote assist requested
+	 * @param listener Details in {@link remote_assist_requested}.
+	 */
+	function on(event: "remote_assist_requested", listener: typeof remote_assist_requested): void;
+	/**
+	 * @param event Remote assist cancelled
+	 * @param listener Details in {@link remote_assist_cancelled}.
+	 */
+	function on(event: "remote_assist_cancelled", listener: typeof remote_assist_cancelled): void;
+	/**
+	 * @param event Remote assist started
+	 * @param listener Details in {@link remote_assist_started}.
+	 */
+	function on(event: "remote_assist_started", listener: typeof remote_assist_started): void;
+	/**
+	 * @param event Remote assist stopped
+	 * @param listener Details in {@link remote_assist_stopped}.
+	 */
+	function on(event: "remote_assist_stopped", listener: typeof remote_assist_stopped): void;
 }
 /**
  * @description
@@ -949,6 +1059,10 @@ export type Settings = {
 		 * @description Whether to enable customer consent, the default is true.
 		 */
 		enableCustomerConsent?: boolean;
+		/**
+		 * @description Whether to enable secondary confirmation, the default is false.
+		 */
+		requireStopConfirmation?: boolean;
 		/**
 		 * @description Remote assist type, currently only support 'scroll_page', the default is 'scroll_page'.
 		 */
@@ -957,7 +1071,7 @@ export type Settings = {
 	/**
 	 * @description Session continuation config.
 	 */
-	allowSessionContinuation?: {
+	multiTabSessionPersistence?: {
 		/**
 		 * @description Whether to enable session continuation, the default is false.
 		 */