@albanian-xrm/cif-types 0.1.1 → 0.1.3

package/README.md

@@ -1,6 +1,6 @@
 # @albanian-xrm/cif-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).
+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).
 
 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).

package/package.json

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

package/v1.0/Events.d.ts

@@ -160,19 +160,6 @@ declare namespace Microsoft {
     ): void;
 
     namespace EventArgs {
-      /**
-       * The CIFInitDone event is raised by the Dynamics 365 Channel Integration Framework library when Channel Integration Framework is loaded.
-       * This event is used to determine whether the Channel Integration Framework APIs are ready to be consumed.
-       * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/events/cifinitdone External Link: CIFInitDone event}
-       * @example
-       * (function () {
-       *     window.addEventListener("CIFInitDone", function () {
-       *         //Code that consumes CIF library APIs.
-       *     });
-       * })();
-       */
-      export interface CIFInitDone {}
-
       export interface ClickToAct {
         value: any;
         name: "string";
@@ -211,3 +198,22 @@ declare namespace Microsoft {
     }
   }
 }
+
+interface Window {
+  /**
+   * The CIFInitDone event is raised by the Dynamics 365 Channel Integration Framework library when Channel Integration Framework is loaded.
+   * This event is used to determine whether the Channel Integration Framework APIs are ready to be consumed.
+   * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/reference/events/cifinitdone External Link: CIFInitDone event}
+   * @example
+   * (function () {
+   *     window.addEventListener("CIFInitDone", function () {
+   *         //Code that consumes CIF library APIs.
+   *     });
+   * })();
+   */
+  addEventListener(
+    type: "CIFInitDone",
+    listener: () => void,
+    options?: boolean | AddEventListenerOptions
+  ): void;
+}

package/v1.0/index.d.ts

@@ -1,4 +1,5 @@
 /// <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" />

package/v2.0/Notification.d.ts

@@ -0,0 +1,59 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * Cancels the notification about incoming conversations based on the cancellation token.
+     * @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}
+     * @example
+     * // Trying to cancel a notification, use the same cancelToken passed during creation of notification in notifyEvent
+     * Microsoft.CIFramework.cancelEvent(CancelToken).then(
+     *     function success(result) {
+     *                     console.log(result);
+     *                     // Perform operations
+     *     },
+     *     function (error) {
+     *                     console.log(error.message);
+     *                     // Handle error conditions
+     *     }
+     * );
+     */
+    export function cancelEvent(
+      cancellationToken: string,
+      correlationId?: string
+    ): Promise<string>;
+
+    /**
+     * Displays a notification that can be used to inform the agent about incoming conversations.
+     * @param input JSON string
+     * @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}
+     * @example
+     * var canceltoken = "cancellationtoken"+ Math.ceil(Math.random() * 100000 + 100000).toString();
+     *
+     * var input = {
+     *      templateName: "msdyn_chat_incoming_unauthenticated", // unique name of the configured template
+     *      templateParameters: {},
+     *      cancellationToken: canceltoken // unique random token, to identify the notification during cancelEvent call
+     * }
+     * Microsoft.CIFramework.notifyEvent(input).then(
+     *      function success(result) {
+     *          console.log(result);
+     *          // Perform operations
+     *      },
+     *      function (error) {
+     *          console.log(error.message);
+     *          // Handle error conditions
+     *      }
+     * );
+     */
+    export function notifyEvent(
+      input: string,
+      correlationId?: string,
+      cancellationToken?: string
+    ): Promise<string>;
+  }
+}

package/v2.0/index.d.ts

@@ -1,4 +1,5 @@
 /// <reference path="../v1.0/ClickToAct.d.ts" />
+/// <reference path="../v1.0/Context.d.ts" />
 /// <reference path="../v1.0/CRUD.d.ts" />
 /// <reference path="../v1.0/EntityMetadata.d.ts" />
 /// <reference path="../v1.0/Environment.d.ts" />