@albanian-xrm/cif-types 0.1.3 → 0.1.5

package/README.md

@@ -1,6 +1,29 @@
-# @albanian-xrm/cif-types
+# @albanian-xrm/cif-types  ![NPM Downloads](https://img.shields.io/npm/dt/@albanian-xrm%2Fcif-types)
+
 Microsoft.CIFramework types from the community (us).
 
-Read more about Channel Integration Framework on the Microsoft Docs [here](https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/channel-integration-framework).
+Read more about Channel Integration Framework on the [Microsoft Docs](https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/channel-integration-framework).
+
+These types are based on the api documentation on the [Microsoft Docs](https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework).
+
+To use the types install `@albanian-xrm/cif-types` and add the following to your `tsconfig.json`:
+
+```json
+"compilerOptions": {
+        "types": [
+            "@albanian-xrm/cif-types/v1.0"
+        ]
+    }
+```
+
+If you want CIFv2 then use the following configuration:
+
+```json
+"compilerOptions": {
+        "types": [
+            "@albanian-xrm/cif-types"
+        ]
+    }
+```
 
-These types are based on the api documentation on the Microsoft Docs [here](https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework).
+You will get the Intellisense in your IDE with the global `Microsoft.CIFramework` types.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@albanian-xrm/cif-types",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Microsoft.CIFramework types from the community (us).",
   "repository": {
     "type": "git",

package/v1.0/CRUD.d.ts

@@ -5,7 +5,7 @@ declare namespace Microsoft {
      * @param entityLogicalName Logical name of the entity you want to create. For example: "account".
      * @param data String defining the attributes and values for the new entity record.
      * @returns On success, returns a promise containing a string with the attributes and their values.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/createrecord External Link: createRecord}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/createrecord External Link: createRecord}
      * @example
      * var entityLogicalName = "contact";
      * var data = {
@@ -49,7 +49,7 @@ declare namespace Microsoft {
      *    ?$select=name&$expand=primarycontactid($select=contactid,fullname)
      *    ```
      * @returns On success, returns a promise containing a string with the retrieved attributes and their values.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/retrieverecord External Link: retrieveRecord}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/retrieverecord External Link: retrieveRecord}
      * @example
      * // retrieve contact record
      * var id = "b44d31ac-5fd1-e811-8158-000d3af97055";
@@ -78,7 +78,7 @@ declare namespace Microsoft {
      * @param id GUID of the entity record you want to update.
      * @param data String containing key: value pairs, where key is the property of the entity and value is the value of the property you want to update.
      * @returns On success, returns a promise containing a string with the updated attributes and their values.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/updaterecord External Link: deleteRecord}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/updaterecord External Link: deleteRecord}
      * @example
      * //// define the data to update a record
      * var entityLogicalName = "contact";
@@ -117,7 +117,7 @@ declare namespace Microsoft {
      * @param entityLogicalName The entity logical name of the record you want to delete. For example: "account".
      * @param id GUID of the entity record you want to delete.
      * @returns On success, returns a promise containing a string with the attributes and their values.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/deleterecord External Link: deleteRecord}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/deleterecord External Link: deleteRecord}
      * @example
      * // delete contact record  with the id=b44d31ac-5fd1-e811-8158-000d3af97055d
      * var id = "b44d31ac-5fd1-e811-8158-000d3af97055";

package/v1.0/ClickToAct.d.ts

@@ -3,7 +3,7 @@ declare namespace Microsoft {
     /**
      * Returns a Boolean value to indicate whether the outbound communication (ClickToAct) is enabled or not.
      * @returns Returns Promise object with the value. `true` if ClickToAct is enabled; `false` otherwise.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/getclicktoact External Link: getClickToAct}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/getclicktoact External Link: getClickToAct}
      */
     export function getClickToAct(): Promise<boolean>;
 
@@ -11,7 +11,7 @@ declare namespace Microsoft {
      * Sets a Boolean value to enable or disable the outbound communication (ClickToAct).
      * @param value Sets the value to enable or disable ClickToAct.
      * @returns Returns Promise object without value.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/setclicktoact External Link: setClickToAct}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/setclicktoact External Link: setClickToAct}
      */
     export function setClickToAct(value: boolean): Promise<boolean>;
   }

package/v1.0/EntityMetadata.d.ts

@@ -3,7 +3,7 @@ declare namespace Microsoft {
     /**
      * Returns the entity metadata for the specified entity.
      * @returns An object containing the entity metadata information with the following form {@link EntityMetadata}.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/getentitymetadata External Link: getEntityMetadata}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/getentitymetadata External Link: getEntityMetadata}
      */
     export function getEntityMetadata(
       entityName: string,

package/v1.0/Environment.d.ts

@@ -3,7 +3,7 @@ declare namespace Microsoft {
     /**
      * Gets the current Unified Interface app and page details.
      * @returns Returns a Promise object of type String with details of the current Unified Interface app and page. See {@link Environment}
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/getenvironment External Link: getEnvironment}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/getenvironment External Link: getEnvironment}
      */
     export function getEnvironment(): Promise<string>;
 

package/v1.0/Events.d.ts

@@ -13,7 +13,7 @@ declare namespace Microsoft {
      *   You can also pass custom events in the `eventName` parameter.
      * @param handlerFunction The handler function is invoked when any of the supported events are triggered.
      * @returns Promise with a value as Boolean.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
      * @example
      * handlerFunction = function(eventData) {
      * console.log(eventData)
@@ -33,7 +33,7 @@ declare namespace Microsoft {
      * @param eventName Name of the event for which the handler is set. The event is invoked when the outbound communication (ClickToAct) field is enabled.
      * @param handlerFunction The handler function is invoked when any of the supported events are triggered.
      * @returns Promise with a value as Boolean.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
      */
     export function addHandler(
       eventName: "onclicktoact",
@@ -46,7 +46,7 @@ declare namespace Microsoft {
      * @param eventName Name of the event for which the handler is set. The 'OnModeChanged' event is invoked when the panel mode is manually toggled between Minimized (0) and Docked (1).
      * @param handlerFunction The handler function is invoked when any of the supported events are triggered.
      * @returns Promise with a value as Boolean.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
      * @example
      * handlerFunction = function(eventData) {
      * console.log(eventData)
@@ -66,7 +66,7 @@ declare namespace Microsoft {
      * @param eventName Name of the event for which the handler is set.
      * @param handlerFunction The handler function is invoked when any of the supported events are triggered.
      * @returns Promise with a value as Boolean.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
      */
     export function addHandler(
       eventName: "onpagenavigate",
@@ -79,7 +79,7 @@ declare namespace Microsoft {
      * @param eventName Name of the event for which the handler is set.
      * @param handlerFunction The handler function is invoked when any of the supported events are triggered.
      * @returns Promise with a value as Boolean.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
      */
     export function addHandler(
       eventName: "onsendkbarticle",
@@ -92,7 +92,7 @@ declare namespace Microsoft {
      * @param eventName Name of the event for which the handler is set.
      * @param handlerFunction The handler function is invoked when any of the supported events are triggered.
      * @returns Promise with a value as Boolean.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
      */
     export function addHandler(
       eventName: "onsizechanged",
@@ -106,7 +106,7 @@ declare namespace Microsoft {
      * @param correlationId Is used to group all related API calls together for diagnostic telemetry.
      * @remark If you've created custom events using the {@link addHandler} method, then you can raise those events by passing the event name as parameter in this method.
      * @returns Promise with a value as Boolean.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
      * @example
      * // Let there be an event registered to a subscriber.
      * handlerFunction = function(eventInput)
@@ -152,7 +152,7 @@ declare namespace Microsoft {
      *
      *   You can also pass custom events in the `eventName` parameter.
      * @param handlerFunction The handler function that is to removed.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/raiseevent External Link: raiseEvent}
      */
     export function removeHandler(
       eventName: string,

package/v1.0/Form.d.ts

@@ -0,0 +1,178 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * Opens an entity form or a quick create form.
+     * @param entityFormOptions Entity form options for opening the form. This parameter is a serialized from {@link Microsoft.CIFramework.EntityFormOptions EntityFormOptions}
+     * @param formParameters A dictionary object that passes extra parameters to the form. Invalid parameters will cause an error. For information about passing parameters to a form, see {@link https://learn.microsoft.com/en-us/power-apps/developer/model-driven-apps/set-field-values-using-parameters-passed-form External Link: Set field values using parameters passed to a form} and {@link https://learn.microsoft.com/en-us/power-apps/developer/model-driven-apps/configure-form-accept-custom-querystring-parameters External Link:  Configure a form to accept custom querystring parameters}
+     * @returns On success, returns a Promise object containing string.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/openform External Link: openForm}
+     * @example
+     * var id = "5af02e2a-d0d1-e811-8158-000d3af97055"
+     * var title = "Sample Case Form"
+     * var entityFormOptions = {};
+     *     entityFormOptions["entityName"] = "incident";
+     *
+     * var formParameters = {};
+     *     //pre-populate some fields based on the context
+     *     formParameters["title"] = title;
+     *     formParameters["customerid"] = id;
+     *     formParameters["customeridtype"] = "contact";
+     *     formParameters["caseorigincode"] = 1;
+     *     formParameters["description"] = "Opened the form with pre-populated details like title, contact id, and description.";
+     *
+     * //Open the form
+     * Microsoft.CIFramework.openForm(JSON.stringify(entityFormOptions), JSON.stringify(formParameters)).then(
+     *       function (success) {
+     *         console.log(success);
+     *     },
+     *     function (error) {
+     *         console.log(error);
+     *     }
+     *   );
+     */
+    export function openForm(
+      entityFormOptions: string,
+      formParameters?: string
+    ): Promise<string>;
+
+    export interface EntityFormOptions {
+      /**
+       * Indicates whether to display the command bar. If you do not specify this parameter, the command bar is displayed by default.
+       */
+      cmdBar?: boolean;
+
+      /**
+       * Indicates a record that will provide default values based on mapped attribute values.
+       */
+      createFromEntity?: LookupValue;
+
+      /**
+       * String	Identifier of the entity record to display the form for.
+       */
+      entityId?: string;
+
+      /**
+       * Logical name of the entity to display the form for.
+       */
+      entityName: string;
+
+      /**
+       * Identifier of the form instance to be displayed.
+       */
+      formId?: string;
+
+      /**
+       * Height of the form window to be displayed in pixels.
+       */
+      height?: number;
+
+      /**
+       * Controls whether the navigation bar is displayed and whether application navigation is available using the areas and subareas defined in the site map.
+       */
+      navBar?: EntityFormNavBar;
+
+      /**
+       * Indicates whether to display the form in a new window.
+       */
+      openInNewWindow?: boolean;
+
+      /**
+       * Indicates the position of the form on the window.
+       */
+      windowPosition?: WindowPosition;
+
+      /**
+       * Identifier of the business process to be displayed on the form.
+       */
+      processId?: string;
+
+      /**
+       * Identifier of the business process instance to be displayed on the form.
+       */
+      processInstanceId?: string;
+
+      /**
+       * Indicates a relationship object to display the related records on the form.
+       */
+      relationship?: Relationship;
+
+      /**
+       * Identifier of the selected stage in business process instance.
+       */
+      selectStageId?: string;
+
+      useQuickCreateForm?: boolean;
+
+      /**
+       * Width of the form window to be displayed in pixels.
+       */
+      width?: number;
+    }
+
+    /**
+     * The following interface describes the attributes of the {@link Microsoft.CIFramework.EntityFormOptions.relationship relationship} object attribute of the {@link Microsoft.CIFramework.openForm entityFormOptions} parameter.
+     */
+    export interface Relationship {
+      /**
+       * Name of the attribute used for relationship.
+       */
+      attributeName?: string;
+
+      /**
+       * Name of the relationship.
+       */
+      name?: string;
+
+      /**
+       * Name of the navigation property for the relationship.
+       */
+      navigationProperty?: string;
+
+      /**
+       * Relationship type.
+       */
+      relationshipType?: RelationshipType;
+
+      /**
+       * Role type in the relationship.
+       */
+      roleType?: RoleType;
+    }
+
+    export const enum EntityFormNavBar {
+      /**
+       * The navigation bar is displayed. This is the default behavior if the navBar parameter is not used.
+       */
+      on = "on",
+      /**
+       * The navigation bar is not displayed. The user can navigate using other user interface elements or the back and forward buttons.
+       */
+      off = "off",
+      /**
+       * On an entity form, only the navigation options for related entities are available. After navigating to a related entity, a back button is displayed on the navigation bar to allow returning to the original record.
+       */
+      entity = "entity",
+    }
+
+    export const enum WindowPosition {
+      Center = 1,
+      Side = 2,
+    }
+
+    export const enum RelationshipType {
+      OneToMany = 0,
+      ManyToMany = 1,
+    }
+
+    export const enum RoleType {
+      Referencing = 1,
+      AssociationEntity = 2,
+    }
+
+    export interface LookupValue {
+      entityType: string;
+      id: string;
+      name?: string;
+    }
+  }
+}

package/v1.0/PanelMode.d.ts

@@ -1,6 +1,20 @@
 declare namespace Microsoft {
   namespace CIFramework {
     /**
+     * Gets the current state of the panel.
+     * @returns Promise object with the value (current state of the panel). Values are defined in {@link PanelMode}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/getmode External Link: getMode}
+     */
+    export function getMode(): Promise<PanelMode>;
+
+    /**
+     * Sets the state of the panel.
+     * @param value The value to set the mode of the panel.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/setmode External Link: setMode}
+     */
+    export function setMode(value: PanelMode): Promise<void>;
+
+        /**
      * The value to set the mode of the panel.
      */
     export const enum PanelMode {
@@ -13,19 +27,5 @@ declare namespace Microsoft {
        */
       Docked = 1,
     }
-
-    /**
-     * Gets the current state of the panel.
-     * @returns Promise object with the value (current state of the panel). Values are defined in {@link PanelMode}
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/getmode External Link: getMode}
-     */
-    export function getMode(): Promise<PanelMode>;
-
-    /**
-     * Sets the state of the panel.
-     * @param value The value to set the mode of the panel.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/setmode External Link: setMode}
-     */
-    export function setMode(value: PanelMode): Promise<void>;
   }
 }

package/v1.0/PanelWidth.d.ts

@@ -3,7 +3,7 @@ declare namespace Microsoft {
     /**
      * Gets the panel width in pixels.
      * @returns Returns a promise object containing the width of the panel, in pixels.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/getwidth External Link: getWidth}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/getwidth External Link: getWidth}
      */
     export function getWidth(): Promise<number>;
 
@@ -14,7 +14,7 @@ declare namespace Microsoft {
      * - If the value parameter passed for setWidth is greater than half of screen width, the side panel will collapse.
      * - The width should be greater than or equal to 300. The API doesn't consider any value less than 300.
      * @returns Returns a promise object with a value.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/setwidth External Link: setWidth}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/setwidth External Link: setWidth}
      */
     export function setWidth(value: number): Promise<void>;
   }

package/v1.0/Search.d.ts

@@ -1,5 +1,17 @@
 declare namespace Microsoft {
   namespace CIFramework {
+      /**
+     * Allows you to search among the records of a particular entity type. This API opens the Unified Interface entity page with the search field on it prepopulated with the search string that is passed as a parameter.
+     * @param entityLogicalName The entity logical name of the record you want to query such as "account".
+     * @param searchString String to search among the attributes of the entity records.
+     * @param Type of search page to open. `0` for relevance search and `1` for categorized search. If no parameter is provided, the records are searched by category.  For information on relevance search, see {@link https://learn.microsoft.com/en-us/power-platform/admin/configure-relevance-search-organization External Link: Configure Dataverse search}.
+     */
+    export function renderSearchPage(
+      entityLogicalName: string,
+      searchString: string,
+      searchType?: SearchType
+    ): Promise<void>;
+
     /**
      * The method searches for the record from the communication widget during the inbound communication and opens the record.
      * @param entityLogicalName Name of the entity to search and open.
@@ -20,7 +32,7 @@ declare namespace Microsoft {
      * @returns Returns a Promise object of type String. On success, the method returns the search results as per the search query.
      * @remarks You can fetch a maximum of 5000 records at once (if more than 5000 records exist). You can narrow down the results by using query options such as `$filter`, `$select`, and `$top` in the method parameters. See {@link https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview External Link: Query options overview}
      * @remarks To search based on relevance, you must configure relevance search. If relevance search isn't enabled, then the search will be performed based on category. See {@link https://learn.microsoft.com/en-us/power-platform/admin/configure-relevance-search-organization External Link: Configure Relevance Seach}
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/searchandopenrecords External Link: searchAndOpenRecords}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/searchandopenrecords External Link: searchAndOpenRecords}
      * @example
      * // retrieve contact record
      * Microsoft.CIFramework.searchAndOpenRecords("contact", "?$select=fullname,telephone1", false).
@@ -61,17 +73,8 @@ declare namespace Microsoft {
     ): Promise<string>;
 
     /**
-     * Allows you to search among the records of a particular entity type. This API opens the Unified Interface entity page with the search field on it prepopulated with the search string that is passed as a parameter.
-     * @param entityLogicalName The entity logical name of the record you want to query such as "account".
-     * @param searchString String to search among the attributes of the entity records.
-     * @param Type of search page to open. `0` for relevance search and `1` for categorized search. If no parameter is provided, the records are searched by category.  For information on relevance search, see {@link https://learn.microsoft.com/en-us/power-platform/admin/configure-relevance-search-organization External Link: Configure Dataverse search}.
+     * Type of search page to open. 0 for relevance search and 1 for categorized search. If no parameter is provided, the records are searched by category.
      */
-    export function renderSearchPage(
-      entityLogicalName: string,
-      searchString: string,
-      searchType?: SearchType
-    ): Promise<void>;
-
     export const enum SearchType {
       RelevanceSearch = 0,
       CategorizedSearch = 1,

package/v1.0/index.d.ts

@@ -1,9 +1,9 @@
 /// <reference path="./ClickToAct.d.ts" />
-/// <reference path="./Context.d.ts" />
 /// <reference path="./CRUD.d.ts" />
 /// <reference path="./EntityMetadata.d.ts" />
 /// <reference path="./Environment.d.ts" />
 /// <reference path="./Events.d.ts" />
+/// <reference path="./Form.d.ts" />
 /// <reference path="./PanelMode.d.ts" />
 /// <reference path="./PanelWidth.d.ts" />
 /// <reference path="./Search.d.ts" />

package/v2.0/ClickToAct.d.ts

@@ -0,0 +1,23 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * Returns a Boolean value to indicate whether the outbound communication (ClickToAct) is enabled or not.
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Returns Promise object with the value. `true` if ClickToAct is enabled; `false` otherwise.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/getclicktoact External Link: getClickToAct}
+     */
+    export function getClickToAct(correlationId?: string): Promise<boolean>;
+
+    /**
+     * Sets a Boolean value to enable or disable the outbound communication (ClickToAct).
+     * @param value Sets the value to enable or disable ClickToAct.
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Returns Promise object without value.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/setclicktoact External Link: setClickToAct}
+     */
+    export function setClickToAct(
+      value: boolean,
+      correlationId?: string
+    ): Promise<boolean>;
+  }
+}

package/{v1.0 → v2.0}/Context.d.ts

@@ -7,7 +7,7 @@ declare namespace Microsoft {
      * @param isDelete Set isDelete to `true` if the list of parameters in input JSON are to be deleted. If isDelete is set to `true`, the slug values will be deleted and will no longer be available for subsequent macro invocations.
      * @param correlationId Used to group all related API calls together for diagnostic telemetry
      * @returns Returns a promise with string value.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/microsoft-ciframework/updatecontext External Link: updateContext}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/updatecontext External Link: updateContext}
      * @example
      * var input = { "customerName" : "Contosso" };
      * Microsoft.CIFramework.updateContext(input).then(
@@ -23,7 +23,7 @@ declare namespace Microsoft {
      */
     export function updateContext(
       input: string,
-      sessionId?: string,
+      sessionId: string,
       isDelete?: boolean,
       correlationId?: string
     ): Promise<string>;

package/v2.0/Conversation.d.ts

@@ -0,0 +1,35 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * This method allows you to update a Conversation(msdyn_ocliveworkitem) record.
+     * @param id Unique identifier of the conversation returned by {@link Microsoft.CIFramework.getSession Microsoft.CIFramework.getSession} API.
+     * @param data JSON string
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Returns a promise with string value.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/updateconversation External Link: updateConversation}
+     * @example
+     * var data = {
+     *      "subject": "Troubleshooting printer malfunction",
+     *      "prioritycode": 2
+     *  }
+     *  var conversationId = "05145e77-ce40-ea11-a812-000d3a579805";
+     *  var jsonData = JSON.stringify(data);
+     *  Microsoft.CIFramework.updateConversation(conversationId, jsonData).then(
+     *      function success (response) {
+     *          var result = JSON.parse(response);
+     *          console.log("Conversation updated with ID: " + result.id);
+     *          //the Conversation is updated
+     *        },
+     *        function (error) {
+     *            console.log(error);
+     *            //handle errors
+     *        }
+     *    );
+     */
+    export function updateConversation(
+      id: string,
+      data: string,
+      correlationId?: string
+    ): Promise<string>;
+  }
+}

package/v2.0/Notification.d.ts

@@ -5,7 +5,7 @@ declare namespace Microsoft {
      * @param cancellationToken Unique string that was provided in the {@link notifyEvent} method to display notifications about incoming conversations.
      * @param correlationId Used to group all related API calls together for diagnostic telemetry.
      * @returns Returns the cancellation token.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/v2/reference/microsoft-ciframework/cancelevent External Link: cancelEvent}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/cancelevent External Link: cancelEvent}
      * @example
      * // Trying to cancel a notification, use the same cancelToken passed during creation of notification in notifyEvent
      * Microsoft.CIFramework.cancelEvent(CancelToken).then(
@@ -30,7 +30,7 @@ declare namespace Microsoft {
      * @param correlationId Used to group all related API calls together for diagnostic telemetry.
      * @param cancellationToken Is the unique string that's used by the {@link cancelEvent} method to cancel notifications about incoming conversations.
      * @returns Returns a Boolean value of success.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/v2/reference/microsoft-ciframework/notifyevent External Link: notifyEvent}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/notifyevent External Link: notifyEvent}
      * @example
      * var canceltoken = "cancellationtoken"+ Math.ceil(Math.random() * 100000 + 100000).toString();
      *
@@ -51,9 +51,20 @@ declare namespace Microsoft {
      * );
      */
     export function notifyEvent(
-      input: string,
-      correlationId?: string,
-      cancellationToken?: string
+      input: NotifyEventArgs,
+      correlationId?: string
     ): Promise<string>;
+
+    export interface NotifyEventArgs {
+      eventType?: string;
+      templateName: string;
+      templateParameters: object;
+      templateNameResolver?: string;
+      additionalParametersObject?: string;
+      messageNotificationType?: string;
+      notificationAction?: string;
+      cancellationToken?: string;
+      notificationUXObject?: string;
+    }
   }
 }

package/v2.0/Presence.d.ts

@@ -3,7 +3,7 @@ declare namespace Microsoft {
     /**
      * Returns the presence text of the agent in the client session.
      * @returns Promise with the presence text of the current agent, as String.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/v2/reference/microsoft-ciframework/getpresence External Link: getPresence}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/getpresence External Link: getPresence}
      * @example
      * function getPresence() {
      *     return new Promise((resolve, reject) => {
@@ -27,7 +27,7 @@ declare namespace Microsoft {
      * Sets the presence text of the agent in the client session.
      * @param presenceText Presence text for current agent in Omnichannel for Customer Service. For the presence to be set correctly, the string should exactly match the text used in the admin app. To create custom presence, see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/presence-custom-presence External Link: Configure and manage custom presence} .
      * @returns Returns a Boolean value of success.
-     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/v2/reference/microsoft-ciframework/setpresence External Link: setPresence}
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/setpresence External Link: setPresence}
      * @example
      * Microsoft.CIFramework.setPresence(custompresence).then(
      *   function (result) {

package/v2.0/Session.d.ts

@@ -0,0 +1,94 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * Allows you to check if a new session can be created.
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Promise with the value as Boolean.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/cancreatesession External Link: canCreateSession}
+     */
+    export function canCreateSession(correlationId?: string): Promise<boolean>;
+
+    /**
+     * Creates a new session based on the session template name and returns the unique identifier of the session that was created.
+     *
+     * If your organization uses single or multiple channel providers, then you can use this method to start a default session. More information: {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/v2/support-multiple-providers External Link: Configure support for single and multiple channel providers}
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Promise with the value as Boolean.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/cancreatesession External Link: canCreateSession}
+     * @example
+     * var input = {
+     *   // unique name of the configured template
+     *   templateName: "msdyn_chat_session",
+     *   templateParameters: {
+     *     customer: "Contoso",
+     *   } // Global and application tab template parameters, these values will override configured values
+     * };
+     * Microsoft.CIFramework.createSession(input).then(function success(sessionId) {
+     *   console.log(sessionId);
+     *   // perform operations on session Id retrieved
+     * }, function(error) {
+     *   console.log(error.message);
+     *   // handle error conditions
+     * });
+     */
+    export function createSession(
+      input: CreateSessionInput,
+      correlationId?: string
+    ): Promise<boolean>;
+
+    /**
+     * Input for {@link Microsoft.CIFramework.createSession createSession}
+     */
+    interface CreateSessionInput {
+      /**
+       * Unique name of session template
+       */
+      templateName: string;
+      /**
+       * Global and application tab template parameters, these values will override configured values
+       */
+      templateParameters: {
+        [key: string]: number | boolean | string;       
+      };
+    }
+
+    /**
+     * Returns an array of session identifiers for a provider.
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Promise with the value as array of strings.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/getallsessions External Link: getAllSessions}
+     */
+    export function getAllSessions(correlationId?: string): Promise<string[]>;
+
+    /**
+     * Returns the unique identifier of the session that is in focus, if it belongs to the channel provider else returns null. The session ID is null if the connector attempts to retrieve a focused session created using a different connector.
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Promise with the value as a string.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/getfocusedsession External Link: getAllSessions}
+     */
+    export function getFocusedSession(): Promise<string>;
+
+    /**
+     * Returns an object containing the unique identifier of the session, unique identifier of the conversation, context and the value of isFocused parameter, in case the session belongs to the channel provider.
+     * @param sessionId Id of the current session.
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Object containing session Id, conversation Id, context and isFocused parameter
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/getsession External Link: getSession}
+     * @example
+     * Microsoft.CIFramework.getSession("session-id-1").then(
+     *      function success(result) {
+     *          console.log(result);
+     *          // perform operations on session info
+     *      },
+     *      function (error) {
+     *          console.log(error.message);
+     *          // handle error conditions
+     *      }
+     *  );
+     */
+    export function getSession(
+      sessionId: string,
+      correlationId?: string
+    ): Promise<string>;
+  }
+}

package/v2.0/index.d.ts

@@ -1,10 +1,13 @@
-/// <reference path="../v1.0/ClickToAct.d.ts" />
-/// <reference path="../v1.0/Context.d.ts" />
+/// <reference path="./ClickToAct.d.ts" />
+/// <reference path="./Context.d.ts" />
+/// <reference path="./Conversation.d.ts" />
 /// <reference path="../v1.0/CRUD.d.ts" />
 /// <reference path="../v1.0/EntityMetadata.d.ts" />
 /// <reference path="../v1.0/Environment.d.ts" />
 /// <reference path="../v1.0/Events.d.ts" />
+/// <reference path="./Notification.d.ts" />
 /// <reference path="./PanelMode.d.ts" />
 /// <reference path="../v1.0/PanelWidth.d.ts" />
 /// <reference path="./Presence.d.ts" />
 /// <reference path="../v1.0/Search.d.ts" />
+/// <reference path="./Session.d.ts" />