@interopio/workspaces-api 5.0.0-next.0 → 5.1.0-next.0

package/workspaces.d.ts

@@ -7,177 +7,281 @@ export default WorkspacesFactory;
 /**
  * @docname Workspaces
  * @intro
- * The Workspaces API offers advanced window management functionalities. Using Workspaces, users are able to arrange multiple apps
- * within the same visual window (called Frame or a Workspaces App). This arrangement can be performed programmatically or by dragging and dropping
- * apps within the Frame. Users can also save Workspace Layouts and restore them within the same Frame or even in different Frames.
- *
- * The app windows in a Workspace are treated as individual building blocks that can be added, removed, moved, or resized within the Workspace.
- * The Frame can hold multiple Workspaces (as tabs) and can also be maximized, minimized or resized.
+ * The Workspaces API offers advanced window management functionalities. Workspaces allow you to arrange multiple apps within the same visual window
+ * called a Workspaces App (or `Frame`). This is performed either programmatically or by dragging and dropping floating windows in a Workspace,
+ * rearranging windows that are already in the Workspace, or extracting windows from the Workspace. Each app is treated as an individual building block
+ * that can be added, removed, moved, or resized within the unifying Workspaces App instance. Workspace Layouts can be saved and restored within the same
+ * or in different Workspaces App instances. When a Workspace Layout is restored, the arrangement of the apps participating in it is preserved
+ * and you can also save their context data, allowing you to resume working right from where you left off.
  *
  * The Workspaces API is accessible via the [`io.workspaces`](#API) object.
  */
 export namespace IOConnectWorkspaces {
 
-    /** An object describing a workspace layout. */
+    /**
+     * Describes a Workspace Layout.
+     */
     export interface WorkspaceLayout {
-        /** A unique string identifier of the layout */
+        /**
+         * Unique ID of the Workspace Layout, assigned by the platform.
+         * *Available only in **io.Connect Desktop**.*
+         * @since io.Connect Desktop 10.5
+         * @since @interopio/workspaces-api 5.0.0
+         */
         id?: string;
 
-        /** name of the layout */
+        /**
+         * Name of the Workspace Layout.
+         */
         name: string;
 
-        /** The type of the workspace element. */
+        /**
+         * Type of the Layout.
+         */
         type: "Workspace";
 
-        /** The components of the workspace layout. This collection can contain only one element and it must be a workspace component. */
+        /**
+         * Components of the Workspace Layout. The array must contain only one member, which must be a Workspace component.
+         */
         components: Array<WorkspaceComponent>;
 
-        /** An object containing various layout metadata. */
+        /**
+         * Metadata of the Workspace Layout.
+         */
         metadata?: any;
     }
 
+    /**
+     * Describes the state of a Workspace component in a Workspace Layout.
+     */
     export interface WorkspaceLayoutComponentState {
-        /** An array of all the workspace's children. */
+        /**
+         * Array of objects, each describing a child element of the Workspace.
+         */
         children: Array<RowLayoutItem | ColumnLayoutItem | GroupLayoutItem | WindowLayoutItem>;
 
-        /** An object containing various element settings. */
+        /**
+         * Settings of the Workspace.
+         */
         config: any;
 
-        /** An object containing the context of the workspace layout */
+        /**
+         * Context of the Workspace.
+         */
         context: any;
     }
 
-    /** An object describing a workspace definition in a workspace layout. */
+    /**
+     * Describes a Workspace component in a Workspace Layout.
+     */
     export interface WorkspaceComponent {
-        /** The type of the workspace element. */
+        /**
+         * Type of the component.
+         */
         type: "Workspace";
 
         /**
-         * The name of the workspaces app with which the layout is associated.
+         * Name of the Workspaces App with which the Workspace Layout is associated.
          * *Available only in **io.Connect Desktop**.*
          */
         application?: string;
 
+        /**
+         * State of the Workspace component.
+         */
         state: WorkspaceLayoutComponentState;
     }
 
-    /** An object describing a row definition in a workspace layout. */
+    /**
+     * Describes a row in a Workspace Layout.
+     */
     export interface RowLayoutItem {
-        /** The type of the workspace element. */
+        /**
+         * Type of the Workspace element.
+         */
         type: "row";
 
-        /** An array of all the row's children. */
+        /**
+         * Array of objects, each describing a child element of the row.
+         */
         children: Array<RowLayoutItem | ColumnLayoutItem | GroupLayoutItem | WindowLayoutItem>;
 
-        /** An object containing various element settings. */
+        /**
+         * Settings of the row.
+         */
         config: any;
     }
 
-    /** An object describing a column definition in a workspace layout. */
+    /**
+     * Describes a column in a Workspace Layout.
+     */
     export interface ColumnLayoutItem {
-        /** The type of the workspace element. */
+        /**
+         * Type of the Workspace element.
+         */
         type: "column";
 
-        /** An array of all the column's children. */
+        /**
+         * Array of objects, each describing a child element of the column.
+         */
         children: Array<RowLayoutItem | ColumnLayoutItem | GroupLayoutItem | WindowLayoutItem>;
 
-        /** An object containing various element settings. */
+        /**
+         * Settings of the column.
+         */
         config: any;
     }
 
-    /** An object describing a group definition in a workspace layout. */
+    /**
+     * Describes a window group in a Workspace Layout.
+     */
     export interface GroupLayoutItem {
-        /** The type of the workspace element. */
+        /**
+         * Type of the Workspace element.
+         */
         type: "group";
 
-        /** An array of all the group's children which can only of type window. */
+        /**
+         * Array of objects, each describing a window in the group. Groups can contain only windows.
+         */
         children: WindowLayoutItem[];
 
-        /** An object containing various element settings. */
+        /**
+         * Settings of the window group.
+         */
         config: any;
     }
 
+    /**
+     * Describes the configuration of a window in a Workspace Layout.
+     */
     export interface WindowLayoutItemConfig {
-        /** The name of the application as specified in its definition. */
+        /**
+         * Name of the app as specified in its definition.
+         */
         appName: string;
-        /** The id of the window */
+
+        /**
+         * ID of the window.
+         */
         windowId?: string;
-        /** The url of the window, in case it is not a defined as an application. */
+
+        /**
+         * URL of the window, if the window isn't defined as an app.
+         */
         url?: string;
-        /** The title of the window */
+
+        /**
+         * Title of the window.
+         */
         title?: string;
-        /** The context of the window used when restoring the window */
+
+        /**
+         * Context of the window that will be used when restoring the window.
+         */
         context?: any;
-        /** Id used for correlating window instances to layout objects */
+
+        /**
+         * ID used for correlating window instances with Layout objects.
+         */
         instanceId?: string;
     }
 
-    /** An object describing a window definition in a workspace layout. */
+    /**
+     * Describes a window in a Workspace Layout.
+     */
     export interface WindowLayoutItem {
-        /** The type of the workspace element. */
+        /**
+         * Type of the Workspace element.
+         */
         type: "window";
-        /** A configuration object for the window layout */
+
+        /**
+         * Configuration of the window.
+         */
         config: WindowLayoutItemConfig;
     }
 
-    /** A function which when called unsubscribes the user from further notifications. */
+    /**
+     * Function for unsubscribing from further notifications.
+     */
     export type Unsubscribe = () => void;
 
-    /** An object containing all the possible settings when restoring a workspace from a layout. */
+    /**
+     * Options for restoring a Workspace from a Workspace Layout.
+     */
     export interface RestoreWorkspaceConfig {
-        /** An object which will be set as the window context of all windows inside this workspace. */
+        /**
+         * Object that will be set as a window context for all windows in the Workspace.
+         */
         context?: object;
 
-        /** The title of the new workspace. */
+        /**
+         * Title for the Workspace.
+         */
         title?: string;
 
-        /** A string id of an existing frame. If provided, this workspace will be opened in that specific frame */
+        /**
+         * ID of an existing `Frame` instance. If provided, the Workspace will be opened in that `Frame` instance.
+         */
         frameId?: string;
 
         /**
-         * The application name of the workspace app that should be used for the new frame.
+         * Name of the Workspaces App that will be used for creating the new `Frame` instance.
          * *Available only in **io.Connect Desktop**.*
          */
         applicationName?: string;
 
-        /** A setting used to declare that the workspace must be in a new frame and also provide options for that new frame */
+        /**
+         * If `true`, the Workspace will be opened in a new `Frame` instance.
+         * Pass a `NewFrameConfig` object to provide settings for the new `Frame` instance.
+         */
         newFrame?: NewFrameConfig | boolean;
 
+        /**
+         * Loading strategy for the Workspace.
+         */
         loadingStrategy?: LoadingStrategy;
 
-        /** Used for replacing the specified workspace instead of creating a new one */
+        /**
+         * ID of an existing Workspace that will be replaced by the restored Workspace.
+         */
         reuseWorkspaceId?: string;
 
-        /** Opens the workspace without a workspace tab element */
+        /**
+         * If `true`, the Workspace will be opened without a Workspace tab.
+         */
         noTabHeader?: boolean;
 
         /**
-         * Controls whether the workspace will be opened in a pinned or in a normal state
+         * If `true`, the Workspace will be opened in a pinned state.
          */
         isPinned?: boolean;
 
         /**
-         * Sets the icon related for the workspace. The icon will be used for example for pinned workspaces.
+         * Icon for the Workspace. The icon will represent the Workspace tab when the Workspace is pinned.
          */
         icon?: string;
 
         /**
-         * Controls whether the workspace will be focused or not in the frame when opened
+         * If `true`, the Workspace will be selected (on focus) in the `Frame` instance when opened.
          */
         isSelected?: boolean;
 
         /**
-         * Specifies the position of the Workspace within the `Frame` instance.
-         * This index is ignored by the `init()` method for initializing an empty `Frame`.
+         * Position for the Workspace within the `Frame` instance.
+         * This index will be ignored by the `init()` method when initializing an empty `Frame` instance.
          */
         positionIndex?: number;
 
         /**
-         * If `true`, the Workspaces Frame instance containing the restored Workspace will be activated.
-         * This means that the Workspaces Frame window will gain focus, will be restored to its normal state (e.g., if it has been previously minimized),
+         * If `true`, the `Frame` instance containing the restored Workspace will be activated.
+         * This means that the window of the `Frame` instance will gain focus, will be restored to its normal state (e.g., if it has been previously minimized),
          * and will be brought in front of other existing windows.
          * Defaults to the configuration passed in the `workspaces.json` file or to `false`.
          * *Available only in **io.Connect Desktop**.*
+         * @since io.Connect Desktop 9.4
+         * @since @interopio/workspaces-api 3.3.2
          */
         activateFrame?: boolean;
 
@@ -188,17 +292,27 @@ export namespace IOConnectWorkspaces {
         allowSystemHibernation?: boolean;
     }
 
+    /**
+     * Options for restoring a Workspace from a Workspace Layout by the unique ID of the Layout.
+     * *Available only in **io.Connect Desktop**.*
+     * @since io.Connect Desktop 10.5
+     * @since @interopio/workspaces-api 5.0.0
+     */
     export interface RestoreWorkspaceByIdConfig extends RestoreWorkspaceConfig {
+        /**
+         * Unique ID of the Workspace Layout to restore.
+         * The Workspace Layout with the specified ID must exist, otherwise the operation will fail.
+         */
         layoutId: string;
     }
 
     /**
-     * Settings for showing a previously hidden Workspaces Frame instance.
+     * Settings for showing a previously hidden `Frame` instance.
      */
     export interface FrameShowConfig {
 
         /**
-         * If `true`, the Workspaces Frame instance will be activated. This means that the Workspaces Frame window will gain focus,
+         * If `true`, the `Frame` instance will be activated. This means that the window of the `Frame` instance will gain focus,
          * will be restored to its normal state (e.g., if it has been previously minimized), and will be brought in front of other existing windows.
          * @default false
          */
@@ -206,7 +320,7 @@ export namespace IOConnectWorkspaces {
     }
 
     /**
-     * Describes the size of an io.Connect window.
+     * Describes the size of an io.Connect Window.
      */
     export interface Size {
 
@@ -238,14 +352,18 @@ export namespace IOConnectWorkspaces {
     }
 
     /**
-     * Describes the bounds of a Frame instance.
+     * Describes the bounds of a `Frame` instance.
      */
     export type FrameBounds = Bounds;
 
-    /** An object describing the possible settings when defining a new frame. */
+    /**
+     * Settings for a new `Frame` instance.
+     */
     export interface NewFrameConfig {
 
-        /** An object describing the possible settings when defining a new frame. */
+        /**
+         * Bounds for the new `Frame` instance.
+         */
         bounds?: {
             top?: number;
             left?: number;
@@ -254,61 +372,91 @@ export namespace IOConnectWorkspaces {
         };
 
         /**
-         * If `true`, the newly created Workspaces Frame instance will be visible.
+         * If `true`, the newly created `Frame` instance will be visible.
          * *Available only in **io.Connect Desktop**.*
          * @since io.Connect Desktop 9.10
+         * @since @interopio/workspaces-api 4.1.1
          * @default true
          */
         isVisible?: boolean;
 
-        /** A string which will be used as an id of the new frame. The call will reject if a frame with id already exists */
+        /**
+         * ID for the new `Frame` instance. The operation will be rejected if a `Frame` instance with the same ID already exists.
+         */
         frameId?: string;
     }
 
-    /** An object defining the resize parameters of a frame. */
+    /**
+     * Options for resizing a `Frame` instance.
+     */
     export interface ResizeConfig {
-        /** The targeted width value */
+        /**
+         * Width in pixels for the `Frame` instance.
+         */
         width?: number;
 
-        /** The targeted height value */
+        /**
+         * Height in pixels for the `Frame` instance.
+         */
         height?: number;
 
-        /** Toggles whether or not the provided width and height values should be treated as absolute or relative to the current values. */
+        /**
+         * If `true`, the provided width and height values will be treated as relative to the current ones instead of as absolute values.
+         */
         relative?: boolean;
     }
 
-    /** An object defining the position parameters of a frame. */
+    /**
+     * Options for moving a `Frame` instance.
+     */
     export interface MoveConfig {
-        /** The targeted top value */
+        /**
+         * Distance in pixels of the top left corner of the `Frame` instance from the top edge of the screen.
+         */
         top?: number;
 
-        /** The targeted left value */
+        /**
+         * Distance in pixels of the top left corner of the `Frame` instance from the left edge of the screen.
+         */
         left?: number;
 
-        /** Toggles whether or not the provided top and left values should be treated as absolute or relative to the current values. */
+        /**
+         * If `true`, the provided top and left values will be treated as relative to the current ones instead of as absolute values.
+         */
         relative?: boolean;
     }
 
     /**
-     * Options for closing a Frame.
-     * *Available only in **io.Connect Desktop**.*
+     * Options for closing a `Frame` instance.
      * @since io.Connect Desktop 9.9
+     * @since io.Connect Browser 5.0
+     * @since @interopio/workspaces-api 3.5.7
      */
-    export interface FrameCloseOptions {
+    export interface FrameCloseOptions extends CloseOptions { }
+
+    /**
+     * Options for closing a `Frame` instance.
+     * @since @interopio/workspaces-api 5.1
+     */
+    export interface CloseOptions {
         /**
-         * If `true`, will allow preventing the operation for closing the Frame.
+         * If `true`, will allow preventing the operation for closing the `Frame` instance.
          */
         allowPrevent?: boolean;
 
         /**
-         * If `true`, will show a dialog for the user to confirm or cancel closing the Frame.
+         * If `true`, will show a dialog for the user to confirm or cancel closing the `Frame` instance.
          */
         showDialog?: boolean;
     }
 
-    /** An object containing settings applied when creating a new workspace. */
+    /**
+     * Settings for creating a Workspace.
+     */
     export interface WorkspaceCreateConfig {
-        /** A boolean which defines whether or not the workspace should also be saved as a layout when created. */
+        /**
+         * If `true`, the Workspace will also be saved as a Workspace Layout when created.
+         */
         saveLayout?: boolean;
     }
 
@@ -320,164 +468,191 @@ export namespace IOConnectWorkspaces {
      */
     export type LoadingStrategy = "direct" | "delayed" | "lazy";
 
-    /** An object which represent a workspace element. This is an element can be a box or a workspace window. */
+    /**
+     * Workspace element. Can be a box element or a Workspace window.
+     */
     export type WorkspaceElement = WorkspaceBox | WorkspaceWindow;
 
-    /** An object which represent a workspace box. This is an element which contains other elements, called children. */
+    /**
+     * Box element in a Workspace - a row, a column, or a window group. Box elements can contain other Workspace elements.
+     */
     export type WorkspaceBox = Row | Column | Group;
 
-    /** The possible window states for a workspaces frame. */
+    /**
+     * Window state of a `Frame` instance.
+     */
     export type FrameState = "maximized" | "minimized" | "normal";
 
-    /** The possible types of window dragging inside a workspaces frame */
+    /**
+     * Mode for dragging the windows in a Workspace.
+     */
     export type WindowDragMode = "keepInside" | "autoEject";
 
-    /** An object describing the options of the builder. */
+    /**
+     * Options for creating a builder.
+     */
     export interface BuilderConfig {
-        /** A string defining the type of the builder. */
+        /**
+         * Type of the builder.
+         */
         type: "workspace" | "row" | "column" | "group";
 
-        /** An object describing various options when creating a builder. */
+        /**
+         * Definition for the Workspace or the box element that will be built.
+         */
         definition?: WorkspaceDefinition | BoxDefinition;
     }
 
-    /** Workspace-specific options. */
+    /**
+     * Settings for a Workspace.
+     */
     export interface WorkspaceConfig {
-        /** A title of the workspace. */
+        /**
+         * Title for the Workspace.
+         */
         title?: string;
 
-        /** Position of the workspace in relation to it's siblings in the frame. */
+        /**
+         * Position for the Workspace relative to the other Workspaces in the `Frame` instance.
+         */
         position?: number;
 
         /**
-         * Provides the opportunity to open a workspace with no tab header
+         * If `true`, the Workspace will be opened without a Workspace tab.
          * @default false
          */
         noTabHeader?: boolean;
 
-        /** Used for replacing the specified workspace instead of creating a new one */
+        /**
+         * ID of an existing Workspace that will be replaced by the new Workspace.
+         */
         reuseWorkspaceId?: string;
 
-        /** Controls when the windows inside this workspace should load when the workspace is created or restored */
+        /**
+         * Loading strategy for the windows in the Workspace when the Workspace is created or restored.
+         */
         loadStrategy?: LoadingStrategy;
 
         /**
-         * Controls the users ability to drop outside windows in the workspace
+         * If `true`, will allow the user to add windows by dropping them in the Workspace.
+         * *Available only in **io.Connect Desktop**.*
          * @default true
          */
         allowDrop?: boolean;
 
         /**
-         * Controls the users ability to drop windows in the left-most zone of the workspace
+         * If `true`, will allow the user to add windows by dropping them in the leftmost area of the Workspace.
          * @default true
          */
         allowDropLeft?: boolean;
 
         /**
-         * Controls the users ability to drop windows in the top-most zone of the workspace
+         * If `true`, will allow the user to add windows by dropping them in the topmost area of the Workspace.
          * @default true
          */
         allowDropTop?: boolean;
 
         /**
-         * Controls the users ability to drop windows in the right-most zone of the workspace
+         * If `true`, will allow the user to add windows by dropping them in the rightmost area of the Workspace.
          * @default true
          */
         allowDropRight?: boolean;
 
         /**
-         * Controls the users ability to drop windows in the bottom-most zone of the workspace
+         * If `true`, will allow the user to add windows by dropping them in the bottommost area of the Workspace.
          * @default true
          */
         allowDropBottom?: boolean;
 
         /**
-         * Controls the users ability to extract windows from the workspace
+         * If `true`, will allow the user to extract windows from the Workspace.
          * @default true
          */
         allowExtract?: boolean;
 
         /**
-         * Control the users ability to reorder windows in the workspace
+         * If `true`, will allow the user to reorder windows in the Workspace.
          * @default true
          */
         allowWindowReorder?: boolean;
 
         /**
-         * Controls the visibility of the save workspace button located in the workspace tab
+         * If `true`, will show the "Rename", "Save", and "Save As" options in the Workspace tab menu.
          * @default true
          */
         showSaveButton?: boolean;
 
         /**
-         * Controls whether a workspace tab can be reordered in the frame
+         * If `true`, will allow the user to reorder the Workspace tab in the Workspaces App.
          * @default true
          */
         allowWorkspaceTabReorder?: boolean;
 
         /**
-         * Controls whether a workspace tab can be extracted from the frame.
+         * If `true`, will allow the user to extract the Workspace tab from the Workspaces App.
          * *Available only in **io.Connect Desktop**.*
          * @default true
          */
         allowWorkspaceTabExtract?: boolean;
 
         /**
-         * Controls the visibility of the close button located in the workspaces tab
+         * If `true`, will show the "Close" button in the Workspace tab.
          * @default true
          */
         showCloseButton?: boolean;
 
         /**
-         * Prevents the splitters for being draggable, so the windows cannot be resized
+         * If `true`, will allow the user to resize the Workspace elements by dragging the splitters.
          * @default true
          */
         allowSplitters?: boolean;
 
         /**
-         * Controls the visibility of all close button located in the windows' tab elements
+         * If `true`, will show the "Close" buttons in the window tabs.
          * @default true
          */
         showWindowCloseButtons?: boolean;
 
         /**
-         * Controls the visibility of all eject buttons located in the groups' headers
+         * If `true`, will show the "Eject" buttons in the headers of the window groups.
          * @default true
          */
         showEjectButtons?: boolean;
 
         /**
-         * Controls the visibility of all the add window buttons (the ones with the plus icon) located in the group headers
+         * If `true`, will show the "Add Window" buttons (the "+" buttons) in the headers of the window groups.
          * @default true
          */
         showAddWindowButtons?: boolean;
 
         /**
-         * Controls whether the workspace will be opened in a pinned or in a normal state
+         * If `true`, the Workspace will be opened in a pinned state.
          * @default false
          */
         isPinned?: boolean;
 
         /**
-         * Sets the icon related for the workspace. The icon will be used for example for pinned workspaces.
+         * Icon for the Workspace. The icon will represent the Workspace tab when the Workspace is pinned.
          */
         icon?: string;
 
         /**
-         * Controls whether the workspace will be focused or not in the frame when opened
+         * If `true`, the Workspace will be selected (on focus) in the `Frame` instance when opened.
          * @default true
          */
         isSelected?: boolean;
 
         /**
-         * Specifies the position of the Workspace within the `Frame` instance.
-         * This index is ignored by the `init()` method for initializing an empty `Frame`.
+         * Position for the Workspace within the `Frame` instance.
+         * This index will be ignored by the `init()` method when initializing an empty `Frame` instance.
          */
         positionIndex?: number;
 
         /**
          * Mode for dragging the windows that are part of the Workspace. If set to `"autoEject"` (available only in **io.Connect Desktop**), when the user drags a Workspace window, it will be ejected from the Workspace during the dragging operation and the user will be able to drop it back inside the Workspace, or out of the Workspace.
          * If set to `"keepInside"`, the window won't be ejected from the Workspace when being dragged and the user will be able to drop it only inside the Workspace.
+         * @since io.Connect Desktop 9.5
+         * @since @interopio/workspaces-api 3.5.2
          */
         windowDragMode?: "keepInside" | "autoEject";
 
@@ -488,71 +663,149 @@ export namespace IOConnectWorkspaces {
          */
         allowSystemHibernation?: boolean;
 
+        /**
+         * Restrictions for dropping apps in the Workspace and allowing apps to appear in the "Add Apps" popup menu of the Workspace.
+         * @since io.Connect Desktop 10.5
+         * @since io.Connect Browser 4.6
+         * @since @interopio/workspaces-api 5.0.0
+         */
         appRestrictions?: AppRestrictions | undefined;
     }
 
+    /**
+     * Describes the default restrictions for dropping apps in a Workspace and allowing apps to appear in the "Add Apps" popup menu of a Workspace.
+     * @since io.Connect Desktop 10.5
+     * @since io.Connect Browser 4.6
+     * @since @interopio/workspaces-api 5.0.0
+     */
     export interface AppRestrictionRule {
+
+        /**
+         * If `true`, will allow an app to appear in the "Add Apps" popup menu of a Workspace.
+         */
         allowInApplicationPopup?: boolean;
+
+        /**
+         * If `true`, will allow an app to be dropped in a Workspace.
+         * *Available only in **io.Connect Desktop**.*
+         */
         allowDrop?: boolean;
     }
 
+    /**
+     * Describes the restrictions for dropping a specific app in a Workspace and allowing it to appear in the "Add Apps" popup menu of a Workspace.
+     * @since io.Connect Desktop 10.5
+     * @since io.Connect Browser 4.6
+     * @since @interopio/workspaces-api 5.0.0
+     */
     export interface AppRestrictionEntry extends AppRestrictionRule {
+
+        /**
+         * Name of the app, as defined within the io.Connect framework, for which to apply the specified restrictions.
+         */
         appName: string;
     }
 
+    /**
+     * Describes the restrictions for dropping apps in a Workspace and allowing apps to appear in the "Add Apps" popup menu of a Workspace.
+     * @since io.Connect Desktop 10.5
+     * @since io.Connect Browser 4.6
+     * @since @interopio/workspaces-api 5.0.0
+     */
     export interface AppRestrictions {
+
+        /**
+         * Array of objects, each describing the restrictions for a specific app.
+         * The restrictions specified here will override the default restrictions specified via the `default` property.
+         */
         apps?: AppRestrictionEntry[];
+
+        /**
+         * Default restrictions that will be applied to all apps.
+         * The restrictions specified here can be overridden per app via the `apps` array.
+         */
         default?: AppRestrictionRule;
     }
 
-    /** A config object which provides fine grain control when locking a workspace */
+    /**
+     * Lock settings for a Workspace.
+     */
     export interface WorkspaceLockConfig {
-        /** Prevents the splitters for being draggable, so the windows cannot be resized */
+        /**
+         * If `true`, will allow the user to resize the Workspace elements by dragging the splitters.
+         */
         allowSplitters?: boolean;
 
-        /** (Enterprise only) Controls the ability of the users to drop outside windows in the workspace */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the Workspace.
+         * *Available only in **io.Connect Desktop**.*
+         */
         allowDrop?: boolean;
 
-        /** Controls the users ability to drop windows in left-most zone of the workspace */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the leftmost area of the Workspace.
+         */
         allowDropLeft?: boolean;
 
-        /** Controls the users ability to drop windows in top-most zone of the workspace */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the topmost area of the Workspace.
+         */
         allowDropTop?: boolean;
 
-        /** Controls the users ability to drop windows in right-most zone of the workspace */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the rightmost area of the Workspace.
+         */
         allowDropRight?: boolean;
 
-        /** Controls the users ability to drop windows in bottom-most zone of the workspace */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the bottommost area of the Workspace.
+         */
         allowDropBottom?: boolean;
 
-        /** Controls the ability of the users to extract (or rearrange) windows inside the workspace */
+        /**
+         * If `true`, will allow the user to extract (or rearrange) windows inside the Workspace.
+         */
         allowExtract?: boolean;
 
-        /** Control the users ability to reorder windows in the workspace */
+        /**
+         * If `true`, will allow the user to reorder windows in the Workspace.
+         */
         allowWindowReorder?: boolean;
 
-        /** Controls the visibility of the close button located in the workspaces tab */
+        /**
+         * If `true`, will show the "Close" button in the Workspace tab.
+         */
         showCloseButton?: boolean;
 
-        /** Controls the visibility of the save workspace button located in the workspace tab */
+        /**
+         * If `true`, will show the "Rename", "Save", and "Save As" options in the Workspace tab menu.
+         */
         showSaveButton?: boolean;
 
-        /** Controls the whether the workspace tab can be reordered */
+        /**
+         * If `true`, will allow the user to reorder the Workspace tab in the Workspaces App.
+         */
         allowWorkspaceTabReorder?: boolean;
 
         /**
-         * Controls the whether the workspace tab can be extracted.
+         * If `true`, will allow the user to extract the Workspace tab from the Workspaces App.
          * *Available only in **io.Connect Desktop**.*
          */
         allowWorkspaceTabExtract?: boolean;
 
-        /** Controls the visibility of all the add window buttons (the ones with the plus icon) located in the group headers */
+        /**
+         * If `true`, will show the "Add Window" buttons (the "+" buttons) in the headers of the window groups.
+         */
         showAddWindowButtons?: boolean;
 
-        /** Controls the visibility of all eject buttons located in the groups' headers */
+        /**
+         * If `true`, will show the "Eject" buttons in the headers of the window groups.
+         */
         showEjectButtons?: boolean;
 
-        /** Controls the visibility of all close button located in the windows' tab elements */
+        /**
+         * If `true`, will show the "Close" buttons in the window tabs.
+         */
         showWindowCloseButtons?: boolean;
 
         /**
@@ -562,211 +815,395 @@ export namespace IOConnectWorkspaces {
         allowSystemHibernation?: boolean;
     }
 
-    /** A config object which provides fine grain control when locking a window */
+    /**
+     * Lock settings for a Workspace window.
+     */
     export interface WorkspaceWindowLockConfig {
-        /**  Blocks the users ability to extract the specified window */
+        /**
+         * If `true`, will allow the user to extract the window from the Workspace.
+         */
         allowExtract?: boolean;
 
-        /** Blocks the users ability to reorder the specified window */
+        /**
+         * If `true`, will allow the user to reorder the window in the window group.
+         */
         allowReorder?: boolean;
 
-        /** Controls the visibility of the close button which is located in the window's tab */
+        /**
+         * If `true`, will show the "Close" button in the window tab.
+         */
         showCloseButton?: boolean;
     }
 
-    /** A config object which provides fine grain control when locking a group */
+    /**
+     * Lock settings for a window group.
+     */
     export interface GroupLockConfig {
-        /**  Blocks the users ability to extract windows from the group */
+        /**
+         * If `true`, will allow the user to extract windows from the window group.
+         */
         allowExtract?: boolean;
 
-        /** Blocks the ussers ability to reorder windows from the group */
+        /**
+         * If `true`, will allow the user to reorder the windows in the window group.
+         */
         allowReorder?: boolean;
 
-        /** (Enterprise only) Controls the ability of the users to drop outside windows in the group */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the window group.
+         * *Available only in **io.Connect Desktop**.*
+         */
         allowDrop?: boolean;
 
-        /** Controls the users ability to drop windows in left zone of the group */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the leftmost area of the window group.
+         */
         allowDropLeft?: boolean;
 
-        /** Controls the users ability to drop windows in right zone of the group */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the rightmost area of the window group.
+         */
         allowDropRight?: boolean;
 
-        /** Controls the users ability to drop windows in top zone of the group */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the topmost area of the window group.
+         */
         allowDropTop?: boolean;
 
-        /** Controls the users ability to drop windows in bottom zone of the group */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the bottommost area of the window group.
+         */
         allowDropBottom?: boolean;
 
-        /** Controls the users ability to drop windows in header zone of the group */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the header area of the window group.
+         */
         allowDropHeader?: boolean;
 
-        /** Controls the visibility of the maximize/restore button located in the group header */
+        /**
+         * If `true`, will show the "Maximize" button in the header of the window group.
+         */
         showMaximizeButton?: boolean;
 
-        /** Controls the visibility of the eject button located in the group header */
+        /**
+         * If `true`, will show the "Eject" button in the header of the window group.
+         */
         showEjectButton?: boolean;
 
-        /** Controls the visibility of the add window buttons (the ones with the plus icon) located in the group header */
+        /**
+         * If `true`, will show the "Add Window" button (the "+" button) in the header of the window group.
+         */
         showAddWindowButton?: boolean;
     }
 
-    /** A config object which provides fine grain control when locking a row */
+    /**
+     * Lock settings for a Workspace row.
+     */
     export interface RowLockConfig {
-        /** (Enterprise only) Controls the ability of the users to drop outside windows in the row */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the Workspace row.
+         * *Available only in **io.Connect Desktop**.*
+         */
         allowDrop?: boolean;
 
-        /** Prevents the splitters for being draggable, so the windows cannot be resized within the row */
+        /**
+         * If `true`, will allow the user to resize the Workspace row by dragging the splitters.
+         */
         allowSplitters?: boolean;
     }
 
-    /** A config object which provides fine grain control when locking a column */
+    /**
+     * Lock settings for a Workspace column.
+     */
     export interface ColumnLockConfig {
-        /** (Enterprise only) Controls the ability of the users to drop outside windows in the column */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the Workspace column.
+         * *Available only in **io.Connect Desktop**.*
+         */
         allowDrop?: boolean;
 
-        /** Prevents the splitters for being draggable, so the windows cannot be resized within the row */
+        /**
+         * If `true`, will allow the user to resize the Workspace column by dragging the splitters.
+         */
         allowSplitters?: boolean;
     }
 
-    /** A config object which defines various workspace window-specific settings */
+    /**
+     * Settings for a Workspace window.
+     */
     export interface WorkspaceWindowDefinitionConfig {
-        /** Specifies the minimum width in pixels for the workspace window */
+        /**
+         * Minimum width in pixels for the Workspace window.
+         */
         minWidth?: number;
 
-        /** Specifies the maximum width in pixels for the workspace window */
+        /**
+         * Maximum width in pixels for the Workspace window.
+         */
         maxWidth?: number;
 
-        /** Specifies the minimum height in pixels for the workspace window */
+        /**
+         * Minimum height in pixels for the Workspace window.
+         */
         minHeight?: number;
 
-        /** Specifies the maximum height in pixels for the workspace window */
+        /**
+         * Maximum height in pixels for the Workspace window.
+         */
         maxHeight?: number;
 
-        /**  Blocks the users ability to extract the specified window */
+        /**
+         * If `true`, will allow the user to extract the window from the Workspace.
+         */
         allowExtract?: boolean;
 
-        /** Blocks the users ability to reorder the specified window */
+        /**
+         * If `true`, will allow the user to reorder the window in the window group.
+         */
         allowReorder?: boolean;
 
-        /** Controls the visibility of the close button which is located in the window's tab */
+        /**
+         * If `true`, will show the "Close" button in the window tab.
+         */
         showCloseButton?: boolean;
+
+        /**
+         * Zero-based position at which the window will be inserted among the children of the element to which it's added.
+         * When the window is added to a group, this is the position of its tab within the group.
+         * When the window is added to a Workspace, the position is among the children of the box in which the window is placed.
+         * Applies only to the window passed to an `addWindow()` method. Ignored for windows defined in a `children` array, whose position is determined by their order in the array.
+         * If the position is greater than the number of children, the window will be added as the last child.
+         * @since io.Connect Desktop 10.6
+         * @since io.Connect Browser 5.0
+         * @since @interopio/workspaces-api 5.1
+         */
+        positionIndex?: number;
     }
 
-    /** A config object which defines various group-specific settings */
+    /**
+     * Settings for a window group.
+     */
     export interface GroupDefinitionConfig {
-        /** Specifies the minimum width in pixels for the group */
+        /**
+         * Minimum width in pixels for the window group.
+         */
         minWidth?: number;
 
-        /** Specifies the maximum width in pixels for the group */
+        /**
+         * Maximum width in pixels for the window group.
+         */
         maxWidth?: number;
 
-        /** Specifies the minimum height in pixels for the group */
+        /**
+         * Minimum height in pixels for the window group.
+         */
         minHeight?: number;
 
-        /** Specifies the maximum height in pixels for the group */
+        /**
+         * Maximum height in pixels for the window group.
+         */
         maxHeight?: number;
 
-        /**  Blocks the users ability to extract windows from the group */
+        /**
+         * If `true`, will allow the user to extract windows from the window group.
+         */
         allowExtract?: boolean;
 
-        /**  Blocks the users ability to reorder windows from the group */
+        /**
+         * If `true`, will allow the user to reorder the windows in the window group.
+         */
         allowReorder?: boolean;
 
-        /** Controls the visibility of the maximize/restore button located in the group header */
+        /**
+         * If `true`, will show the "Maximize" button in the header of the window group.
+         */
         showMaximizeButton?: boolean;
 
-        /** Controls the visibility of the eject button located in the group header */
+        /**
+         * If `true`, will show the "Eject" button in the header of the window group.
+         */
         showEjectButton?: boolean;
 
-        /** (Enterprise only) Controls the ability of the users to drop outside windows in the group */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the window group.
+         * *Available only in **io.Connect Desktop**.*
+         */
         allowDrop?: boolean;
 
-        /** Controls the users ability to drop windows in left zone of the group */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the leftmost area of the window group.
+         */
         allowDropLeft?: boolean;
 
-        /** Controls the users ability to drop windows in right zone of the group */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the rightmost area of the window group.
+         */
         allowDropRight?: boolean;
 
-        /** Controls the users ability to drop windows in top zone of the group */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the topmost area of the window group.
+         */
         allowDropTop?: boolean;
 
-        /** Controls the users ability to drop windows in bottom zone of the group */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the bottommost area of the window group.
+         */
         allowDropBottom?: boolean;
 
-        /** Controls the users ability to drop windows in header zone of the group */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the header area of the window group.
+         */
         allowDropHeader?: boolean;
 
-        /** Controls the visibility of the add window buttons (the ones with the plus icon) located in the group header */
+        /**
+         * If `true`, will show the "Add Window" button (the "+" button) in the header of the window group.
+         */
         showAddWindowButton?: boolean;
+
+        /**
+         * Zero-based position at which the group will be inserted among the children of the element to which it's added.
+         * When the group is added to a Workspace, the position is among the children of the box in which the group is placed.
+         * Applies only to the group passed to an `addGroup()` method. Ignored for groups defined in a `children` array, whose position is determined by their order in the array.
+         * If the position is greater than the number of children, the group will be added as the last child.
+         * @since io.Connect Desktop 10.6
+         * @since io.Connect Browser 5.0
+         * @since @interopio/workspaces-api 5.1
+         */
+        positionIndex?: number;
     }
 
-    /** A config object which defines various row-specific settings */
+    /**
+     * Settings for a Workspace row.
+     */
     export interface RowDefinitionConfig {
-        /** Specifies the minimum height in pixels for the row */
+        /**
+         * Minimum height in pixels for the row.
+         */
         minHeight?: number;
 
-        /** Specifies the maximum height in pixels for the row */
+        /**
+         * Maximum height in pixels for the row.
+         */
         maxHeight?: number;
 
-        /** (Enterprise only) Controls the ability of the users to drop outside windows in the row */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the row.
+         * *Available only in **io.Connect Desktop**.*
+         */
         allowDrop?: boolean;
 
-        /** Prevents the splitters for being draggable, so the windows cannot be resized within the row */
+        /**
+         * If `true`, will allow the user to resize the row by dragging the splitters.
+         */
         allowSplitters?: boolean;
 
-        /** Specifies if a row should be pinned. A pinned row will always maintain it's height, unless the user manually changes it by dragging the splitter */
+        /**
+         * If `true`, the row will be pinned. A pinned row will always maintain its height, unless the user changes it manually by dragging the splitter.
+         */
         isPinned?: boolean;
 
-        /** If set to true any child that is maximized will have its width and height constricted to the current element's size */
+        /**
+         * If `true`, the width and height of any maximized child element will be constrained to the current size of the row.
+         */
         maximizationBoundary?: boolean;
+
+        /**
+         * Zero-based position at which the row will be inserted among the children of the element to which it's added.
+         * When the row is added to a Workspace, the position is among the children of the box in which the row is placed.
+         * Applies only to the row passed to an `addRow()` method. Ignored for rows defined in a `children` array, whose position is determined by their order in the array.
+         * If the position is greater than the number of children, the row will be added as the last child.
+         * @since io.Connect Desktop 10.6
+         * @since io.Connect Browser 5.0
+         * @since @interopio/workspaces-api 5.1
+         */
+        positionIndex?: number;
     }
 
-    /** A config object which defines various column-specific settings */
+    /**
+     * Settings for a Workspace column.
+     */
     export interface ColumnDefinitionConfig {
-        /** Specifies the minimum width in pixels for the column */
+        /**
+         * Minimum width in pixels for the column.
+         */
         minWidth?: number;
 
-        /** Specifies the maximum width in pixels for the column */
+        /**
+         * Maximum width in pixels for the column.
+         */
         maxWidth?: number;
 
-        /** (Enterprise only) Controls the ability of the users to drop outside windows in the column */
+        /**
+         * If `true`, will allow the user to add windows by dropping them in the column.
+         * *Available only in **io.Connect Desktop**.*
+         */
         allowDrop?: boolean;
 
-        /** Prevents the splitters for being draggable, so the windows cannot be resized within the column */
+        /**
+         * If `true`, will allow the user to resize the column by dragging the splitters.
+         */
         allowSplitters?: boolean;
 
-        /** Specifies if a column should be pinned. A pinned column will always maintain it's width, unless the user manually changes it by dragging the splitter */
+        /**
+         * If `true`, the column will be pinned. A pinned column will always maintain its width, unless the user changes it manually by dragging the splitter.
+         */
         isPinned?: boolean;
 
-        /** If set to true any child that is maximized will have its width and height constricted to the current element's size */
+        /**
+         * If `true`, the width and height of any maximized child element will be constrained to the current size of the column.
+         */
         maximizationBoundary?: boolean;
+
+        /**
+         * Zero-based position at which the column will be inserted among the children of the element to which it's added.
+         * When the column is added to a Workspace, the position is among the children of the box in which the column is placed.
+         * Applies only to the column passed to an `addColumn()` method. Ignored for columns defined in a `children` array, whose position is determined by their order in the array.
+         * If the position is greater than the number of children, the column will be added as the last child.
+         * @since io.Connect Desktop 10.6
+         * @since io.Connect Browser 5.0
+         * @since @interopio/workspaces-api 5.1
+         */
+        positionIndex?: number;
     }
 
+    /**
+     * Options for targeting the `Frame` instance that will host a Workspace.
+     */
     export interface FrameTargetingOptions {
         /**
-         * If `true`, the targeted Workspaces Frame instance will be activated. This means that the Workspaces Frame window will gain focus,
+         * If `true`, the targeted `Frame` instance will be activated. This means that the window of the `Frame` instance will gain focus,
          * will be restored to its normal state (e.g., if it has been previously minimized), and will be brought in front of other existing windows.
          * Defaults to the configuration passed in the `workspaces.json` file or to `false`.
          * *Available only in **io.Connect Desktop**.*
+         * @since io.Connect Desktop 9.4
+         * @since @interopio/workspaces-api 3.3.2
          */
         activate?: boolean;
 
-        /** A string id of an existing frame. If provided, this workspace will be opened in that specific frame */
+        /**
+         * ID of an existing `Frame` instance. If provided, the Workspace will be opened in that `Frame` instance.
+         */
         reuseFrameId?: string;
 
         /**
-         * The application name of the workspace app that should be used for the new frame.
+         * Name of the Workspaces App that will be used for creating the new `Frame` instance.
          * *Available only in **io.Connect Desktop**.*
          */
         applicationName?: string;
 
-        /** A setting used to declare that the workspace must be in a new frame and also provide options for that new frame */
+        /**
+         * If `true`, the Workspace will be opened in a new `Frame` instance.
+         * Pass a `NewFrameConfig` object to provide settings for the new `Frame` instance.
+         */
         newFrame?: NewFrameConfig | boolean;
     }
 
+    /**
+     * Options for pinning a Workspace.
+     */
     export interface WorkspacePinOptions {
         /**
-         * Icon which will be used for the pinned workspace.
+         * Icon for the pinned Workspace.
          */
         icon?: string;
     }
@@ -798,141 +1235,212 @@ export namespace IOConnectWorkspaces {
         frame?: FrameTargetingOptions;
     }
 
+    /**
+     * Describes a Workspace to be restored from a Workspace Layout by the unique ID of the Layout.
+     * *Available only in **io.Connect Desktop**.*
+     * @since io.Connect Desktop 10.5
+     * @since @interopio/workspaces-api 5.0.0
+     */
     export interface RestoreWorkspaceByIdDefinition {
         /**
-        * The id of a saved workspace layout, which will be restored.
-        */
+         * Unique ID of the Workspace Layout to restore.
+         * The Workspace Layout with the specified ID must exist, otherwise the operation will fail.
+         */
         id: string;
 
         /**
-        * An optional object containing various workspace restore options.
-        */
+         * Options for restoring the Workspace.
+         */
         restoreOptions?: RestoreWorkspaceConfig;
     }
 
-    /** An object describing the possible options when restoring a workspace */
+    /**
+     * Describes a Workspace to be restored from a Workspace Layout.
+     */
     export interface RestoreWorkspaceDefinition {
         /**
-         * The name of a saved workspace layout, which will be restored.
+         * Name of the Workspace Layout to restore.
          */
         name: string;
+
         /**
-         * An optional object containing various workspace restore options.
+         * Options for restoring the Workspace.
          */
         restoreOptions?: RestoreWorkspaceConfig;
     }
 
-    /** An object describing the possible options when opening a box inside a workspace. */
+    /**
+     * Describes a box element to be created in a Workspace.
+     */
     export interface BoxDefinition {
-        /** The type of the workspace element. */
+        /**
+         * Type of the box element.
+         */
         type?: "column" | "row" | "group";
 
-        /** An array of all the box's children which will also be opened. */
+        /**
+         * Array of objects describing the Workspace windows and box elements that the box element will contain.
+         */
         children?: Array<WorkspaceWindowDefinition | BoxDefinition>;
 
-        /** An optional config object which defines various box-specific settings */
+        /**
+         * Settings for the box element.
+         */
         config?: GroupDefinitionConfig | RowDefinitionConfig | ColumnDefinitionConfig;
     }
 
-    /** An object describing the possible options when opening a window inside a workspace. */
+    /**
+     * Describes a window to be opened in a Workspace.
+     */
     export interface WorkspaceWindowDefinition {
-        /** The type of the workspace element. */
+        /**
+         * Type of the Workspace element.
+         */
         type?: "window";
 
-        /** The name of the application as defined, which will be opened. */
+        /**
+         * Name of the app to open, as defined within the io.Connect framework.
+         */
         appName?: string;
 
-        /** The window id of an existing standalone window, which will be dragged into the workspace. */
+        /**
+         * ID of an existing standalone window that will be added to the Workspace.
+         */
         windowId?: string;
 
-        /** An object which will be passed to the newly created window. This object is then accessible via the Windows API */
+        /**
+         * Context for the new window. The context will be accessible via the Window Management API.
+         */
         context?: any;
 
-        /** A config object which defines various workspace window-specific settings */
+        /**
+         * Settings for the Workspace window.
+         */
         config?: WorkspaceWindowDefinitionConfig;
     }
 
-    /** A config object which shows the possible frame size constraints, which are calculated using all internal elements' constraints */
+    /**
+     * Describes the size constraints of a `Frame` instance, calculated using the constraints of all elements in it.
+     */
     export interface FrameConstraints {
-        /** Shows the minimum width of the frame */
+        /**
+         * Minimum width in pixels of the `Frame` instance.
+         */
         minWidth: number;
 
-        /** Shows the maximum width of the frame */
+        /**
+         * Maximum width in pixels of the `Frame` instance.
+         */
         maxWidth: number;
 
-        /** Shows the minimum height of the frame */
+        /**
+         * Minimum height in pixels of the `Frame` instance.
+         */
         minHeight: number;
 
-        /** Shows the maximum height of the frame */
+        /**
+         * Maximum height in pixels of the `Frame` instance.
+         */
         maxHeight: number;
     }
 
-    /** A config object which defines how a workspace element should be resized */
+    /**
+     * Options for resizing a Workspace element.
+     */
     export interface ElementResizeConfig {
-        /** Defines the desired new width of the element */
+        /**
+         * Width in pixels for the element.
+         */
         width?: number;
 
-        /** Defines the desired new height of the element */
+        /**
+         * Height in pixels for the element.
+         */
         height?: number;
     }
 
-    /** An object describing a workspace layout without the underlying structure */
+    /**
+     * Describes a Workspace Layout without its underlying structure.
+     */
     export interface WorkspaceLayoutSummary {
+        /**
+         * Unique ID of the Workspace Layout.
+         * *Available only in **io.Connect Desktop**.*
+         * @since io.Connect Desktop 10.5
+         * @since @interopio/workspaces-api 5.0.0
+         */
         id?: string;
 
-        /** An unique string name and identifier of the layout */
+        /**
+         * Name of the Workspace Layout.
+         */
         name: string;
 
         /**
-         * The name of the workspaces app with which the layout is associated.
+         * Name of the Workspaces App with which the Workspace Layout is associated.
          * *Available only in **io.Connect Desktop**.*
          */
         applicationName?: string;
     }
 
+    /**
+     * Describes an empty `Frame` instance to be created.
+     */
     export interface EmptyFrameDefinition {
         /**
-         * The application name of the workspace app that should be used for the new frame.
+         * Name of the Workspaces App that will be used for creating the empty `Frame` instance.
          * *Available only in **io.Connect Desktop**.*
          */
         applicationName?: string;
 
         /**
-         * Optional frame related settings
+         * Settings for the empty `Frame` instance.
          */
         frameConfig?: IOConnectWorkspaces.NewFrameConfig;
 
         /**
-         * Optional context which will be passed to the initialization callback
+         * Context for the empty `Frame` instance. The context will be passed to the callback for handling the `onInitializationRequested()` event of the `Frame` instance.
          */
         context?: object;
 
         /**
-         * Optional the id of the layout component which is being restored
+         * ID of the Layout component that is being restored.
          */
         layoutComponentId?: string;
     }
 
+    /**
+     * Settings for initializing an empty `Frame` instance.
+     */
     export interface FrameInitializationConfig {
         /**
-         * Array of workspace definitions with which the frame should be opened
+         * Array of objects, each describing a Workspace to be created or restored in the `Frame` instance.
          */
         workspaces: Array<IOConnectWorkspaces.WorkspaceDefinition | RestoreWorkspaceDefinition | RestoreWorkspaceByIdDefinition>;
     }
 
+    /**
+     * Describes the context for initializing an empty `Frame` instance.
+     */
     export interface FrameInitializationContext {
         /**
-         * Context passed when the frame was created
+         * Context passed when creating the empty `Frame` instance.
          */
         context?: object;
     }
 
-    /** An object describing the basic details of a frame */
+    /**
+     * Describes the basic details of a `Frame` instance.
+     */
     export interface FrameSummary {
-        /** An unique string identifier of the frame */
+        /**
+         * Unique ID of the `Frame` instance.
+         */
         id: string;
 
-        /** Indicates whether the frame has been initialized or not */
+        /**
+         * Flag indicating whether the `Frame` instance has been initialized.
+         */
         isInitialized: boolean;
     }
 
@@ -983,19 +1491,20 @@ export namespace IOConnectWorkspaces {
          * If `true`, the popup window will gain focus when shown and will hide automatically when it loses focus. If `false`, the popup window won't be on focus when shown and won't hide automatically if it gains and loses focus afterwards. If you set this to `false`, you will be responsible for implementing the conditions and the mechanism for hiding/closing the popup window.
          * @default true
          * @since io.Connect Desktop 10.0
+         * @since @interopio/workspaces-api 4.1.4
          */
         focus?: boolean;
     }
     /**
-    * Type of the dialog to show. Can be either a predefined io.Connect dialog type, or a custom one.
-    *
-    * - `YesNo` - dialog with "Yes" and "No" buttons;
-    * - `YesNoCancel` - dialog with "Yes", "No" and "Cancel" buttons;
-    * - `OkCancel` - dialog with "OK" and "Cancel" buttons;
-    * - `Ok` - dialog with an "OK" button;
-    * - `Custom` - custom dialog;
-    * - `SingleInputDialog` - dialog with a text input field;
-    */
+     * Type of the dialog to show. Can be either a predefined io.Connect dialog type, or a custom one.
+     *
+     * - `YesNo` - dialog with "Yes" and "No" buttons;
+     * - `YesNoCancel` - dialog with "Yes", "No", and "Cancel" buttons;
+     * - `OkCancel` - dialog with "OK" and "Cancel" buttons;
+     * - `Ok` - dialog with an "OK" button;
+     * - `Custom` - custom dialog;
+     * - `SingleInputDialog` - dialog with a text input field;
+     */
     export const enum DialogType {
         YesNo = "YesNo",
         YesNoCancel = "YesNoCancel",
@@ -1008,7 +1517,7 @@ export namespace IOConnectWorkspaces {
     /**
      * Mode for the dialog.
      *
-     * - `WindowContainer` - only the container (e.g., the Workspaces Frame) of the window that is showing the dialog will be blocked for user interaction.
+     * - `WindowContainer` - only the container (e.g., a `Frame` instance) of the window that is showing the dialog will be blocked for user interaction.
      * - `Global` - all visible containers (including frameless io.Connect Windows) will be blocked. All windows within a blocked container will be blocked too.
      */
     export const enum DialogMode {
@@ -1027,7 +1536,7 @@ export namespace IOConnectWorkspaces {
     }
 
     /**
-     * Options for showing a dialog from the Workspaces Frame.
+     * Options for showing a dialog from a `Frame` instance.
      */
     export interface FrameDialogOptions {
 
@@ -1109,13 +1618,13 @@ export namespace IOConnectWorkspaces {
 
         /**
          * If `true`, the negative response button will be shown in the dialog.
-         * The default value is for custom dialogs, predefined dialog types have different defaults.
+         * The default value is for custom dialogs, as predefined dialog types have different defaults.
          * @default false
          */
         showNegativeButton?: boolean;
 
         /**
-         * Determines which dialog button to be the default one.
+         * Default button for the dialog.
          * The action tied to the default button will be executed when the user presses `ENTER` when no button is active
          * (i.e., when the buttons aren't on focus and none is selected).
          */
@@ -1138,13 +1647,13 @@ export namespace IOConnectWorkspaces {
         showTimer?: boolean;
 
         /**
-         * The amount of characters that can be entered in the input field of a `SingleInputDialog`.
+         * Maximum number of characters that can be entered in the input field of a `SingleInputDialog`.
          */
         inputMaxLength?: number;
 
         /**
          * String pattern that serves as a regular expression for validating the input from the user in a `SingleInputDialog`.
-         * If such pattern is specified and the input doesn't match it, an error will be displayed and the input field
+         * If such a pattern is specified and the input doesn't match it, an error will be displayed and the input field
          * will indicate visually that the user input is invalid.
          */
         inputPattern?: string;
@@ -1160,151 +1669,158 @@ export namespace IOConnectWorkspaces {
         inputPlaceholder?: string;
 
         /**
-        * If `true`, will blur the area around the dialog displayed by the `Frame` instance.
-        * This property is valid only in the advanced platform mode and only if the `"mode"` property of the `"transparencyControl"` object
-        * under the `"windowManagement"` top-level key in the system configuration of **io.Connect Desktop** is set to `"Transparent"`.
-        * *Available only in **io.Connect Desktop**.*
-        * @default false
-        * @since io.Connect Desktop 10.0.3
-        */
+         * If `true`, will blur the area around the dialog displayed by the `Frame` instance.
+         * This property is valid only in the advanced platform mode and only if the `"mode"` property of the `"transparencyControl"` object
+         * under the `"windowManagement"` top-level key in the system configuration of **io.Connect Desktop** is set to `"Transparent"`.
+         * *Available only in **io.Connect Desktop**.*
+         * @default false
+         * @since io.Connect Desktop 10.0.3
+         * @since @interopio/workspaces-api 4.2.1
+         */
         blur?: boolean;
     }
 
     /**
-     * Describes a Frame (a Workspaces App instance).
+     * Describes a `Frame` instance (a Workspaces App instance).
      */
     export interface Frame extends FrameSummary {
         /**
-         * Registers a keyboard shortcut for the current Frame.
-         * @param shortcut Keyboard combination to register as a shortcut for the Frame (e.g., "ctrl+w").
-         * @param callback Callback that will be invoked when the Frame for which the shortcut is registered
-         * is on focus and the user presses the registered keyboard combination.
+         * Registers a keyboard shortcut for the current `Frame` instance.
          * *Available only in **io.Connect Desktop**.*
+         * @param shortcut Keyboard combination to register as a shortcut for the `Frame` instance (e.g., `"ctrl+w"`).
+         * @param callback Callback that will be invoked when the `Frame` instance for which the shortcut is registered
+         * is on focus and the user presses the registered keyboard combination.
          */
         registerShortcut(shortcut: string, callback: () => void): Promise<Unsubscribe>;
 
         /**
-         * Retrieves the current bounds of the Frame.
+         * Retrieves the current bounds of the `Frame` instance.
          */
         getBounds(): Promise<FrameBounds>;
 
         /**
-         * Resizes the Frame.
-         * @param config Options for resizing the Frame.
+         * Resizes the `Frame` instance.
+         * @param config Options for resizing the `Frame` instance.
          */
         resize(config: ResizeConfig): Promise<void>;
 
         /**
-         * Moves the Frame.
-         * @param config Options for moving the Frame.
+         * Moves the `Frame` instance.
+         * @param config Options for moving the `Frame` instance.
          */
         move(config: MoveConfig): Promise<void>;
 
         /**
-         * Focuses the Frame.
+         * Focuses the `Frame` instance.
          */
         focus(): Promise<void>;
 
         /**
-         * Returns the current state of the Frame.
+         * Retrieves the current state of the `Frame` instance.
          * *Available only in **io.Connect Desktop**.*
          */
         state(): Promise<FrameState>;
 
         /**
-         * Minimizes the Frame.
+         * Minimizes the `Frame` instance.
          * *Available only in **io.Connect Desktop**.*
          */
         minimize(): Promise<void>;
 
         /**
-         * Maximizes the Frame.
+         * Maximizes the `Frame` instance.
          * *Available only in **io.Connect Desktop**.*
          */
         maximize(): Promise<void>;
 
         /**
-         * Restores the Frame.
+         * Restores the `Frame` instance.
          * *Available only in **io.Connect Desktop**.*
          */
         restore(): Promise<void>;
 
         /**
-         * Closes the Frame.
+         * Closes the `Frame` instance.
          * The result from using this method in **io.Connect Browser** projects may vary depending on whether the browser will allow the closing operation.
-         * @param options Options for closing the Frame.
+         * @param options Options for closing the `Frame` instance.
          */
         close(options?: FrameCloseOptions): Promise<void>;
 
         /**
-         * Initializes an empty `Frame` with the Workspaces provided via the `FrameInitializationConfig` object.
-         * The order of the Workspaces loaded in the `Frame` depends solely on the order in the provided array (the `positionIndex` property in the Workspace configuration has no effect).
-         * @param config Configuration for initializing an empty `Frame`.
+         * Initializes an empty `Frame` instance with the Workspaces provided via the `FrameInitializationConfig` object.
+         * The order of the Workspaces loaded in the `Frame` instance depends solely on the order in the provided array (the `positionIndex` property in the Workspace configuration has no effect).
+         * @param config Configuration for initializing an empty `Frame` instance.
          */
         init(config: FrameInitializationConfig): Promise<void>;
 
         /**
-        * Retrieves the taskbar icon of the `Frame` instance.
-        * *Available only in **io.Connect Desktop**.*
-        * @since io.Connect Desktop 9.9
-        */
+         * Retrieves the taskbar icon of the `Frame` instance.
+         * *Available only in **io.Connect Desktop**.*
+         * @since io.Connect Desktop 9.9
+         * @since @interopio/workspaces-api 3.5.7
+         */
         getIcon(): Promise<Icon>;
 
         /**
          * Sets the taskbar icon of the `Frame` instance.
          * *Available only in **io.Connect Desktop**.*
-         * @param icon New icon to be displayed in the taskbar for the `Frame` instance. The icon must be encoded as a Base64 string.
+         * @param icon Icon to be displayed in the taskbar for the `Frame` instance. The icon must be encoded as a Base64 string.
          * @since io.Connect Desktop 9.9
+         * @since @interopio/workspaces-api 3.5.7
          */
         setIcon(icon: Icon): Promise<void>;
 
         /**
-         * Returns an object detailing the current state of this frame.
+         * Retrieves a snapshot of the current state of the `Frame` instance.
          */
         snapshot(): Promise<FrameSnapshot>;
 
         /**
-         * Returns a collection of all workspaces present in this frame.
+         * Retrieves all Workspaces in the `Frame` instance.
          */
         workspaces(): Promise<Workspace[]>;
 
         /**
-        * Returns the current size constraints this frame. The constraints are calculated using all of the individual constraints of the elements within the workspaces in the frame.
-        */
+         * Retrieves the current size constraints of the `Frame` instance. The constraints are calculated using the individual constraints of all elements within the Workspaces in the `Frame` instance.
+         */
         getConstraints(): Promise<FrameConstraints>;
 
         /**
-         * Retrieves the current visibility state of the Workspaces Frame instance.
+         * Retrieves the current visibility state of the `Frame` instance.
          * *Available only in **io.Connect Desktop**.*
          * @since io.Connect Desktop 9.10
+         * @since @interopio/workspaces-api 4.1.1
          */
         isVisible(): Promise<boolean>;
 
         /**
-         * Shows the Workspaces Frame instance if it has been previously hidden.
+         * Shows the `Frame` instance if it has been previously hidden.
          * *Available only in **io.Connect Desktop**.*
+         * @param config Settings for showing the `Frame` instance.
          * @since io.Connect Desktop 9.10
+         * @since @interopio/workspaces-api 4.1.1
          */
         show(config?: FrameShowConfig): Promise<void>;
 
         /**
-         * Hides the Workspaces Frame instance if it's currently visible.
+         * Hides the `Frame` instance if it's currently visible.
          * *Available only in **io.Connect Desktop**.*
          * @since io.Connect Desktop 9.10
+         * @since @interopio/workspaces-api 4.1.1
          */
         hide(): Promise<void>;
 
         /**
-         * Opens a new workspace in this frame by restoring a previously saved workspace layout.
-         * @param name The name of a saved workspace layout, which will be restored.
-         * @param options An optional object containing various workspace restore options.
+         * Restores a Workspace in the `Frame` instance from a previously saved Workspace Layout.
+         * @param name Name of the Workspace Layout to restore.
+         * @param options Options for restoring the Workspace.
          */
         restoreWorkspace(name: string, options?: RestoreWorkspaceConfig): Promise<Workspace>;
 
         /**
-         * Opens a new workspace in this frame based on the provided definition.
-         * @param definition An object describing the shape and options of the workspace.
-         * @param saveConfig An object used to set various create options.
+         * Creates a new Workspace in the `Frame` instance based on the provided definition.
+         * @param definition Definition for the Workspace.
+         * @param config Settings for creating the Workspace.
          */
         createWorkspace(definition: WorkspaceDefinition, config?: WorkspaceCreateConfig): Promise<Workspace>;
 
@@ -1313,13 +1829,16 @@ export namespace IOConnectWorkspaces {
          * *Available only in **io.Connect Desktop**.*
          * @param config Options for creating a popup window.
          * @since io.Connect Desktop 10.0
+         * @since @interopio/workspaces-api 4.1.4
          */
         showPopup(config: PopupOptions): Promise<any>;
 
         /**
          * Shows a dialog with a title, message, and response buttons to the user.
          * *Available only in **io.Connect Desktop**.*
+         * @param options Options for the dialog.
          * @since io.Connect Desktop 10.0
+         * @since @interopio/workspaces-api 4.1.2
          */
         showDialog<T>(options: FrameDialogOptions): Promise<T>;
 
@@ -1333,385 +1852,469 @@ export namespace IOConnectWorkspaces {
         setOnTop(options: FrameSetOnTopOptions): Promise<void>;
 
         /**
-         * Notifies when the Frame is about to be closed.
-         * *Available only in **io.Connect Desktop**.*
-         * @param callback Callback function for handling the event. Receives as an argument an object with options for closing the Frame.
+         * Notifies when the `Frame` instance is about to be closed. Returns an unsubscribe function.
+         * In **io.Connect Browser**, requires `@interopio/workspaces-api` 5.1 or later.
+         * @param callback Callback function for handling the event. Receives as an argument an object with options for closing the `Frame` instance.
          * @since io.Connect Desktop 9.9
+         * @since io.Connect Browser 5.0
+         * @since @interopio/workspaces-api 3.5.7
          */
         onClosing(callback: (options: FrameClosingData) => void | Promise<void>): Promise<Unsubscribe>;
 
         /**
-         * Notifies when this frame is closed.
-         * @param callback Callback function to handle the event.
+         * Notifies when the `Frame` instance has been closed. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument an object describing the closed `Frame` instance.
          */
         onClosed(callback: (closed: FrameClosedData) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when this frame is maximized.
-         * This event is not supported in **io.Connect Browser**.
-         * @param callback Callback function to handle the event.
+         * Notifies when the `Frame` instance has been maximized. Returns an unsubscribe function.
+         * *Available only in **io.Connect Desktop**.*
+         * @param callback Callback function for handling the event.
          */
         onMaximized(callback: () => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when this frame is closed.
-         * This event is not supported in **io.Connect Browser**.
-         * @param callback Callback function to handle the event.
+         * Notifies when the `Frame` instance has been minimized. Returns an unsubscribe function.
+         * *Available only in **io.Connect Desktop**.*
+         * @param callback Callback function for handling the event.
          */
         onMinimized(callback: () => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when this frame is closed.
-         * This event is not supported in **io.Connect Browser**.
-         * @param callback Callback function to handle the event.
+         * Notifies when the `Frame` instance has been restored to its normal state. Returns an unsubscribe function.
+         * *Available only in **io.Connect Desktop**.*
+         * @param callback Callback function for handling the event.
          */
         onNormal(callback: () => void): Promise<Unsubscribe>;
 
         /**
-         * Triggered when either a window in the frame is focused or the frame itself.
+         * Notifies when the `Frame` instance or a window in it has gained or lost focus. Returns an unsubscribe function.
          * *Available only in **io.Connect Desktop**.*
-         * @param callback Callback function to handle the event. It receives a data oject which indicates how the focus has changed.
+         * @param callback Callback function for handling the event. Receives as an argument an object indicating whether the `Frame` instance is on focus.
          */
         onFocusChanged(callback: (data: FrameFocusChangedData) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
         /**
-         * Notifies when a the frame is created without being initialized.
-         * @param callback Callback function to handle the event. Receives a context for the initialization request
+         * Notifies when the `Frame` instance has been created without being initialized (i.e., as an empty `Frame` instance). Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the context for the initialization request.
          */
         onInitializationRequested(callback: (context?: IOConnectWorkspaces.FrameInitializationContext) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a new workspace was opened in this frame and returns an unsubscribe function.
-         * @param callback Callback function to handle the event. Receives the added workspace as a parameter.
+         * Notifies when a new Workspace has been opened in the `Frame` instance. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the `Workspace` object describing the opened Workspace.
          */
         onWorkspaceOpened(callback: (workspace: Workspace) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a workspace is selected in this frame and returns an unsubscribe function.
-         * @param callback Callback function to handle the event. Receives the selected workspace as a parameter.
+         * Notifies when a Workspace has been selected in the `Frame` instance. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the `Workspace` object describing the selected Workspace.
          */
         onWorkspaceSelected(callback: (workspace: Workspace) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a workspace present in this frame was closed and returns an unsubscribe function.
-         * @param callback Callback function to handle the event. Receives an object with the closed workspace id and frame id as a parameter.
+         * Notifies when a Workspace in the `Frame` instance has been closed. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument an object with the IDs of the closed Workspace and its `Frame` instance.
          */
         onWorkspaceClosed(callback: (closed: { frameId: string; workspaceId: string }) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a new window was added to a workspace part of this frame and returns an unsubscribe function.
-         * An added window means that the window has a place in the workspace (it is a valid workspace element), but does not guarantee that the contents of the window are loaded.
-         * @param callback Callback function to handle the event. Receives the added window as a parameter.
+         * Notifies when a new window has been added to a Workspace in the `Frame` instance. Returns an unsubscribe function.
+         * An added window has a place in the Workspace (it's a valid Workspace element), but this doesn't guarantee that the contents of the window have been loaded.
+         * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the added window.
          */
         onWindowAdded(callback: (window: WorkspaceWindow) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a window was removed from a workspace part of this frame and returns an unsubscribe function.
-         * @param callback Callback function to handle the event. Receives an object containing the ids of the removed window, and the respective workspace and frame as a parameter.
+         * Notifies when a window has been removed from a Workspace in the `Frame` instance. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument an object with the IDs of the removed window and of its Workspace and `Frame` instance.
          */
         onWindowRemoved(callback: (removed: { windowId?: string; workspaceId: string; frameId: string }) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a window's content was loaded in a workspace part of this frame and returns an unsubscribe function.
-         * A loaded window is a window, which was added to a workspace, it's contents were loaded and is present in the windows collection.
-         * @param callback Callback function to handle the event. Receives the loaded window as a parameter.
+         * Notifies when the contents of a window in a Workspace in the `Frame` instance have been loaded. Returns an unsubscribe function.
+         * A loaded window is a window that has been added to a Workspace, whose contents have been loaded, and which is present in the windows collection.
+         * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the loaded window.
          */
         onWindowLoaded(callback: (window: WorkspaceWindow) => void): Promise<Unsubscribe>;
     }
 
-    /** An object describing the basic details of a workspace */
+    /**
+     * Describes the basic details of a Workspace.
+     */
     export interface WorkspaceSummary {
-        /** An unique string identifier of the workspace */
+        /**
+         * Unique ID of the Workspace.
+         */
         id: string;
 
-        /** The string id of the frame containing this workspace */
+        /**
+         * ID of the `Frame` instance containing the Workspace.
+         */
         frameId: string;
 
-        /** The position of this workspace regarding it's siblings */
+        /**
+         * Position of the Workspace relative to the other Workspaces in the `Frame` instance.
+         */
         positionIndex: number;
 
-        /** The title of the workspace */
+        /**
+         * Title of the Workspace.
+         */
         title: string;
 
-        /** The name of the originating layout of the current workspace if any */
+        /**
+         * Name of the Workspace Layout from which the Workspace originates, if any.
+         */
         layoutName: string | undefined;
 
-        /** The id of the originating layout of the current workspace if any. Can be undefined if using with an older version of **io.Connect Desktop** or **io.Connect Browser**. */
+        /**
+         * Unique ID of the Workspace Layout from which the Workspace originates.
+         * *Available only in **io.Connect Desktop**.*
+         * @since io.Connect Desktop 10.5
+         * @since @interopio/workspaces-api 5.0.0
+         */
         layoutId?: string;
 
-        /** Indicates if the workspace is hibernated */
+        /**
+         * Flag indicating whether the Workspace is hibernated.
+         */
         isHibernated?: boolean;
 
-        /** Indicates if the workspace is selected in its frame. Can be undefined if using with an older version of **io.Connect Desktop** or **io.Connect Browser**. */
+        /**
+         * Flag indicating whether the Workspace is selected in its `Frame` instance.
+         */
         isSelected?: boolean;
 
-        /** Indicates if dragging of splitters is allowed in the workspace */
+        /**
+         * Flag indicating whether the user can resize the Workspace elements by dragging the splitters.
+         */
         allowSplitters?: boolean;
 
-        /** Indicates if dropping outsize windows to the workspace is allowed */
+        /**
+         * Flag indicating whether the user can add windows by dropping them in the Workspace.
+         */
         allowDrop?: boolean;
 
-        /** Indicates if dropping windows in the left-most zone of the workspace is allowed */
+        /**
+         * Flag indicating whether the user can add windows by dropping them in the leftmost area of the Workspace.
+         */
         allowDropLeft?: boolean;
 
-        /** Indicates if dropping windows in the top-most zone of the workspace is allowed */
+        /**
+         * Flag indicating whether the user can add windows by dropping them in the topmost area of the Workspace.
+         */
         allowDropTop?: boolean;
 
-        /** Indicates if dropping windows in the right-most zone of the workspace is allowed */
+        /**
+         * Flag indicating whether the user can add windows by dropping them in the rightmost area of the Workspace.
+         */
         allowDropRight?: boolean;
 
-        /** Indicates if dropping windows in the bottom-most zone of the workspace is allowed */
+        /**
+         * Flag indicating whether the user can add windows by dropping them in the bottommost area of the Workspace.
+         */
         allowDropBottom?: boolean;
 
-        /** Indicates if extracting windows from the workspace is allowed */
+        /**
+         * Flag indicating whether the user can extract windows from the Workspace.
+         */
         allowExtract?: boolean;
 
-        /** Indicates if reordering windows in the workspace is allowed */
+        /**
+         * Flag indicating whether the user can reorder windows in the Workspace.
+         */
         allowWindowReorder?: boolean;
 
-        /** Indicates if the close button for this workspace is visible to the user */
+        /**
+         * Flag indicating whether the "Close" button in the Workspace tab is visible.
+         */
         showCloseButton?: boolean;
 
-        /** Indicates if the save button for this workspace is visible to the user */
+        /**
+         * Flag indicating whether the "Rename", "Save", and "Save As" options in the Workspace tab menu are visible.
+         */
         showSaveButton?: boolean;
 
         /**
-         * Controls whether the workspace tab can be extracted.
+         * Flag indicating whether the user can extract the Workspace tab from the Workspaces App.
          * *Available only in **io.Connect Desktop**.*
          */
         allowWorkspaceTabExtract?: boolean;
 
-        /** Controls whether the workspace tab can be reordered*/
+        /**
+         * Flag indicating whether the user can reorder the Workspace tab in the Workspaces App.
+         */
         allowWorkspaceTabReorder?: boolean;
 
-        /** Returns the minimum width of the workspace, calculated by the constraints of all elements inside it */
+        /**
+         * Minimum width in pixels of the Workspace, calculated using the constraints of all elements in it.
+         */
         minWidth?: number;
 
-        /** Returns the minimum height of the workspace, calculated by the constraints of all elements inside it */
+        /**
+         * Minimum height in pixels of the Workspace, calculated using the constraints of all elements in it.
+         */
         minHeight?: number;
 
-        /** Returns the maximum width of the workspace, calculated by the constraints of all elements inside it */
+        /**
+         * Maximum width in pixels of the Workspace, calculated using the constraints of all elements in it.
+         */
         maxWidth?: number;
 
-        /** Returns the maximum height of the workspace, calculated by the constraints of all elements inside it */
+        /**
+         * Maximum height in pixels of the Workspace, calculated using the constraints of all elements in it.
+         */
         maxHeight?: number;
 
-        /** Returns the current width of the workspace */
+        /**
+         * Width in pixels of the Workspace.
+         */
         width?: number;
 
-        /** Returns the current height of the workspace */
+        /**
+         * Height in pixels of the Workspace.
+         */
         height?: number;
 
-        /** Indicates if the close buttons of the windows within this workspace are visible to the user */
+        /**
+         * Flag indicating whether the "Close" buttons in the window tabs are visible.
+         */
         showWindowCloseButtons?: boolean;
 
-        /** Indicates if the eject buttons of the windows within this workspace are visible to the user */
+        /**
+         * Flag indicating whether the "Eject" buttons in the headers of the window groups are visible.
+         */
         showEjectButtons?: boolean;
 
-        /** Indicates if the window add buttons within this workspace are visible to the user */
+        /**
+         * Flag indicating whether the "Add Window" buttons (the "+" buttons) in the headers of the window groups are visible.
+         */
         showAddWindowButtons?: boolean;
 
         /**
-         * Indicates the loading strategy for the Workspace.
+         * Loading strategy of the Workspace.
          * *Available only in **io.Connect Desktop**.*
+         * @since io.Connect Desktop 9.8
+         * @since @interopio/workspaces-api 3.5.6
          */
         loadingStrategy?: LoadingStrategy;
 
         /**
-         * Indicates whether the Workspace can be hibernated via the platform configuration.
+         * Flag indicating whether the Workspace can be hibernated via the platform configuration.
          * This setting doesn't apply to programmatic hibernation via the `hibernate()` method of a `Workspace` instance.
          */
         allowSystemHibernation?: boolean;
 
+        /**
+         * Restrictions for dropping apps in the Workspace and allowing apps to appear in the "Add Apps" popup menu of the Workspace.
+         * @since io.Connect Desktop 10.5
+         * @since io.Connect Browser 4.6
+         * @since @interopio/workspaces-api 5.0.0
+         */
         appRestrictions?: AppRestrictions;
     }
 
+    /**
+     * Options for saving a Workspace Layout via the `saveLayout()` method of a `Workspace` instance.
+     */
     export type SaveLayoutConfig = Omit<Omit<IOConnectWorkspaces.WorkspaceLayoutSaveConfig, "name">, "workspaceId">;
 
-    /** An object describing a workspace */
+    /**
+     * Describes a Workspace.
+     */
     export interface Workspace extends WorkspaceSummary {
 
-        /** A collection containing the immediate children of this workspace */
+        /**
+         * Array of objects, each describing an immediate child element of the Workspace.
+         */
         children: WorkspaceElement[];
 
-        /** An object representing the frame containing this workspace */
+        /**
+         * `Frame` instance containing the Workspace.
+         */
         frame: Frame;
 
         /**
-         * Gives focus to this workspace.
+         * Focuses the Workspace.
          */
         focus(): Promise<void>;
 
         /**
-         * Closes this workspace and all of it's children.
+         * Closes the Workspace and all its child elements.
          */
         close(): Promise<void>;
 
         /**
-         * Returns a snapshot object describing the full current state of this workspace.
+         * Retrieves a snapshot of the current state of the Workspace.
          */
         snapshot(): Promise<WorkspaceSnapshot>;
 
         /**
-         * Sets a new title for this workspace.
-         * @param title The new title value.
+         * Sets the title of the Workspace.
+         * @param title Title for the Workspace.
          */
         setTitle(title: string): Promise<void>;
 
         /**
-         * Gets the context for this workspace.
+         * Retrieves the context of the Workspace.
          */
         getContext(): Promise<any>;
 
         /**
-         * Sets the context for this workspace. This operation will completely overwrite the existing context.
-         * @param data The new context value.
+         * Sets the context of the Workspace. This operation will overwrite entirely the existing context.
+         * @param data Context for the Workspace.
          */
         setContext(data: any): Promise<void>;
 
         /**
-         * Updated the context for this workspace. This operation will merge the existing context with the provided value.
-         * @param data The context value to update.
+         * Updates the context of the Workspace. This operation will merge the update with the existing context.
+         * @param data Context data with which to update the Workspace context.
          */
         updateContext(data: any): Promise<void>;
 
         /**
-         * Notifies when the context for this workspace was updated.
-         * @param callback Callback function to handle the event.
+         * Notifies when the context of the Workspace has been updated. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the updated context.
          */
         onContextUpdated(callback: (data: any) => void): Promise<Unsubscribe>;
 
         /**
-         * Updates this workspace reference to reflect the current state of the workspace.
+         * Updates the `Workspace` object to reflect the current state of the Workspace.
          */
         refreshReference(): Promise<void>;
 
         /**
-         * Saves the current workspace structure as a layout. In **io.Connect Browser** this will throw an error if the name matches the name of a read-only layout.
-         * @param name A string representing the name (also ID) of the new workspace layout.
-         * @param config An optional object used to set various options for saving the workspace layout.
+         * Saves the current structure of the Workspace as a Workspace Layout.
+         * In **io.Connect Browser**, this will throw an error if the name matches the name of a read-only Workspace Layout.
+         * @param name Name for the Workspace Layout.
+         * @param config Options for saving the Workspace Layout.
          */
         saveLayout(name: string, config?: SaveLayoutConfig): Promise<void>;
 
         /**
-         * Returns the first box in this workspace, which satisfies the provided predicate.
-         * @param predicate A filtering function (predicate) called for each box present in this workspace.
+         * Retrieves the first box element in the Workspace that satisfies the provided predicate.
+         * @param predicate Filtering function (predicate) that will be invoked for each box element in the Workspace.
          */
-        getBox(predicate: (box: WorkspaceBox) => boolean): WorkspaceBox;
+        getBox(predicate: (box: WorkspaceBox) => boolean): WorkspaceBox | undefined;
 
         /**
-         * Returns all boxes in this workspace, which satisfy the provided predicate. If no predicate was provided, will return all boxes.
-         * @param predicate A filtering function (predicate) called for each box present in this workspace.
+         * Retrieves all box elements in the Workspace that satisfy the provided predicate. If no predicate is provided, will return all box elements.
+         * @param predicate Filtering function (predicate) that will be invoked for each box element in the Workspace.
          */
         getAllBoxes(predicate?: (box: WorkspaceBox) => boolean): WorkspaceBox[];
 
         /**
-         * Returns the first row in this workspace, which satisfies the provided predicate.
-         * @param predicate A filtering function (predicate) called for each row present in this workspace.
+         * Retrieves the first row in the Workspace that satisfies the provided predicate.
+         * @param predicate Filtering function (predicate) that will be invoked for each row in the Workspace.
          */
-        getRow(predicate: (row: Row) => boolean): Row;
+        getRow(predicate: (row: Row) => boolean): Row | undefined;
 
         /**
-         * Returns all rows in this workspace, which satisfy the provided predicate. If no predicate was provided, will return all rows.
-         * @param predicate A filtering function (predicate) called for each row present in this workspace.
+         * Retrieves all rows in the Workspace that satisfy the provided predicate. If no predicate is provided, will return all rows.
+         * @param predicate Filtering function (predicate) that will be invoked for each row in the Workspace.
          */
         getAllRows(predicate?: (row: Row) => boolean): Row[];
 
         /**
-         * Returns the first column in this workspace, which satisfies the provided predicate.
-         * @param predicate A filtering function (predicate) called for each column present in this workspace.
+         * Retrieves the first column in the Workspace that satisfies the provided predicate.
+         * @param predicate Filtering function (predicate) that will be invoked for each column in the Workspace.
          */
-        getColumn(predicate: (column: Column) => boolean): Column;
+        getColumn(predicate: (column: Column) => boolean): Column | undefined;
 
         /**
-         * Returns all columns in this workspace, which satisfy the provided predicate. If no predicate was provided, will return all column.
-         * @param predicate A filtering function (predicate) called for each column present in this workspace.
+         * Retrieves all columns in the Workspace that satisfy the provided predicate. If no predicate is provided, will return all columns.
+         * @param predicate Filtering function (predicate) that will be invoked for each column in the Workspace.
          */
         getAllColumns(predicate?: (columns: Column) => boolean): Column[];
 
         /**
-         * Returns the first group in this workspace, which satisfies the provided predicate.
-         * @param predicate A filtering function (predicate) called for each group present in this workspace.
+         * Retrieves the first window group in the Workspace that satisfies the provided predicate.
+         * @param predicate Filtering function (predicate) that will be invoked for each window group in the Workspace.
          */
-        getGroup(predicate: (group: Group) => boolean): Group;
+        getGroup(predicate: (group: Group) => boolean): Group | undefined;
 
         /**
-         * Returns all groups in this workspace, which satisfy the provided predicate. If no predicate was provided, will return all groups.
-         * @param predicate A filtering function (predicate) called for each group present in this workspace.
+         * Retrieves all window groups in the Workspace that satisfy the provided predicate. If no predicate is provided, will return all window groups.
+         * @param predicate Filtering function (predicate) that will be invoked for each window group in the Workspace.
          */
         getAllGroups(predicate?: (group: Group) => boolean): Group[];
 
         /**
-         * Returns the first window in this workspace, which satisfies the provided predicate.
-         * @param predicate A filtering function (predicate) called for each window present in this workspace.
+         * Retrieves the first window in the Workspace that satisfies the provided predicate.
+         * @param predicate Filtering function (predicate) that will be invoked for each window in the Workspace.
          */
-        getWindow(predicate: (window: WorkspaceWindow) => boolean): WorkspaceWindow;
+        getWindow(predicate: (window: WorkspaceWindow) => boolean): WorkspaceWindow | undefined;
 
         /**
-         * Returns all windows in this workspace, which satisfy the provided predicate. If no predicate was provided, will return all windows.
-         * @param predicate A filtering function (predicate) called for each window present in this workspace.
+         * Retrieves all windows in the Workspace that satisfy the provided predicate. If no predicate is provided, will return all windows.
+         * @param predicate Filtering function (predicate) that will be invoked for each window in the Workspace.
          */
         getAllWindows(predicate?: (window: WorkspaceWindow) => boolean): WorkspaceWindow[];
 
         /**
-         * Adds a new row to this workspace.
-         * @param definition An object describing the available row settings.
+         * Adds a new row to the Workspace.
+         * @param definition Definition for the row.
          */
         addRow(definition?: BoxDefinition): Promise<Row>;
 
         /**
-         * Adds a new column to this workspace.
-         * @param definition An object describing the available column settings.
+         * Adds a new column to the Workspace.
+         * @param definition Definition for the column.
          */
         addColumn(definition?: BoxDefinition): Promise<Column>;
 
         /**
-         * Adds a new group to this workspace.
-         * @param definition An object describing the available group settings.
+         * Adds a new window group to the Workspace.
+         * @param definition Definition for the window group.
          */
         addGroup(definition?: BoxDefinition): Promise<Group>;
 
         /**
-         * Adds a new window to this workspace.
-         * @param definition An object describing the available window settings.
+         * Adds a new window to the Workspace.
+         * @param definition Definition for the window.
          */
         addWindow(definition: WorkspaceWindowDefinition): Promise<WorkspaceWindow>;
 
         /**
-         * Removes the first element of this workspace which satisfies the predicate.
-         * @param predicate A filtering function (predicate) called for each element in this workspace.
+         * Removes the first element in the Workspace that satisfies the provided predicate.
+         * @param predicate Filtering function (predicate) that will be invoked for each element in the Workspace.
          */
         remove(predicate: (child: WorkspaceElement) => boolean): Promise<void>;
 
         /**
-         * Removes the first immediate child of this workspaces which satisfies the predicate.
-         * @param predicate A filtering function (predicate) called for immediate child of this workspace.
+         * Removes the first immediate child element of the Workspace that satisfies the provided predicate.
+         * @param predicate Filtering function (predicate) that will be invoked for each immediate child element of the Workspace.
          */
         removeChild(predicate: (child: WorkspaceElement) => boolean): Promise<void>;
 
         /**
-         * Transforms this workspace into a workspace with one immediate child of type row and all existing elements are inserted as a child to that row.
+         * Transforms the Workspace into a Workspace with a single immediate child element of type row that will contain all existing elements.
          */
         bundleToRow(): Promise<void>;
 
         /**
-         * Transforms this workspace into a workspace with one immediate child of type column and all existing elements are inserted as a child to that row.
+         * Transforms the Workspace into a Workspace with a single immediate child element of type column that will contain all existing elements.
          */
         bundleToColumn(): Promise<void>;
 
         /**
-         * Puts the workspace in a hibernated state. All the windows are closed, but the workspace structure remains.
+         * Hibernates the Workspace. All windows in the Workspace will be closed, but the Workspace structure will be preserved.
          */
         hibernate(): Promise<void>;
 
         /**
-         * Resumes a hibernated workspace. All the windows prior to the hibernation are reloaded.
+         * Resumes the hibernated Workspace. All windows that have been closed during hibernation will be reloaded.
          */
         resume(): Promise<void>;
 
         /**
-         * Locks the workspace using a provided config object, which restricts various modification functionalities of the workspace
-         * @param config This can be either an object or a function. When the object is provided, it overrides all other lock properties. When a function is provided, it will be called with the current lock settings and it should return a lock config, which will override the current settings. The function is recommended in all cases where overriding of the settings is not desired.
+         * Locks the Workspace in order to restrict the ability of the user to modify it.
+         * If no lock settings are provided, all lock properties will be set to `false`.
+         * @param config Object or function for setting the lock properties. If an object is provided, it will override all current lock settings.
+         * If a function is provided, it will be invoked with the current lock settings as an argument and must return an object with lock settings that will override the current ones.
+         * Using a function is recommended when you don't want to override all current lock settings.
          */
         lock(config?: WorkspaceLockConfig | ((config: WorkspaceLockConfig) => WorkspaceLockConfig)): Promise<void>;
 
@@ -1720,40 +2323,43 @@ export namespace IOConnectWorkspaces {
          * *Available only in **io.Connect Desktop**.*
          * @param mode Mode for dragging the Workspace windows. If set to `"autoEject"`, when the user drags a Workspace window, it will be ejected from the Workspace during the dragging operation and the user will be able to drop it back inside the Workspace, or out of the Workspace.
          * If set to `"keepInside"`, the window won't be ejected from the Workspace when being dragged and the user will be able to drop it only inside the Workspace.
+         * @since io.Connect Desktop 9.5
+         * @since @interopio/workspaces-api 3.5.2
          */
         setWindowDragMode(mode: "keepInside" | "autoEject"): Promise<void>;
 
         /**
-         * Sets the loading strategy for the Workspace at runtime.
+         * Sets the loading strategy of the Workspace at runtime.
          * This will override the current loading strategy for the Workspace that may have been specified via configuration or programmatically
          * when creating or restoring the Workspace. The loading strategy specified via this method will be preserved in the Workspace Layout
          * only if the Workspace is saved afterwards and the `"persistCurrentStrategy"` flag is set to `true` in the Workspaces App definition.
          * *Available only in **io.Connect Desktop**.*
          * @since io.Connect Desktop 9.8
+         * @since @interopio/workspaces-api 3.5.6
          * @param strategy Loading strategy for the Workspace.
          */
         setLoadingStrategy(strategy: LoadingStrategy): Promise<void>;
 
         /**
-         * Notifies when this workspace is closed.
-         * @param callback Callback function to handle the event.
+         * Notifies when the Workspace has been closed. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument an object describing the closed Workspace.
          */
         onClosed(callback: (closed?: WorkspaceClosedData) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when the a change in the lock configuration of the workspace has been made
-         * @param callback Callback function to handle the event. Receives the new lock configuration as a parameter.
+         * Notifies when the lock settings of the Workspace have changed. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the new lock settings.
          */
         onLockConfigurationChanged(callback: (config: IOConnectWorkspaces.WorkspaceLockConfig) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
         /**
-         * Notifies when the Workspace is hibernated. Returns an unsubscribe function.
+         * Notifies when the Workspace has been hibernated. Returns an unsubscribe function.
          * @param callback Callback function for handling the event.
          */
         onHibernated(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
         /**
-         * Notifies when the Workspace is resumed after being hibernated. Returns an unsubscribe function.
+         * Notifies when the Workspace has been resumed after being hibernated. Returns an unsubscribe function.
          * @param callback Callback function for handling the event.
          */
         onResumed(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe>;
@@ -1777,482 +2383,637 @@ export namespace IOConnectWorkspaces {
         onWindowTabReordered(callback: (window: WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
         /**
-         * Notifies when a new window was added to this workspace and returns an unsubscribe function.
-         * An added window means that the window has a place in the workspace (it is a valid workspace element), but does not guarantee that the contents of the window are loaded.
-         * @param callback Callback function to handle the event. Receives the added window as a parameter.
+         * Notifies when a new window has been added to the Workspace. Returns an unsubscribe function.
+         * An added window has a place in the Workspace (it's a valid Workspace element), but this doesn't guarantee that the contents of the window have been loaded.
+         * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the added window.
          */
         onWindowAdded(callback: (window: WorkspaceWindow) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a window was removed from this workspace and returns an unsubscribe function.
-         * Not supported in **io.Connect Browser**.
-         * @param callback Callback function to handle the event. Receives an object containing the ids of the removed window, and the respective workspace and frame as a parameter.
+         * Notifies when a window has been removed from the Workspace. Returns an unsubscribe function.
+         * *Available only in **io.Connect Desktop**.*
+         * @param callback Callback function for handling the event. Receives as an argument an object with the IDs of the removed window and of its Workspace and `Frame` instance.
          */
         onWindowRemoved(callback: (removed: { windowId?: string; workspaceId: string; frameId: string }) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a window's content was loaded in this workspace and returns an unsubscribe function.
-         * A loaded window is a window, which was added to a workspace, it's contents were loaded and is present in the windows collection.
-         * @param callback Callback function to handle the event. Receives the loaded window as a parameter.
+         * Notifies when the contents of a window in the Workspace have been loaded. Returns an unsubscribe function.
+         * A loaded window is a window that has been added to a Workspace, whose contents have been loaded, and which is present in the windows collection.
+         * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the loaded window.
          */
         onWindowLoaded(callback: (window: WorkspaceWindow) => void): Promise<Unsubscribe>;
+
         /**
-                * Notifies when a window was maximized in this workspace and returns an unsubscribe function.
-                * A maximized window means that the window has been maximized either by an API call or from the maximize button by the user.
-                * @param callback Callback function to handle the event. Receives the maximized window as a parameter.
-                */
+         * Notifies when a window in the Workspace has been maximized. Returns an unsubscribe function.
+         * The window can be maximized programmatically or by the user via the "Maximize" button.
+         * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the maximized window.
+         */
         onWindowMaximized(callback: (window: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
         /**
-          * Notifies when a window was restored in this workspace and returns an unsubscribe function.
-          * A restored window means that the window has been restored from a maximized state either by an API call or from the restored button by the user.
-          * @param callback Callback function to handle the event. Receives the restored window as a parameter.
-          */
+         * Notifies when a window in the Workspace has been restored from a maximized state. Returns an unsubscribe function.
+         * The window can be restored programmatically or by the user via the "Restore" button.
+         * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the restored window.
+         */
         onWindowRestored(callback: (window: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
         /**
-         * Notifies when a window was selected in this workspace and returns an unsubscribe function.
-         * @param callback Callback function to handle the event. Receives the selected window as a parameter.
+         * Notifies when a window in the Workspace has been selected. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the selected window.
          */
         onWindowSelected(callback: (window: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
         /**
-         * Indicates if the workspace is in a pinned state or not
+         * Flag indicating whether the Workspace is pinned.
          */
         isPinned?: boolean;
 
         /**
          * Mode for dragging the windows that are part of the Workspace. If set to `"autoEject"` (available only in **io.Connect Desktop**), when the user drags a Workspace window, it will be ejected from the Workspace during the dragging operation and the user will be able to drop it back inside the Workspace, or out of the Workspace.
          * If set to `"keepInside"`, the window won't be ejected from the Workspace when being dragged and the user will be able to drop it only inside the Workspace.
+         * @since io.Connect Desktop 9.5
+         * @since @interopio/workspaces-api 3.5.2
          */
         windowDragMode?: "keepInside" | "autoEject";
 
         /**
-         * The icon related to the workspace in the same format as it was passed
+         * Icon of the Workspace in the format in which it has been provided.
          */
         icon?: string;
 
         /**
-         * Changes the state of the workspace to pinned - moves the workspace tab to the index before all unpinned tabs, removes the save button, title, close button and shows the workspace icon
-         * @param options - object which controls the pinning
+         * Pins the Workspace. The Workspace tab will be moved before all unpinned Workspace tabs,
+         * the title, the Workspace tab menu, and the "Close" button will be removed, and the Workspace icon will be shown.
+         * @param options Options for pinning the Workspace.
          */
         pin(options?: WorkspacePinOptions): Promise<void>;
 
         /**
-         * Changes the state of the workspace to normal -  moves the workspace tab to the index after all pinned tabs, returns the save button, title, close button and hides the workspace icon
+         * Unpins the Workspace. The Workspace tab will be moved after all pinned Workspace tabs,
+         * the title, the Workspace tab menu, and the "Close" button will be returned, and the Workspace icon will be hidden.
          */
         unpin(): Promise<void>;
 
         /**
-         * Returns the workspace icon
+         * Retrieves the icon of the Workspace.
          */
         getIcon(): Promise<string>;
 
         /**
-         * Changes the workspace icon to the specified one
-         * @param icon
+         * Sets the icon of the Workspace.
+         * @param icon Icon for the Workspace. Can be a path to a web resource or a string representation of an image, such as Base64.
          */
         setIcon(icon: string): Promise<void>;
 
         /**
-         * Shows the loading animation of the workspace.
+         * Shows the loading animation of the Workspace.
          * *Available only in **io.Connect Desktop**.*
          */
         showLoadingAnimation(): Promise<void>;
 
         /**
-         * Hides the loading animation of the workspace.
+         * Hides the loading animation of the Workspace.
          * *Available only in **io.Connect Desktop**.*
          */
         hideLoadingAnimation(): Promise<void>;
     }
 
-    /** An object containing the summary of a workspace box */
+    /**
+     * Describes the basic details of a box element.
+     */
     export interface BoxSummary {
 
-        /** An unique string identifier of this box */
+        /**
+         * Unique ID of the box element.
+         */
         id: string;
 
-        /** The unique string identifier of the frame containing this box */
+        /**
+         * ID of the `Frame` instance containing the box element.
+         */
         frameId: string;
 
-        /** The unique string identifier of the workspace containing this box */
+        /**
+         * ID of the Workspace containing the box element.
+         */
         workspaceId: string;
 
-        /** An number representing the positing of this box relative to it's siblings */
+        /**
+         * Position of the box element relative to its sibling elements.
+         */
         positionIndex: number;
 
-        /** Indicates if dropping windows inside this box is allowed */
+        /**
+         * Flag indicating whether the user can add windows by dropping them in the box element.
+         */
         allowDrop?: boolean;
 
-        /** Returns the minimum width of the box, calculated by the size constraints of the elements inside it */
+        /**
+         * Minimum width in pixels of the box element, calculated using the size constraints of the elements in it.
+         */
         minWidth?: number;
 
-        /** Returns the minimum height of the box, calculated by the size constraints of the elements inside it */
+        /**
+         * Minimum height in pixels of the box element, calculated using the size constraints of the elements in it.
+         */
         minHeight?: number;
 
-        /** Returns the maximum width of the box, calculated by the size constraints of the elements inside it */
+        /**
+         * Maximum width in pixels of the box element, calculated using the size constraints of the elements in it.
+         */
         maxWidth?: number;
 
-        /** Returns the maximum height of the box, calculated by the size constraints of the elements inside it */
+        /**
+         * Maximum height in pixels of the box element, calculated using the size constraints of the elements in it.
+         */
         maxHeight?: number;
 
-        /** Returns the current width of the box, can be undefined if the API is used with old versions of Enterprise or Core */
+        /**
+         * Width in pixels of the box element.
+         */
         width?: number;
 
-        /** Returns the current height of the box, can be undefined if the API is used with old versions of Enterprise or Core */
+        /**
+         * Height in pixels of the box element.
+         */
         height?: number;
 
-        /** Returns whether or not the box is maximized */
+        /**
+         * Flag indicating whether the box element is maximized.
+         */
         isMaximized?: boolean;
     }
 
-    /** An object describing a workspace box */
+    /**
+     * Describes a box element in a Workspace.
+     */
     export interface Box extends BoxSummary {
 
-        /** A collection containing the immediate children of this box */
+        /**
+         * Array of objects, each describing an immediate child element of the box element.
+         */
         children: WorkspaceElement[];
 
-        /** An object representing this box's parent */
+        /**
+         * Parent of the box element - a Workspace or another box element.
+         */
         parent: Workspace | WorkspaceBox;
 
-        /** An object representing the frame containing this box */
+        /**
+         * `Frame` instance containing the box element.
+         */
         frame: Frame;
 
-        /** An object representing the workspace containing this box */
+        /**
+         * Workspace containing the box element.
+         */
         workspace: Workspace;
 
         /**
-         * Opens a new window inside this box and loads it's content.
-         * @param definition An object describing the requested window.
+         * Opens a new window in the box element and loads its contents.
+         * @param definition Definition for the window.
          */
         addWindow(definition: WorkspaceWindowDefinition): Promise<WorkspaceWindow>;
 
         /**
-         * Adds a new group box to this box.
-         * @param definition An object describing the type of the requested builder, alongside other settings.
+         * Adds a new window group to the box element.
+         * @param definition Definition or a builder for the window group.
          */
         addGroup(definition?: BoxDefinition | BoxBuilder): Promise<Group>;
 
         /**
-         * Adds a new column box to this box.
-         * @param definition An object describing the type of the requested builder, alongside other settings.
+         * Adds a new column to the box element.
+         * @param definition Definition or a builder for the column.
          */
         addColumn(definition?: BoxDefinition | BoxBuilder): Promise<Column>;
 
         /**
-         * Adds a new row box to this box.
-         * @param definition An object describing the type of the requested builder, alongside other settings.
+         * Adds a new row to the box element.
+         * @param definition Definition or a builder for the row.
          */
         addRow(definition?: BoxDefinition | BoxBuilder): Promise<Row>;
 
         /**
-         * Removes the first immediate child of this box which satisfies the predicate.
-         * @param predicate A filtering function (predicate) called for immediate child of this box.
+         * Removes the first immediate child element of the box element that satisfies the provided predicate.
+         * @param predicate Filtering function (predicate) that will be invoked for each immediate child element of the box element.
          */
         removeChild(predicate: (child: WorkspaceElement) => boolean): Promise<void>;
 
         /**
-         * Maximizes this box relative to it's parent box.
+         * Maximizes the box element within the bounds of the Workspace, or within the nearest parent element set as a maximization boundary.
          */
         maximize(): Promise<void>;
 
         /**
-         * Restores this box, if previously maximized.
+         * Restores the box element if it has been previously maximized.
          */
         restore(): Promise<void>;
 
         /**
-         * Closes this box all of it's children.
+         * Closes the box element and all its child elements.
          */
         close(): Promise<void>;
     }
 
-    /** An object describing a row type workspace box */
+    /**
+     * Describes a Workspace row.
+     */
     export interface Row extends Box {
+        /**
+         * Type of the box element.
+         */
         type: "row";
 
-        /** Indicates if dragging of splitters is allowed in the row */
+        /**
+         * Flag indicating whether the user can resize the row by dragging the splitters.
+         */
         allowSplitters?: boolean;
 
-        /** Indicates whether or not the row is pinned */
+        /**
+         * Flag indicating whether the row is pinned.
+         */
         isPinned?: boolean;
 
-        /** If set to true any child that is maximized will have its width and height constricted to the current element's size */
+        /**
+         * Flag indicating whether the width and height of any maximized child element will be constrained to the current size of the row.
+         */
         maximizationBoundary?: boolean;
 
         /**
-         * Locks the row using a provided config object, which restricts various modification functionalities of the row
-         * @param config This can be either an object or a function. When the object is provided, it overrides all other lock properties. When a function is provided, it will be called with the current lock settings and it should return a lock config, which will override the current settings. The function is recommended in all cases where overriding of the settings is not desired.
+         * Locks the row in order to restrict the ability of the user to modify it.
+         * If no lock settings are provided, all lock properties will be set to `false`.
+         * @param config Object or function for setting the lock properties. If an object is provided, it will override all current lock settings.
+         * If a function is provided, it will be invoked with the current lock settings as an argument and must return an object with lock settings that will override the current ones.
+         * Using a function is recommended when you don't want to override all current lock settings.
          */
         lock(config?: RowLockConfig | ((config: RowLockConfig) => RowLockConfig)): Promise<void>;
 
         /**
-         * Sets a new height for the row
-         * @param height A required number which should be the new height of the row
+         * Sets the height of the row.
+         * @param height Height in pixels for the row.
          */
         setHeight(height: number): Promise<void>;
 
         /**
-        * Changes whether the row is a maximizationBoundary
-        * @param config Object which specifies how the maximizationBoundary behavior should be changed
-        */
-        setMaximizationBoundary(config: SetMaximizationBoundaryConfig): Promise<void>
+         * Sets whether the row will act as a maximization boundary.
+         * If enabled, the width and height of any maximized child element will be constrained to the current size of the row.
+         * @param config Settings for the maximization boundary.
+         */
+        setMaximizationBoundary(config: SetMaximizationBoundaryConfig): Promise<void>;
 
         /**
-         * Notifies when the a change in the lock configuration of the row has been made
-         * @param callback Callback function to handle the event. Receives the new lock configuration as a parameter
+         * Notifies when the lock settings of the row have changed. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the new lock settings.
          */
         onLockConfigurationChanged(callback: (config: IOConnectWorkspaces.RowLockConfig) => void): Promise<IOConnectWorkspaces.Unsubscribe>
     }
 
-    /** An object describing a column type workspace box */
+    /**
+     * Describes a Workspace column.
+     */
     export interface Column extends Box {
+        /**
+         * Type of the box element.
+         */
         type: "column";
 
-        /** Indicates if dragging of splitters is allowed in the column */
+        /**
+         * Flag indicating whether the user can resize the column by dragging the splitters.
+         */
         allowSplitters?: boolean;
 
-        /** Indicates whether or not the column is pinned */
+        /**
+         * Flag indicating whether the column is pinned.
+         */
         isPinned?: boolean;
 
-        /** If set to true any child that is maximized will have its width and height constricted to the current element's size */
+        /**
+         * Flag indicating whether the width and height of any maximized child element will be constrained to the current size of the column.
+         */
         maximizationBoundary?: boolean;
 
         /**
-         * Locks the column using a provided config object, which restricts various modification functionalities of the column
-         * @param config This can be either an object or a function. When the object is provided, it overrides all other lock properties. When a function is provided, it will be called with the current lock settings and it should return a lock config, which will override the current settings. The function is recommended in all cases where overriding of the settings is not desired.
+         * Locks the column in order to restrict the ability of the user to modify it.
+         * If no lock settings are provided, all lock properties will be set to `false`.
+         * @param config Object or function for setting the lock properties. If an object is provided, it will override all current lock settings.
+         * If a function is provided, it will be invoked with the current lock settings as an argument and must return an object with lock settings that will override the current ones.
+         * Using a function is recommended when you don't want to override all current lock settings.
          */
         lock(config?: ColumnLockConfig | ((config: ColumnLockConfig) => ColumnLockConfig)): Promise<void>;
 
         /**
-         * Sets a new width for the column
-         * @param width A required number which should be the new width of the column
+         * Sets the width of the column.
+         * @param width Width in pixels for the column.
          */
         setWidth(width: number): Promise<void>;
 
         /**
-         * Changes whether the column is a maximizationBoundary
-         * @param config Object which specifies how the maximizationBoundary behavior should be changed
+         * Sets whether the column will act as a maximization boundary.
+         * If enabled, the width and height of any maximized child element will be constrained to the current size of the column.
+         * @param config Settings for the maximization boundary.
          */
-        setMaximizationBoundary(config: SetMaximizationBoundaryConfig): Promise<void>
+        setMaximizationBoundary(config: SetMaximizationBoundaryConfig): Promise<void>;
 
         /**
-         * Notifies when the a change in the lock configuration of the column has been made
-         * @param callback Callback function to handle the event. Receives the new lock configuration as a parameter
+         * Notifies when the lock settings of the column have changed. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the new lock settings.
          */
         onLockConfigurationChanged(callback: (config: IOConnectWorkspaces.ColumnLockConfig) => void): Promise<IOConnectWorkspaces.Unsubscribe>
     }
 
-    /** An object describing a group type workspace box */
+    /**
+     * Describes a window group in a Workspace.
+     */
     export interface Group extends Box {
+        /**
+         * Type of the box element.
+         */
         type: "group";
 
-        /** Controls the users ability to extract windows from the group */
+        /**
+         * Flag indicating whether the user can extract windows from the window group.
+         */
         allowExtract?: boolean;
 
-        /** Controls the users ability to reorder windows in the group */
+        /**
+         * Flag indicating whether the user can reorder the windows in the window group.
+         */
         allowReorder?: boolean;
 
-        /** Controls the users ability to drop windows in the left zone of the group */
+        /**
+         * Flag indicating whether the user can add windows by dropping them in the leftmost area of the window group.
+         */
         allowDropLeft?: boolean;
 
-        /** Controls the users ability to drop windows in the right zone of the group */
+        /**
+         * Flag indicating whether the user can add windows by dropping them in the rightmost area of the window group.
+         */
         allowDropRight?: boolean;
 
-        /** Controls the users ability to drop windows in the top zone of the group */
+        /**
+         * Flag indicating whether the user can add windows by dropping them in the topmost area of the window group.
+         */
         allowDropTop?: boolean;
 
-        /** Controls the users ability to drop windows in the bottom zone of the group */
+        /**
+         * Flag indicating whether the user can add windows by dropping them in the bottommost area of the window group.
+         */
         allowDropBottom?: boolean;
 
-        /** Controls the users ability to drop windows in header zone of the group */
+        /**
+         * Flag indicating whether the user can add windows by dropping them in the header area of the window group.
+         */
         allowDropHeader?: boolean;
 
-        /** Controls the visibility of the maximize/restore button located in the group header */
+        /**
+         * Flag indicating whether the "Maximize" button in the header of the window group is visible.
+         */
         showMaximizeButton?: boolean;
 
-        /** Controls the visibility of the eject button located in the group header */
+        /**
+         * Flag indicating whether the "Eject" button in the header of the window group is visible.
+         */
         showEjectButton?: boolean;
 
-        /** Controls the visibility of the add window buttons (the ones with the plus icon) located in the group header */
+        /**
+         * Flag indicating whether the "Add Window" button (the "+" button) in the header of the window group is visible.
+         */
         showAddWindowButton?: boolean;
 
         /**
-         * Locks the group using a provided config object, which restricts various modification functionalities of the group
-         * @param config This can be either an object or a function. When the object is provided, it overrides all other lock properties. When a function is provided, it will be called with the current lock settings and it should return a lock config, which will override the current settings. The function is recommended in all cases where overriding of the settings is not desired.
+         * Locks the window group in order to restrict the ability of the user to modify it.
+         * If no lock settings are provided, all lock properties will be set to `false`.
+         * @param config Object or function for setting the lock properties. If an object is provided, it will override all current lock settings.
+         * If a function is provided, it will be invoked with the current lock settings as an argument and must return an object with lock settings that will override the current ones.
+         * Using a function is recommended when you don't want to override all current lock settings.
          */
         lock(config?: GroupLockConfig | ((config: GroupLockConfig) => GroupLockConfig)): Promise<void>;
 
         /**
-         * Sets a new size for the group
-         * @param sizeConfig A config object which should be the new size of the group.
+         * Sets the size of the window group.
+         * @param sizeConfig Size for the window group.
          */
         setSize(sizeConfig: ElementResizeConfig): Promise<void>;
 
         /**
-         * Changes the parent of the group to a new column that is added in the place of the group
+         * Changes the parent of the window group to a new column that will be added in place of the window group.
          */
         bundleToColumn(): Promise<void>;
 
         /**
-         * Changes the parent of the group to a new row that is added in the place of the group
+         * Changes the parent of the window group to a new row that will be added in place of the window group.
          */
         bundleToRow(): Promise<void>;
 
         /**
-         * Notifies when a change in the lock configuration of the group has been made
-         * @param  callback Callback function to handle the event. Receives the new lock configuration as a parameter
+         * Notifies when the lock settings of the window group have changed. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the new lock settings.
          */
         onLockConfigurationChanged(callback: (config: IOConnectWorkspaces.GroupLockConfig) => void): Promise<IOConnectWorkspaces.Unsubscribe>
     }
 
-    /** An object describing the basic details of a workspace window */
+    /**
+     * Describes the basic details of a Workspace window.
+     */
     export interface WorkspaceWindowSummary {
-        /** An unique string identifier of the window */
+        /**
+         * Unique ID of the window.
+         */
         id: string | undefined;
 
-        /** An unique string identifier of the workspace element that hosts the window */
+        /**
+         * Unique ID of the Workspace element hosting the window.
+         */
         elementId: string;
 
-        /** The type of the workspace element */
+        /**
+         * Type of the Workspace element.
+         */
         type: "window";
 
-        /** The string id of the frame containing this window */
+        /**
+         * ID of the `Frame` instance containing the window.
+         */
         frameId: string;
 
-        /** The application name of the window if it was registered as an application */
+        /**
+         * Name of the app, if the window is defined as an app.
+         */
         appName: string;
 
-        /** The string id of the workspace containing this window */
+        /**
+         * ID of the Workspace containing the window.
+         */
         workspaceId: string;
 
-        /** The position of this window regarding it's siblings */
+        /**
+         * Position of the window relative to its sibling elements.
+         */
         positionIndex: number;
 
-        /** A flag showing whether or not the window is maximized within it's box */
+        /**
+         * Flag indicating whether the window is maximized within its parent element.
+         */
         isMaximized: boolean;
 
-        /** A flag showing whether or not the window is selected */
+        /**
+         * Flag indicating whether the window is selected.
+         */
         isSelected: boolean;
 
-        /** A flag showing whether or not the window's content is loaded */
+        /**
+         * Flag indicating whether the contents of the window have been loaded.
+         */
         isLoaded: boolean;
 
-        /** A flag showing whether or not the window has focus */
+        /**
+         * Flag indicating whether the window is on focus.
+         */
         focused: boolean;
 
-        /** The title of the window */
+        /**
+         * Title of the window.
+         */
         title: string;
 
-        /** Show whether or not the user can extract the specified window */
+        /**
+         * Flag indicating whether the user can extract the window from the Workspace.
+         */
         allowExtract?: boolean;
 
-        /** Show whether or not the user can reorder the specified window */
+        /**
+         * Flag indicating whether the user can reorder the window in the window group.
+         */
         allowReorder?: boolean;
 
-        /** Indicates whether the close button which is located in the window's tab is visible */
+        /**
+         * Flag indicating whether the "Close" button in the window tab is visible.
+         */
         showCloseButton?: boolean;
 
-        /** Indicates the current width of the window */
+        /**
+         * Width in pixels of the window.
+         */
         width?: number;
 
-        /** Indicates the current height of the window */
+        /**
+         * Height in pixels of the window.
+         */
         height?: number;
 
-        /** Indicates the configured minimum width of the window */
+        /**
+         * Minimum width in pixels of the window.
+         */
         minWidth?: number;
 
-        /** Indicates the configured height width of the window */
+        /**
+         * Minimum height in pixels of the window.
+         */
         minHeight?: number;
 
-        /** Indicates the configured maximum width of the window */
+        /**
+         * Maximum width in pixels of the window.
+         */
         maxWidth?: number;
 
-        /** Indicates the configured maximum height of the window */
+        /**
+         * Maximum height in pixels of the window.
+         */
         maxHeight?: number;
     }
 
-    /** An object describing a window part of an existing workspace */
+    /**
+     * Describes a window in a Workspace.
+     */
     export interface WorkspaceWindow extends WorkspaceWindowSummary {
 
-        /** An object representing the workspace, which contains this window */
+        /**
+         * Workspace containing the window.
+         */
         workspace: Workspace;
 
-        /** An object representing the frame, which contains this window */
+        /**
+         * `Frame` instance containing the window.
+         */
         frame: Frame;
 
-        /** An object representing the parent box, which contains this window */
+        /**
+         * Parent of the window - a Workspace or a box element.
+         */
         parent: Workspace | WorkspaceBox;
 
         /**
-         * Forces a window, which was added to the workspace to load it's contents.
+         * Forces the window to load its contents. Use for windows that have been added to the Workspace, but whose contents haven't been loaded yet.
          */
         forceLoad(): Promise<void>;
 
         /**
-         * Gives focus to the window.
+         * Focuses the window.
          */
         focus(): Promise<void>;
 
         /**
-         * Closes the workspace window.
+         * Closes the window.
          */
         close(): Promise<void>;
 
         /**
-         * Sets a new title to the workspace window.
-         * @param title The new title for the window.
+         * Sets the title of the window.
+         * @param title Title for the window.
          */
         setTitle(title: string): Promise<void>;
 
         /**
-         * Maximizes the workspace window relative to it's parent box.
+         * Maximizes the window within the bounds of the Workspace, or within the nearest parent element set as a maximization boundary.
          */
         maximize(): Promise<void>;
 
         /**
-         * Restores a previously maximized workspace window.
+         * Restores the window if it has been previously maximized.
          */
         restore(): Promise<void>;
 
         /**
-         * Removes a workspace window from the workspace and turns it into a standalone window.
+         * Removes the window from the Workspace and turns it into a standalone window.
          */
         eject(): Promise<any>;
 
         /**
-         * Returns the underlying GDWindow (Enterprise) or WebWindow (Core) of the workspace window.
+         * Retrieves the underlying io.Connect Window object of the Workspace window -
+         * a `IOConnectWindow` object in **io.Connect Desktop**, or a `WebWindow` object in **io.Connect Browser**.
          */
         getGdWindow(): any;
 
         /**
-         * Moves the workspace window to a new box. In **io.Connect Browser** this box must be part of the same frame.
-         * @param box An object describing the new box of the window.
+         * Moves the window to another box element. In **io.Connect Browser**, the box element must be part of the same `Frame` instance.
+         * @param box Box element in which the window will be placed.
          */
         moveTo(box: WorkspaceBox): Promise<void>;
 
         /**
-         * Sets a new size for the window
-         * @param sizeConfig A config object which should be the new size of the window.
+         * Sets the size of the window.
+         * @param sizeConfig Size for the window.
          */
         setSize(sizeConfig: ElementResizeConfig): Promise<void>;
 
         /**
-         * Locks the window using a provided config object, which restricts various modification functionalities of the window
-         * @param config This can be either an object or a function. When the object is provided, it overrides all other lock properties. When a function is provided, it will be called with the current lock settings and it should return a lock config, which will override the current settings. The function is recommended in all cases where overriding of the settings is not desired.
+         * Locks the window in order to restrict the ability of the user to modify it.
+         * If no lock settings are provided, all lock properties will be set to `false`.
+         * @param config Object or function for setting the lock properties. If an object is provided, it will override all current lock settings.
+         * If a function is provided, it will be invoked with the current lock settings as an argument and must return an object with lock settings that will override the current ones.
+         * Using a function is recommended when you don't want to override all current lock settings.
          */
         lock(config?: IOConnectWorkspaces.WorkspaceWindowLockConfig | ((config: IOConnectWorkspaces.WorkspaceWindowLockConfig) => IOConnectWorkspaces.WorkspaceWindowLockConfig)): Promise<void>;
 
         /**
-         * Notifies when this window was removed from the workspace.
-         * @param callback Callback function to handle the event.
+         * Notifies when the window has been removed from the Workspace. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event.
          */
         onRemoved(callback: () => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a change in the lock configuration of the workspace window has been made
-         * @param callback Callback function to handle the event. Receives the new lock configuration as a parameter
+         * Notifies when the lock settings of the window have changed. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the new lock settings.
          */
         onLockConfigurationChanged(callback: (config: IOConnectWorkspaces.WorkspaceWindowLockConfig) => void): Promise<IOConnectWorkspaces.Unsubscribe>
 
@@ -2266,94 +3027,114 @@ export namespace IOConnectWorkspaces {
         onTabReordered(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe>;
     }
 
-    /** An object describing a builder user to create workspaces */
+    /**
+     * Describes a builder for creating Workspaces.
+     */
     export interface WorkspaceBuilder {
         /**
-         * Adds a new row to the calling workspace. Returns the new row.
-         * @param config An object describing the type of the requested builder, alongside other settings.
+         * Adds a new row to the Workspace. Returns a builder for the new row.
+         * @param definition Definition for the row.
          */
         addRow(definition?: BoxDefinition): BoxBuilder;
 
         /**
-         * Adds a new column to the calling workspace. Returns the new column.
-         * @param config An object describing the type of the requested builder, alongside other settings.
+         * Adds a new column to the Workspace. Returns a builder for the new column.
+         * @param definition Definition for the column.
          */
         addColumn(definition?: BoxDefinition): BoxBuilder;
 
         /**
-         * Adds a new group to the calling workspace. Returns the new group.
-         * @param config An object describing the type of the requested builder, alongside other settings.
+         * Adds a new window group to the Workspace. Returns a builder for the new window group.
+         * @param definition Definition for the window group.
          */
         addGroup(definition?: BoxDefinition): BoxBuilder;
 
         /**
-         * Adds a new window to the calling workspace. Returns the calling workspace.
-         * @param config An object describing the requested window.
+         * Adds a new window to the Workspace. Returns the Workspace builder.
+         * @param definition Definition for the window.
          */
         addWindow(definition: WorkspaceWindowDefinition): WorkspaceBuilder;
 
         /**
-         * Creates a new workspace using the builder as a blueprint for structure and contents.
-         * @param config An object containing workspace creating options.
+         * Creates a new Workspace using the builder as a blueprint for its structure and contents.
+         * @param config Settings for creating the Workspace.
          */
         create(config?: WorkspaceCreateConfig): Promise<Workspace>;
     }
 
-    /** An object describing a builder used to create workspace boxes */
+    /**
+     * Describes a builder for creating box elements.
+     */
     export interface BoxBuilder {
         /**
-         * Adds a new row to the calling box. Returns the new row.
-         * @param config An object describing the type of the requested builder, alongside other settings.
+         * Adds a new row to the box element. Returns a builder for the new row.
+         * @param definition Definition for the row.
          */
         addRow(definition?: BoxDefinition): BoxBuilder;
 
         /**
-         * Adds a new column to the calling box. Returns the new column.
-         * @param config An object describing the type of the requested builder, alongside other settings.
+         * Adds a new column to the box element. Returns a builder for the new column.
+         * @param definition Definition for the column.
          */
         addColumn(definition?: BoxDefinition): BoxBuilder;
 
         /**
-         * Adds a new group to the calling box. Returns the new group.
-         * @param config An object describing the type of the requested builder, alongside other settings.
+         * Adds a new window group to the box element. Returns a builder for the new window group.
+         * @param definition Definition for the window group.
          */
         addGroup(definition?: BoxDefinition): BoxBuilder;
 
         /**
-         * Adds a new window to the calling box. Returns the immediate parent box of the window.
-         * @param config An object describing the requested window.
+         * Adds a new window to the box element. Returns the builder for the box element.
+         * @param definition Definition for the window.
          */
         addWindow(definition: WorkspaceWindowDefinition): BoxBuilder;
 
         /**
-         * Returns the JSON object which describes the full structure of the box.
+         * Returns an object describing the full structure of the box element.
          */
         serialize(): BoxDefinition;
     }
 
-    /** A configuration object used to save a current workspace as a layout */
+    /**
+     * Options for saving a Workspace as a Workspace Layout.
+     */
     export interface WorkspaceLayoutSaveConfig {
+        /**
+         * ID for the Workspace Layout.
+         * *Available only in **io.Connect Desktop**.*
+         * @since io.Connect Desktop 10.5
+         * @since @interopio/workspaces-api 5.0.0
+         */
         id?: string;
+
         /**
-         * A string used as name (doubles as id) of the layout, which is later used when restoring it.
+         * Name for the Workspace Layout.
          */
         name: string;
 
         /**
-         * A string representing the id of the workspace whose structure should be saved into a layout.
+         * ID of the Workspace whose structure will be saved as a Workspace Layout.
          */
         workspaceId: string;
 
-        /** Toggles whether or not the current workspace context should be saved in the layout */
+        /**
+         * If `true`, the current Workspace context will be saved in the Workspace Layout.
+         */
         saveContext?: boolean;
 
         /**
          * If `true`, will allow opening multiple instances of the same Workspace simultaneously.
          * @default true
+         * @since io.Connect Desktop 9.8
+         * @since io.Connect Browser 3.5
+         * @since @interopio/workspaces-api 3.5.5
          */
         allowMultiple?: boolean;
 
-        /** Object which will be saved as part of the layout */
+        /**
+         * Metadata that will be saved as part of the Workspace Layout.
+         */
         metadata?: object;
 
         /**
@@ -2365,59 +3146,108 @@ export namespace IOConnectWorkspaces {
          * *Available only in **io.Connect Browser**.*
          * @default false
          * @since io.Connect Browser 4.4
+         * @since @interopio/workspaces-api 4.4
          */
         saveWindowContexts?: boolean;
     }
 
-    /** A configuration object used to overwrite an existing workspace layout, identified by its id */
+    /**
+     * Options for saving a Workspace as a Workspace Layout by ID.
+     * When Layout sharing is enabled, each Workspace Layout has a unique ID and Workspace Layout names aren't guaranteed to be unique.
+     * *Available only in **io.Connect Desktop**.*
+     * @since io.Connect Desktop 10.5
+     * @since @interopio/workspaces-api 5.0.0
+     */
     export interface WorkspaceLayoutSaveByIdConfig extends WorkspaceLayoutSaveConfig {
         /**
-         * The id of the layout to overwrite.
+         * Uniques ID of an existing Workspace Layout to be overwritten with the structure of the current Workspace.
+         * The Workspace Layout with the specified ID must exist, otherwise the operation will fail.
          */
         id?: string;
     }
 
+    /**
+     * Settings for the maximization boundary of a box element.
+     */
     export interface SetMaximizationBoundaryConfig {
         /**
-         * Represents the new value of the maximizationBoundary property
+         * If `true`, the box element will act as a maximization boundary.
          */
         enabled: boolean;
     }
 
-    /** An object describing the complete state of a frame at the time when the object was created */
+    /**
+     * Describes the state of a `Frame` instance at the time of taking the snapshot.
+     */
     export interface FrameSnapshot {
         /**
-         * A string identifier unique to each frame
+         * Unique ID of the `Frame` instance.
          */
         id: string;
 
+        /**
+         * Array of objects, each describing the state of a Workspace in the `Frame` instance.
+         */
         workspaces: WorkspaceSnapshot[];
 
+        /**
+         * Settings of the `Frame` instance.
+         */
         config: any;
     }
 
     /**
-     * Describes the data passed to the callback for handling the event which fires when a Frame is about to be closed.
+     * Describes the data passed to the callback for handling the event which fires when a `Frame` instance is about to be closed.
      */
     export interface FrameClosingData {
         /**
-         * Function that can be used to prevent closing a Frame.
+         * Function that can be used to prevent closing a `Frame` instance.
          */
         prevent: () => void;
     }
 
+    /**
+     * Describes the data passed to the callback for handling the event which fires when a `Frame` instance has been closed.
+     */
     export interface FrameClosedData {
+        /**
+         * ID of the closed `Frame` instance.
+         */
         frameId: string;
+
+        /**
+         * Bounds of the closed `Frame` instance.
+         */
         frameBounds?: FrameBounds;
     }
 
+    /**
+     * Describes the data passed to the callback for handling the event which fires when the `Frame` instance or a window in it has gained or lost focus.
+     */
     export interface FrameFocusChangedData {
+        /**
+         * Flag indicating whether the `Frame` instance is on focus.
+         */
         isFocused: boolean;
     }
 
+    /**
+     * Describes the data passed to the callback for handling the event which fires when a Workspace has been closed.
+     */
     export interface WorkspaceClosedData {
+        /**
+         * ID of the `Frame` instance that contained the closed Workspace.
+         */
         frameId: string;
+
+        /**
+         * ID of the closed Workspace.
+         */
         workspaceId: string;
+
+        /**
+         * Bounds of the `Frame` instance that contained the closed Workspace.
+         */
         frameBounds?: FrameBounds;
     }
 
@@ -2431,224 +3261,237 @@ export namespace IOConnectWorkspaces {
         base64Image: string;
     }
 
-    /** An object describing the complete state of a workspace at the time when the object was created */
+    /**
+     * Describes the state of a Workspace at the time of taking the snapshot.
+     */
     export interface WorkspaceSnapshot extends WorkspaceLayoutComponentState {
         /**
-         * A string identifier unique to each workspace
+         * Unique ID of the Workspace.
          */
         id: string;
     }
 
-    /** An API enabling basic CRUD workspaces actions */
+    /**
+     * Workspaces Layouts API for saving, deleting, exporting, and importing Workspace Layouts.
+     */
     export interface WorkspaceLayoutsAPI {
         /**
-         * Returns a collection of summarized layouts data. This data contains all the standard data excluding the actual structure of the layout.
-         * This is helpful in cases where a simple query of existing layouts is needed without the complexity of transmitting the full layouts structure.
+         * Retrieves the summaries of all Workspace Layouts without the extensive data describing their structure.
          */
         getSummaries(): Promise<WorkspaceLayoutSummary[]>;
 
         /**
-         * Deletes a previously saved layout. In **io.Connect Browser** delete will fail with an error in trying to delete a read-only layout, this is a layout defined in the io.layouts.json file.
-         * @param name The name of the layout to delete.
+         * Deletes a Workspace Layout. In **io.Connect Browser**, the operation will fail if you try to delete a read-only Workspace Layout.
+         * @param name Name of the Workspace Layout to delete.
          */
         delete(name: string): Promise<void>;
 
         /**
-         * Deletes a previously saved layout by its id.
-         * @param layoutId The id of the layout to delete.
+         * Deletes a Workspace Layout by its unique ID.
+         * Use this method instead of `delete()` when Layout sharing is enabled and Workspace Layout names aren't guaranteed to be unique.
+         * *Available only in **io.Connect Desktop**.*
+         * @param layoutId Unique ID of the Workspace Layout to delete.
+         * @since io.Connect Desktop 10.5
+         * @since @interopio/workspaces-api 5.0.0
          */
         deleteById(layoutId: string): Promise<void>;
 
         /**
-         * Returns all layouts which satisfy the predicate. This collection of all saved layouts includes the layouts structure. If no predicate is provided, it returns all saved layouts.
-         * @param predicate A filtering function (predicate) called for each saved layout.
+         * Retrieves all Workspace Layouts, including their structure, that satisfy the provided predicate.
+         * If no predicate is provided, will return all Workspace Layouts.
+         * @param predicate Filtering function (predicate) that will be invoked for each Workspace Layout.
          */
         export(predicate?: (layout: WorkspaceLayout) => boolean): Promise<WorkspaceLayout[]>;
 
         /**
-         * Saves the provided layouts into io.Connect. In **io.Connect Browser** this will fail with an error if a provided layout's name matches a read-only layout.
-         * @param layouts A collection of layouts to add to IO Connet.
+         * Imports one or more Workspace Layouts. In **io.Connect Browser**, the operation will fail if the name of an imported Workspace Layout
+         * matches the name of a read-only Workspace Layout.
+         * @param layouts Array of Workspace Layouts to import.
+         * @param mode Mode for importing the Workspace Layouts. Use `"replace"` to remove all existing Workspace Layouts and replace them
+         * with the imported ones, or `"merge"` to merge the imported Workspace Layouts with the existing ones.
          */
         import(layouts: WorkspaceLayout[], mode?: "replace" | "merge"): Promise<void>;
 
         /**
-         * Saves an existing, open workspace as a layout.
-         * @param config An object describing the name of the layout and the id of the workspace, whose structure will be saved.
+         * Saves an open Workspace as a Workspace Layout.
+         * @param config Options for saving the Workspace Layout.
          */
         save(config: WorkspaceLayoutSaveConfig): Promise<WorkspaceLayout>;
 
         /**
-         * Overwrites the layout with the specified id with the structure of an existing, open workspace.
-         * Prefer this over `save()` when layout names aren't guaranteed to be unique (e.g. when layout sharing is enabled).
-         * @param config An object describing the id of the layout to overwrite, the layout name and the id of the workspace, whose structure will be saved.
+         * Saves an open Workspace as a Workspace Layout.
+         * Use this method instead of `save()` when Layout sharing is enabled and Workspace Layout names aren't guaranteed to be unique.
+         * *Available only in **io.Connect Desktop**.*
+         * @param config Options for saving the Workspace Layout.
+         * @since io.Connect Desktop 10.5
+         * @since @interopio/workspaces-api 5.0.0
          */
         saveById(config: WorkspaceLayoutSaveByIdConfig): Promise<WorkspaceLayout>;
 
         /**
-         * Notifies when a layouts has been saved. This event is fired when a new layout has been saved and an existing layout has been updated.
-         * @param callback Callback function to handle the event. Receives the saved layout as a parameter.
+         * Notifies when a Workspace Layout has been saved. Returns an unsubscribe function.
+         * The event will fire both when a new Workspace Layout has been saved and when an existing one has been updated.
+         * @param callback Callback function for handling the event. Receives as an argument the saved Workspace Layout.
          */
         onSaved(callback: (layout: WorkspaceLayout) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a layouts has been removed.
-         * @param callback Callback function to handle the event. Receives the removed layout as a parameter.
+         * Notifies when a Workspace Layout has been removed. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the removed Workspace Layout.
          */
         onRemoved(callback: (layout: WorkspaceLayout) => void): Promise<Unsubscribe>;
     }
 
     /**
+     * Workspaces API.
      * @docmenuorder 1
      */
     export interface API {
         /**
-         * Checks whether or not the calling window is currently present inside of a workspace
+         * Checks whether the current window is in a Workspace.
          */
         inWorkspace(): Promise<boolean>;
 
         /**
-         * Gets either a workspace or a box builder depending on the provided type inside the config object.
-         * This builder is used to dynamically construct a workspace runtime.
-         * @param config An object describing the type of the requested builder, alongside other settings.
+         * Retrieves a builder for creating a Workspace or a box element, depending on the type specified in the provided options.
+         * @param config Options for the builder.
          */
         getBuilder(config: BuilderConfig): WorkspaceBuilder | BoxBuilder;
 
         /**
-         * Returns the frame instance of the calling window. Throws an error if the calling window is not part of a workspace.
+         * Retrieves the `Frame` instance of the current window. Will throw an error if the current window isn't part of a Workspace.
          */
         getMyFrame(): Promise<Frame>;
 
         /**
-         * Returns the first frame instance which satisfies the provided predicate or undefined, if non do.
-         * @param predicate A filtering function (predicate) called for each open frame.
+         * Retrieves the first `Frame` instance that satisfies the provided predicate, or `undefined` if none does.
+         * @param predicate Filtering function (predicate) that will be invoked for each open `Frame` instance.
          */
-        getFrame(predicate: (frame: Frame) => boolean): Promise<Frame>;
+        getFrame(predicate: (frame: Frame) => boolean): Promise<Frame | undefined>;
 
         /**
-         * Returns all frames which satisfy the provided predicate. If no predicate is provided, will return all frames.
-         * @param predicate A filtering function (predicate) called for each open frame.
+         * Retrieves all `Frame` instances that satisfy the provided predicate. If no predicate is provided, will return all `Frame` instances.
+         * @param predicate Filtering function (predicate) that will be invoked for each open `Frame` instance.
          */
         getAllFrames(predicate?: (frame: Frame) => boolean): Promise<Frame[]>;
 
         /**
-         * Returns an collection of objects, where each object contains basic information about an open workspace.
-         * This function was designed for easy and quick listing of existing workspaces without adding the complexity of transmitting the entire structure of each workspace.
+         * Retrieves the summaries of all open Workspaces without the extensive data describing their structure.
          */
         getAllWorkspacesSummaries(): Promise<WorkspaceSummary[]>;
 
         /**
-         * Returns the instance of the workspace where the calling window is located.
-         * Throws an error if the calling window is not not part of any workspace.
+         * Retrieves the Workspace of the current window. Will throw an error if the current window isn't part of a Workspace.
          */
         getMyWorkspace(): Promise<Workspace>;
 
         /**
-         * Returns the first workspace instance which satisfies the provided predicate or undefined, if non do.
-         * @param predicate A filtering function (predicate) called for each open workspace.
+         * Retrieves the first Workspace that satisfies the provided predicate, or `undefined` if none does.
+         * @param predicate Filtering function (predicate) that will be invoked for each open Workspace.
          */
-        getWorkspace(predicate: (workspace: Workspace) => boolean): Promise<Workspace>;
+        getWorkspace(predicate: (workspace: Workspace) => boolean): Promise<Workspace | undefined>;
 
         /**
-         * Returns an instance of the workspace with the passed id. The performance is better than getWorkspace when querying for a workspace by id.
-         * @param workspaceId The id of the desired workspace
+         * Retrieves a Workspace by its ID. Performs better than `getWorkspace()` when searching for a Workspace by ID.
+         * @param workspaceId ID of the Workspace to retrieve.
          */
         getWorkspaceById(workspaceId: string): Promise<Workspace>;
 
         /**
-         * Returns all workspaces which satisfy the provided predicate. If no predicate is provided, will return all workspaces.
-         * @param predicate A filtering function (predicate) called for each open workspace.
+         * Retrieves all Workspaces that satisfy the provided predicate. If no predicate is provided, will return all Workspaces.
+         * @param predicate Filtering function (predicate) that will be invoked for each open Workspace.
          */
         getAllWorkspaces(predicate?: (workspace: Workspace) => boolean): Promise<Workspace[]>;
 
         /**
-         * Returns the workspace window instance of the first window, which is part of a workspace and satisfies the provided predicate.
-         * This function will search recursively in all open workspaces.
-         * @param predicate A filtering function (predicate) called for each window in each open workspace.
+         * Retrieves the first Workspace window that satisfies the provided predicate. Will search recursively in all open Workspaces.
+         * @param predicate Filtering function (predicate) that will be invoked for each window in each open Workspace.
          */
-        getWindow(predicate: (workspaceWindow: WorkspaceWindow) => boolean): Promise<WorkspaceWindow>;
+        getWindow(predicate: (workspaceWindow: WorkspaceWindow) => boolean): Promise<WorkspaceWindow | undefined>;
 
         /**
-         * Returns the instance of the first box, which satisfies the provided predicate.
-         * This function will search recursively in all open workspaces.
-         * @param predicate A filtering function (predicate) called for each box in each open workspace.
+         * Retrieves the first box element that satisfies the provided predicate. Will search recursively in all open Workspaces.
+         * @param predicate Filtering function (predicate) that will be invoked for each box element in each open Workspace.
          */
-        getBox(predicate: (box: WorkspaceBox) => boolean): Promise<WorkspaceBox>;
+        getBox(predicate: (box: WorkspaceBox) => boolean): Promise<WorkspaceBox | undefined>;
 
         /**
-         * Opens a new workspace by restoring a previously saved workspace layout.
-         * @param name The name of a saved workspace layout, which will be restored.
-         * @param options An optional object containing various workspace restore options.
+         * Restores a Workspace from a previously saved Workspace Layout.
+         * @param name Name of the Workspace Layout to restore.
+         * @param options Options for restoring the Workspace.
          */
         restoreWorkspace(name: string, options?: RestoreWorkspaceConfig): Promise<Workspace>;
 
         /**
-         * Opens a new workspace by restoring a previously saved workspace layout by its id.
-         * @param options An object containing the id of the layout to restore and various workspace restore options.
+         * Restores a Workspace from a previously saved Workspace Layout by the unique ID of the Layout.
+         * Use this method instead of `restoreWorkspace()` when Layout sharing is enabled and Workspace Layout names aren't guaranteed to be unique.
+         * *Available only in **io.Connect Desktop**.*
+         * @param options Options for restoring the Workspace.
+         * @since io.Connect Desktop 10.5
+         * @since @interopio/workspaces-api 5.0.0
          */
         restoreWorkspaceById(options: RestoreWorkspaceByIdConfig): Promise<Workspace>;
 
         /**
-         * Opens a new workspace based on the provided definition.
-         * @param definition An object describing the shape and options of the workspace.
-         * @param saveConfig An object used to set various create options.
+         * Creates a new Workspace based on the provided definition.
+         * @param definition Definition for the Workspace.
+         * @param saveConfig Settings for creating the Workspace.
          */
         createWorkspace(definition: WorkspaceDefinition, saveConfig?: WorkspaceCreateConfig): Promise<Workspace>;
 
         /**
-         *
-         * @param definition Optional definition of the frame
+         * Creates an empty `Frame` instance with no Workspaces in it.
+         * @param definition Definition for the empty `Frame` instance.
          */
         createEmptyFrame(definition?: EmptyFrameDefinition): Promise<IOConnectWorkspaces.Frame>;
 
         /**
-         * Wait for a frame with the specified id to be loaded.
-         * It's needed when using the workspaces-api from a custom workspaces frame and you have the frameId,
-         * but the frame object is not populated in the API yet (e.g. the frame is in the pool)
-         * @param id the id of the frame that should be waited
+         * Waits for the `Frame` instance with the specified ID to be loaded.
+         * Use this method in a custom Workspaces App when you have the ID of the `Frame` instance, but the `Frame` instance isn't available in the API yet
+         * (e.g., when the `Frame` instance is in the pool).
+         * @param id ID of the `Frame` instance.
          */
         waitForFrame(id: string): Promise<Frame>;
 
         /**
-         * An API which gives full read, write and delete access to the workspaces layouts.
+         * Workspaces Layouts API for saving, deleting, exporting, and importing Workspace Layouts.
          */
         layouts: WorkspaceLayoutsAPI;
 
         /**
-         * Notifies when a new frame was opened and returns an unsubscribe function.
-         * @param callback Callback function to handle the event. Receives the added frame as a parameter.
+         * Notifies when a new `Frame` instance has been opened. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the opened `Frame` instance.
          */
         onFrameOpened(callback: (frame: Frame) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a new frame was closed and returns an unsubscribe function.
-         * @param callback Callback function to handle the event. Receives an object containing the id of the closed frame as a parameter.
+         * Notifies when a `Frame` instance has been closed. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument an object describing the closed `Frame` instance.
          */
         onFrameClosed(callback: (closed: FrameClosedData) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a new workspace was opened in any of the opened frames and returns an unsubscribe function.
-         * @param callback Callback function to handle the event. Receives the added workspace as a parameter.
+         * Notifies when a new Workspace has been opened in any `Frame` instance. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the `Workspace` object describing the opened Workspace.
          */
         onWorkspaceOpened(callback: (workspace: Workspace) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a workspace present in any of the opened frames was closed and returns an unsubscribe function.
-         * @param callback Callback function to handle the event. Receives an object with the closed workspace id and frame id as a parameter.
+         * Notifies when a Workspace in any `Frame` instance has been closed. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument an object describing the closed Workspace.
          */
         onWorkspaceClosed(callback: (closed: WorkspaceClosedData) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a Workspace is hibernated.
-         * This event will be fired for any Workspace hibernated in any currently running instance of a Workspaces App.
-         * Returns an unsubscribe function.
+         * Notifies when a Workspace has been hibernated. Returns an unsubscribe function.
+         * The event will fire for any Workspace hibernated in any running instance of a Workspaces App.
          * @param callback Callback function for handling the event. Receives as an argument the `Workspace` object describing the hibernated Workspace.
          */
         onWorkspaceHibernated(callback: (workspace: IOConnectWorkspaces.Workspace) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
         /**
-         * Notifies when a Workspace is resumed after being hibernated.
-         * This event will be fired for any Workspace resumed in any currently running instance of a Workspaces App.
-         * Returns an unsubscribe function.
+         * Notifies when a Workspace has been resumed after being hibernated. Returns an unsubscribe function.
+         * The event will fire for any Workspace resumed in any running instance of a Workspaces App.
          * @param callback Callback function for handling the event. Receives as an argument the `Workspace` object describing the resumed Workspace.
          */
         onWorkspaceResumed(callback: (workspace: IOConnectWorkspaces.Workspace) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
@@ -2661,43 +3504,44 @@ export namespace IOConnectWorkspaces {
          * @since @interopio/workspaces-api 4.4
          */
         onWorkspaceTabReordered(callback: (workspace: IOConnectWorkspaces.Workspace) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
+
         /**
-         * Notifies when a new window was added to any workspace in any frame and returns an unsubscribe function.
-         * An added window means that the window has a place in a workspace (it is a valid workspace element), but does not guarantee that the contents of the window are loaded.
-         * @param callback Callback function to handle the event. Receives the added window as a parameter.
+         * Notifies when a new window has been added to any Workspace in any `Frame` instance. Returns an unsubscribe function.
+         * An added window has a place in the Workspace (it's a valid Workspace element), but this doesn't guarantee that the contents of the window have been loaded.
+         * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the added window.
          */
         onWindowAdded(callback: (workspaceWindow: WorkspaceWindow) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a window's content was loaded in any workspace in any frame and returns an unsubscribe function.
-         * A loaded window is a window, which was added to a workspace, it's contents were loaded and it is present in the windows collection.
-         * @param callback Callback function to handle the event. Receives the loaded window as a parameter.
+         * Notifies when the contents of a window in any Workspace in any `Frame` instance have been loaded. Returns an unsubscribe function.
+         * A loaded window is a window that has been added to a Workspace, whose contents have been loaded, and which is present in the windows collection.
+         * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the loaded window.
          */
         onWindowLoaded(callback: (workspaceWindow: WorkspaceWindow) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a window was removed from any workspace and any frame and returns an unsubscribe function.
-         * @param callback Callback function to handle the event. Receives an object containing the ids of the removed window, and the respective workspace and frame as a parameter.
+         * Notifies when a window has been removed from any Workspace in any `Frame` instance. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument an object with the IDs of the removed window and of its Workspace and `Frame` instance.
          */
         onWindowRemoved(callback: (removed: { windowId?: string; workspaceId: string; frameId: string }) => void): Promise<Unsubscribe>;
 
         /**
-         * Notifies when a window was maximized in any workspace in any frame and returns an unsubscribe function.
-         * A maximized window means that the window has been maximized either by an API call or from the maximize button by the user.
-         * @param callback Callback function to handle the event. Receives the maximized window as a parameter.
+         * Notifies when a window in any Workspace in any `Frame` instance has been maximized. Returns an unsubscribe function.
+         * The window can be maximized programmatically or by the user via the "Maximize" button.
+         * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the maximized window.
          */
         onWindowMaximized(callback: (workspaceWindow: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
         /**
-         * Notifies when a window was restored from a maximized state in any workspace in any frame and returns an unsubscribe function.
-         * A restored window means that the window has been restored from a maximized state either by an API call or from the restore button by the user.
-         * @param callback Callback function to handle the event. Receives the restored window as a parameter.
+         * Notifies when a window in any Workspace in any `Frame` instance has been restored from a maximized state. Returns an unsubscribe function.
+         * The window can be restored programmatically or by the user via the "Restore" button.
+         * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the restored window.
          */
         onWindowRestored(callback: (workspaceWindow: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
         /**
-         * Notifies when a window was selected in any frame and returns an unsubscribe function.
-         * @param callback Callback function to handle the event. Receives the selected window as a parameter.
+         * Notifies when a window in any Workspace in any `Frame` instance has been selected. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the selected window.
          */
         onWindowSelected(callback: (workspaceWindow: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
@@ -2710,7 +3554,9 @@ export namespace IOConnectWorkspaces {
          */
         onWindowTabReordered(callback: (workspaceWindow: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
-        /** The io.Connect Workspaces API version. */
+        /**
+         * Version of the Workspaces API.
+         */
         version: string;
     }
 }