@albanian-xrm/cif-types 0.1.5 → 0.1.6

package/README.md

@@ -11,17 +11,17 @@ To use the types install `@albanian-xrm/cif-types` and add the following to your
 ```json
 "compilerOptions": {
         "types": [
-            "@albanian-xrm/cif-types/v1.0"
+            "@albanian-xrm/cif-types"
         ]
     }
 ```
 
-If you want CIFv2 then use the following configuration:
+If you want CIFv1 then use the following configuration:
 
 ```json
 "compilerOptions": {
         "types": [
-            "@albanian-xrm/cif-types"
+            "@albanian-xrm/cif-types/v1.0"
         ]
     }
 ```

package/package.json

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

package/v1.0/ClickToAct.d.ts

@@ -13,6 +13,6 @@ declare namespace Microsoft {
      * @returns Returns Promise object without value.
      * @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>;
+    export function setClickToAct(value: boolean): Promise<void>;
   }
 }

package/v1.0/Events.d.ts

@@ -24,7 +24,7 @@ declare namespace Microsoft {
      */
     export function addHandler(
       eventName: string,
-      handlerFunction: (...args) => Promise<void>
+      handlerFunction: (...args) => (void | Promise<void>)
     ): Promise<boolean>;
 
     /**
@@ -37,7 +37,7 @@ declare namespace Microsoft {
      */
     export function addHandler(
       eventName: "onclicktoact",
-      handlerFunction: (eventData: EventArgs.ClickToAct) => Promise<void>
+      handlerFunction: (eventData: EventArgs.ClickToAct) => (void | Promise<void>)
     ): Promise<boolean>;
 
     /**
@@ -57,7 +57,7 @@ declare namespace Microsoft {
      */
     export function addHandler(
       eventName: "onmodechanged",
-      handlerFunction: (eventData: EventArgs.ModeChanged) => Promise<void>
+      handlerFunction: (eventData: EventArgs.ModeChanged) => (void | Promise<void>)
     ): Promise<boolean>;
 
     /**
@@ -70,7 +70,7 @@ declare namespace Microsoft {
      */
     export function addHandler(
       eventName: "onpagenavigate",
-      handlerFunction: (eventData: EventArgs.PageNavigate) => Promise<void>
+      handlerFunction: (eventData: EventArgs.PageNavigate) => (void | Promise<void>)
     ): Promise<boolean>;
 
     /**
@@ -83,7 +83,7 @@ declare namespace Microsoft {
      */
     export function addHandler(
       eventName: "onsendkbarticle",
-      handlerFunction: (eventData: EventArgs.SendKBArticle) => Promise<void>
+      handlerFunction: (eventData: EventArgs.SendKBArticle) => (void | Promise<void>)
     ): Promise<boolean>;
 
     /**
@@ -96,7 +96,7 @@ declare namespace Microsoft {
      */
     export function addHandler(
       eventName: "onsizechanged",
-      handlerFunction: (eventData: EventArgs.SizeChanged) => Promise<void>
+      handlerFunction: (eventData: EventArgs.SizeChanged) => (void | Promise<void>)
     ): Promise<boolean>;
 
     /**
@@ -156,7 +156,7 @@ declare namespace Microsoft {
      */
     export function removeHandler(
       eventName: string,
-      handlerFunction: (eventData: EventArgs.SizeChanged) => Promise<void>
+      handlerFunction: (eventData: EventArgs.SizeChanged) => (void | Promise<void>)
     ): void;
 
     namespace EventArgs {

package/v2.0/ApplicationTabManagement.d.ts

@@ -0,0 +1,97 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * Creates a tab in a focused session and returns the unique identifier of the created tab.
+     * @param input JSON input
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns None.
+     * @remarks Use this API only when the focused session belongs to the provider or if it is the home or default session.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/closetab External Link: closeTab}
+     */
+    export function closeTab(input: TabInput,correlationId?: string): Promise<void>;
+
+    /**
+     * Creates a tab in a focused session and returns the unique identifier of the created tab.
+     * @param input JSON input
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Promise with the value of tab ID as String.
+     * @remarks Use this API only when the focused session belongs to the provider or if it is the home or default session.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/createtab External Link: createTab}
+     */
+    export function createTab(input: TabInput,correlationId?: string): Promise<string>;
+
+    /**
+     * Sets the focus on a tab, if:
+     * - The focused session belongs to the provider or if it is either the home or default session.
+     * - The tab belongs to the session in focus.
+     * @param tabId Unique identifier of the tab
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Promise with no value.
+     * @remarks Use this API only when the focused session belongs to the provider or if it is the home or default session.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/focustab External Link: focusTab}
+     */
+    export function focusTab(tabId: string, correlationId?: string): Promise<void>;
+
+    /**
+     * Returns the focused tab's identifier in a focused session, if the session belongs to the channel provider.
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Promise with the value as String
+     * @remarks Use this API only when the focused session belongs to the provider or if it is the home or default session.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/getfocusedtab External Link: getFocusedTab}
+     */
+    export function getFocusedTab(correlationId?: string): Promise<string>;
+
+    /**
+     * Returns an array of tab Ids associated with template name or template tags for tabs in the session in focus, if the session belongs to the channel provider.
+     * @param tabtemplatename Unique Name of the application tab template
+     * @param tags Tags associated with the application tab
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Promise with the value of tab ID as String.
+     * @remarks Use this API only when the focused session belongs to the provider or if it is the home or default session.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/gettabs External Link: getTabs}
+     */
+    export function getTabs(tabtemplatename?: string, tags?:string, correlationId?: string): Promise<string[]>;
+
+    /**
+     * Refreshes the tab.
+     * @param tabId Unique identifier of the tab
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Promise with no value.
+     * @remarks Use this API only when the focused session belongs to the provider or if it is the home or default session.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/refreshtab External Link: refreshTab}
+     */
+    export function refreshTab(tabId: string, correlationId?: string): Promise<void>;
+
+    /**
+     * Refreshes the tab.
+     * @param tabId Unique identifier of the tab
+     * @param title JSON containing the title of the tab.
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns none.
+     * @remarks Use this API only when the focused session belongs to the provider or if it is the home or default session.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/settabtitle External Link: setTabTitle}
+     */
+    export function setTabTitle(tabId: string, title: TabTitle, correlationId?: string): Promise<void>;
+
+    export type TabInput = {
+      /**
+       * Unique name of the tab 
+       */
+      templateName: string;
+
+      /**
+       * Additional context for tab creation and tab slugs
+       */
+      templateParameters?: { [key: string]: string;};
+
+      /**
+       * Should this tab be focused after the creation
+       */
+      isFocused?: boolean;
+    };
+
+    export type TabTitle = {
+        title: string;
+    }
+  }
+}

