@albanian-xrm/cif-types 0.1.3 → 0.1.4

package/README.md

@@ -4,3 +4,16 @@ 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).
 
 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).
+
+
+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/index.d.ts"
+        ]
+    }
+```
+
+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.4",
   "description": "Microsoft.CIFramework types from the community (us).",
   "repository": {
     "type": "git",

package/v1.0/Form.d.ts

@@ -0,0 +1,176 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * Opens an entity form or a quick create form.
+     * @returns On success, returns a Promise object containing string.
+     * @see {@link https://learn.microsoft.com/en-us/dynamics365/customer-service/channel-integration-framework/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/index.d.ts

@@ -4,6 +4,7 @@
 /// <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/customer-service/channel-integration-framework/v2/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/customer-service/channel-integration-framework/v2/reference/microsoft-ciframework/setclicktoact External Link: setClickToAct}
+     */
+    export function setClickToAct(
+      value: boolean,
+      correlationId?: string
+    ): Promise<boolean>;
+  }
+}

package/v2.0/Context.d.ts

@@ -0,0 +1,31 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * This method allows you to set automation dictionary. It enables providers to add, modify and remove values of slugs and the updated values are subsequently available for future macro invocations.
+     * @param input JSON string
+     * @param sessionId Unique identifier of the current session.
+     * @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/v2/reference/microsoft-ciframework/updatecontext External Link: updateContext}
+     * @example
+     * var input = { "customerName" : "Contosso" };
+     * Microsoft.CIFramework.updateContext(input).then(
+     *     function success(result) {
+     *         console.log(result);
+     *         // Perform operations upon record retrieval and opening
+     *     },
+     *     function (error) {
+     *         console.log(error.message);
+     *         // Handle error conditions
+     *     }
+     * );
+     */
+    export function updateContext(
+      input: 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/customer-service/channel-integration-framework/v2/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

@@ -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/Session.d.ts

@@ -0,0 +1,86 @@
+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/customer-service/channel-integration-framework/v2/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/customer-service/channel-integration-framework/v2/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/customer-service/channel-integration-framework/v2/reference/microsoft-ciframework/getallsessions External Link: getAllSessions}
+     */
+    export function getAllSessions(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.
+     * @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/customer-service/channel-integration-framework/v2/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="./ClickToAct.d.ts" />
 /// <reference path="../v1.0/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" />