package/v2.0/ChannelAnalytics.d.ts

@@ -0,0 +1,64 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * Invoke this method to log analytics for custom events.
+     * @param data Key-value pairs representing the analytics data to be logged.
+     * @param eventName Name of the event to be logged.
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns Promise with value as string
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/loganalyticsevent External Link: logAnalyticsEvent}
+     */
+    export function logAnalyticsEvent(data: AnalyticsData, eventName:string, correlationId?: string): Promise<string>;
+
+    interface AnalyticsData {
+      /**
+       * Conversation identifier
+       */
+      conversationId?: string;
+      /**
+       * Channel Integration Framework Provider Id
+       */
+      providerSessionId?: string;
+      /**
+       * Client session identifier
+       */
+      clientSessionId?: string;
+      /**
+       * Participant identifier
+       */
+      participantId?: string;
+      events?: AnalyticsEventData[];
+    }
+
+    interface AnalyticsEventData{
+      /**
+       * Name of the associated KPI event
+       */
+      kpiEventName?: string;
+      /**
+       * Reason due to which the KPI event was created
+       */
+      kpiEventReason?: string;
+      /**
+       * Timestamp at which the event occurred
+       */
+      eventTimestamp?: string;
+      /**
+       * Additional data related to the session
+       */
+      additionalData?: string;
+      /**
+       * Agent notification response action value
+       */
+      notificationResponseAction?: string;
+      /**
+       * External system correlation Id
+       */
+      externalCorrelationId?: string;
+      /**
+       * Custom data
+       */
+      customData?: {attribute: string; value: string}[];
+    }
+  }
+}

package/v2.0/ClickToAct.d.ts

@@ -18,6 +18,6 @@ declare namespace Microsoft {
     export function setClickToAct(
       value: boolean,
       correlationId?: string
-    ): Promise<boolean>;
+    ): Promise<void>;
   }
 }

package/v2.0/Conversation.d.ts

@@ -1,7 +1,7 @@
 declare namespace Microsoft {
   namespace CIFramework {
     /**
-     * This method allows you to update a Conversation(msdyn_ocliveworkitem) record.
+     * This method allows you to update a Conversation({@link https://learn.microsoft.com/en-us/dynamics365/customer-service/develop/reference/entities/msdyn_ocliveworkitem 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

package/v2.0/Notification.d.ts

@@ -29,7 +29,7 @@ declare namespace Microsoft {
      * @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.
+     * @returns Returns a Promise with a string value.
      * @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();
@@ -53,7 +53,10 @@ declare namespace Microsoft {
     export function notifyEvent(
       input: NotifyEventArgs,
       correlationId?: string
-    ): Promise<string>;
+    ): Promise<'{actionName: "Timeout", responseReason: "DisplayTimeout"}' | 
+               '{actionName: "Reject", responseReason: "DeclinedByAgent"}' |
+               '{"actionName":"Accept","responseReason":"Accept"}' |
+               void>;
 
     export interface NotifyEventArgs {
       eventType?: string;

package/v2.0/Presence.d.ts

@@ -2,6 +2,7 @@ declare namespace Microsoft {
   namespace CIFramework {
     /**
      * Returns the presence text of the agent in the client session.
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
      * @returns Promise with the presence text of the current agent, as String.
      * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/getpresence External Link: getPresence}
      * @example
@@ -21,11 +22,12 @@ declare namespace Microsoft {
      *             });
      *     });
      */
-    export function getPresence(): Promise<string>;
+    export function getPresence(correlationId?: string): Promise<string>;
 
     /**
      * 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} .
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry 
      * @returns Returns a Boolean value of success.
      * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/setpresence External Link: setPresence}
      * @example
@@ -41,6 +43,6 @@ declare namespace Microsoft {
      *   });
      *
      */
-    export function setPresence(presenceText: string): Promise<boolean>;
+    export function setPresence(presenceText: string, correlationId?: string): Promise<boolean>;
   }
 }

package/v2.0/Session.d.ts

@@ -36,22 +36,6 @@ declare namespace Microsoft {
       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
@@ -66,7 +50,7 @@ declare namespace Microsoft {
      * @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>;
+    export function getFocusedSession(correlationId?: string): 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.
@@ -90,5 +74,56 @@ declare namespace Microsoft {
       sessionId: string,
       correlationId?: string
     ): Promise<string>;
+
+    /**
+     * Shows a notification indicator on the session whose Session Id is passed as a parameter, if the session belongs to the channel provider. The notification indicator draws the user's attention to switch between sessions.
+     * @param sessionId Id of the session to be focused.
+     * @param correlationId Used to group all related API calls together for diagnostic telemetry
+     * @returns None.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v2/develop/reference/microsoft-ciframework/requestfocussession External Link: requestFocusSession}
+     */
+    export function requestFocusSession(sessionId: string, correlationId?: string): Promise<void>;
+
+    /**
+     * 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
+     * var input = {
+     *     sessionId: "session-id-16",
+     *     customer: "John"
+     * };
+     * // setSessionTitle needs two params in input bag.
+     * // 1. sessionId
+     * // 2. slug name which we use in title field of session template record.. In sample, we have given value as "Call from {customer}"
+     * // hence we pass "customer" in the input bag parameter.
+     * Microsoft.CIFramework.setSessionTitle(input);
+     */
+    export function setSessionTitle(
+      input: SessionInfo,
+      correlationId?: string
+    ): Promise<string>;
+
+    interface SessionInfo {
+      [prop:string]: 'sessionId' extends typeof prop? string :  number | boolean | string;
+    }
+
+    /**
+     * 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;       
+      };
+    }
   }
 }

package/v2.0/index.d.ts

@@ -1,3 +1,5 @@
+/// <reference path="./ApplicationTabManagement.d.ts" />
+/// <reference path="./ChannelAnalytics.d.ts" />
 /// <reference path="./ClickToAct.d.ts" />
 /// <reference path="./Context.d.ts" />
 /// <reference path="./Conversation.d.ts" />