@albanian-xrm/cif-types 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 AlbanianXrm
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +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).
+
+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/index.d.ts

@@ -0,0 +1 @@
+/// <reference path="./v2.0/index.d.ts" />

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@albanian-xrm/cif-types",
+  "version": "0.1.0",
+  "description": "Microsoft.CIFramework types from the community (us).",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/albanian-xrm/cif-types.git"
+  },
+  "keywords": [
+    "cif",
+    "channel-integration-framework",
+    "dataverse"
+  ],
+  "author": "AlbanianXrm",
+  "license": "MIT",
+  "types": "./index.d.ts",
+  "bugs": {
+    "url": "https://github.com/albanian-xrm/cif-types/issues"
+  },
+  "homepage": "https://github.com/albanian-xrm/cif-types#readme"
+}

package/tsconfig.json

@@ -0,0 +1,5 @@
+{
+    "compilerOptions": {
+        "typeRoots": ["./index.d.ts"]
+    }
+}

package/v1.0/CRUD.d.ts

@@ -0,0 +1,142 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * Creates an entity record.
+     * @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}
+     * @example
+     * var entityLogicalName = "contact";
+     * var data = {
+     *    "firstname": "Sample",
+     *    "lastname": "Contact",
+     *    "fullname": "Sample Contact",
+     *    "emailaddress1": "contact@contoso.com",
+     *    "jobtitle": "Sr. Marketing Manager",
+     *    "telephone1": "555-0109",
+     *    "description": "Default values for this record were set programmatically."
+     * }
+     * // create contact record
+     * var jsonData = JSON.stringify(data);
+     * Microsoft.CIFramework.createRecord(entityLogicalName,jsonData).then(
+     *     function success (result) {
+     *       res=JSON.parse(result);
+     *           console.log("Contact created with ID: " + res.id);
+     *           //perform operations on record creation
+     *       },
+     *       function (error) {
+     *           console.log(error);
+     *           //handle error conditions
+     *       }
+     *   );
+     */
+    export function createRecord(
+      entityLogicalName: string,
+      data: string
+    ): Promise<string>;
+
+    /**
+     * Retrieves an entity record.
+     * @param entityLogicalName The entity logical name of the record you want to retrieve. For example: "account".
+     * @param id GUID of the entity record you want to retrieve.
+     * @param options OData system query options, `$select` and `$expand`, to retrieve your data.
+     *   * Use the `$select` system query option to limit the properties returned by including a comma-separated list of property names. This is an important performance best practice. If properties aren’t specified using `$select`, all properties will be returned.
+     *   * Use the `$expand` system query option to control what data from related entities is returned. If you just include the name of the navigation property, you’ll receive all the properties for related records. You can limit the properties returned for related records using the `$select` system query option in parentheses after the navigation property name. Use this for both single-valued and collection-valued navigation properties.
+     *
+     *    You specify the query options starting with `?`. You can also specify multiple query options by using `&` to separate the query options. For example:
+     *    ```text
+     *    ?$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}
+     * @example
+     * // retrieve contact record
+     * var id = "b44d31ac-5fd1-e811-8158-000d3af97055";
+     * var entityLogicalName = "contact";
+     * Microsoft.CIFramework.retrieveRecord(entityLogicalName, id, "?$select=fullname,telephone1").then(
+     *     function success(result) {
+     *       res=JSON.parse(result);
+     *         console.log(`Retrieved values: Full Name: ${res.fullname}, Telephone Number: ${res.telephone1}`);
+     *         // perform operations on record retrieval
+     *     },
+     *     function (error) {
+     *         console.log(error.message);
+     *         // handle error conditions
+     *     }
+     * );
+     */
+    export function retrieveRecord(
+      entityLogicalName: string,
+      id: string,
+      options?: string
+    ): Promise<string>;
+
+    /**
+     * Updates an entity record.
+     * @param entityLogicalName The entity logical name of the record you want to update. For example: "account".
+     * @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}
+     * @example
+     * //// define the data to update a record
+     * var entityLogicalName = "contact";
+     * var data = {
+     *     "firstname": "Updated Sample",
+     *     "lastname": "Contact",
+     *     "fullname": "Updated Sample Contact",
+     *     "emailaddress1": "contact@contoso.com",
+     *     "jobtitle": "Sr. Marketing Manager",
+     *     "telephone1": "555-0109",
+     *     "description": "Updated values for this record were set programmatically."
+     * }
+     * // update contact record
+     * var id = "b44d31ac-5fd1-e811-8158-000d3af97055";
+     * var jsonData = JSON.stringify(data);
+     * Microsoft.CIFramework.updateRecord(entityLogicalName,id,jsonData).then(
+     *     function success (result) {
+     *       res=JSON.parse(result);
+     *           console.log("Contact updated with ID: " + res.id);
+     *           //the record is updated
+     *       },
+     *       function (error) {
+     *           console.log(error);
+     *           //handle error conditions
+     *       }
+     *   );
+     */
+    export function updateRecord(
+      entityLogicalName: string,
+      id: string,
+      data: string
+    ): Promise<string>;
+  }
+
+  /**
+   * Deletes an entity record.
+   * @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}
+   * @example
+   * // delete contact record  with the id=b44d31ac-5fd1-e811-8158-000d3af97055d
+   * var id = "b44d31ac-5fd1-e811-8158-000d3af97055";
+   * var entityLogicalName = "contact";
+   * Microsoft.CIFramework.deleteRecord(entityLogicalName, id).then(
+   *     function success(result) {
+   *       res=JSON.parse(result);
+   *       console.log("Contact deleted with ID: " + res.contactid);
+   *       // the record is deleted
+   *     },
+   *     function (error) {
+   *         console.log(error.message);
+   *         // handle error conditions
+   *     }
+   * );
+   */
+  export function deleteRecord(
+    entityLogicalName: string,
+    id: string
+  ): Promise<string>;
+}

package/v1.0/ClickToAct.d.ts

@@ -0,0 +1,18 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * 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}
+     */
+    export function getClickToAct(): Promise<boolean>;
+
+    /**
+     * 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}
+     */
+    export function setClickToAct(value: boolean): Promise<boolean>;
+  }
+}

package/v1.0/EntityMetadata.d.ts

@@ -0,0 +1,501 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * 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}
+     */
+    export function getEntityMetadata(
+      entityName: string,
+      attributes?: string[]
+    ): Promise<EntityMetadata>;
+
+    export interface EntityMetadata {
+      /**
+       * Whether a custom activity should appear in the activity menus in the Web application.
+       * - `0` indicates that the custom activity doesn't appear
+       * - `1` indicates that it does appear.
+       */
+      ActivityTypeMask: 0 | 1;
+
+      /**
+       * Indicates whether to automatically move records to the owner’s default queue when a record of this type is created or assigned.
+       */
+      AutoRouteToOwnerQueue: boolean;
+
+      /**
+       * @warning For internal use only.
+       */
+      CanEnableSyncToExternalSearchIndex: boolean;
+
+      /**
+       * Indicates whether the entity can trigger a workflow process.
+       */
+      CanTriggerWorkflow: boolean;
+
+      /**
+       * Description for the entity.
+       */
+      Description: string;
+
+      /**
+       * Plural display name for the entity.
+       */
+      DisplayCollectionName: string;
+
+      /**
+       * Display name for the entity.
+       */
+      DisplayName: string;
+
+      /**
+       * Indicates whether the entity will enforce custom state transitions.
+       */
+      EnforceStateTransitions: boolean;
+
+      /**
+       * The hexadecimal code to represent the color to be used for this entity in the application.
+       */
+      EntityColor: string;
+
+      /**
+       * The name of the Web API entity set for this entity.
+       */
+      EntitySetName: string;
+
+      /**
+       * Indicates whether activities are associated with this entity.
+       */
+      HasActivities: boolean;
+
+      /**
+       * Indicates whether the entity is an activity.
+       */
+      IsActivity: boolean;
+
+      /**
+       * Indicates whether the email messages can be sent to an email address stored in a record of this type.
+       */
+      IsActivityParty: boolean;
+
+      /**
+       * Indicates whether the entity is enabled for business process flows.
+       */
+      IsBusinessProcessEnabled: boolean;
+
+      /**
+       * Indicates whether the entity is a business process flow entity.
+       */
+      IsBPFEntity: boolean;
+
+      /**
+       * Indicates whether the entity is a child entity.
+       */
+      IsChildEntity: boolean;
+
+      /**
+       * Indicates whether connections are enabled for this entity.
+       */
+      IsConnectionsEnabled: boolean;
+
+      /**
+       * Indicates whether the entity is a custom entity.
+       */
+      IsCustomEntity: boolean;
+
+      /**
+       * Indicates whether the entity is customizable.
+       */
+      IsCustomizable: boolean;
+
+      /**
+       * Indicates whether document management is enabled.
+       */
+      IsDocumentManagementEnabled: boolean;
+
+      /**
+       * Indicates whether the document recommendations are enabled.
+       */
+      IsDocumentRecommendationsEnabled: boolean;
+
+      /**
+       * Indicates whether duplicate detection is enabled.
+       */
+      IsDuplicateDetectionEnabled: boolean;
+
+      /**
+       * Indicates whether charts are enabled.
+       */
+      IsEnabledForCharts: boolean;
+
+      /**
+       * Indicates whether the entity can be imported using the Import Wizard.
+       */
+      IsImportable: boolean;
+
+      /**
+       * Indicates the entity is enabled for interactive experience.
+       */
+      IsInteractionCentricEnabled: boolean;
+
+      /**
+       * Indicates whether knowledge management is enabled for the entity.
+       */
+      IsKnowledgeManagementEnabled: boolean;
+
+      /**
+       * Indicates whether mail merge is enabled for this entity.
+       */
+      IsMailMergeEnabled: boolean;
+
+      /**
+       * Indicates whether the entity is part of a managed solution.
+       */
+      IsManaged: boolean;
+
+      /**
+       * Indicates whether OneNote integration is enabled for the entity.
+       */
+      IsOneNoteIntegrationEnabled: boolean;
+
+      /**
+       * Indicates whether optimistic concurrency is enabled for the entity.
+       */
+      IsOptimisticConcurrencyEnabled: boolean;
+
+      /**
+       * Indicates whether the entity is enabled for quick create forms.
+       */
+      IsQuickCreateEnabled: boolean;
+
+      /**
+       * Indicates whether the entity supports setting custom state transitions.
+       */
+      IsStateModelAware: boolean;
+
+      /**
+       * Indicates whether the entity is shown in Advanced Find.
+       */
+      IsValidForAdvancedFind: boolean;
+
+      /**
+       * Indicates whether Microsoft Dynamics 365 for tablets users can see data for this entity.
+       */
+      IsVisibleInMobileClient: boolean;
+
+      /**
+       * Indicates whether the entity is enabled for Unified Interface.
+       */
+      IsEnabledInUnifiedInterface: boolean;
+
+      /**
+       * The logical collection name.
+       */
+      LogicalCollectionName: string;
+
+      /**
+       * The logical name for the entity.
+       */
+      LogicalName: string;
+
+      /**
+       * The entity type code.
+       */
+      ObjectTypeCode: number;
+
+      /**
+       * The ownership type for the entity: `UserOwned` or `OrganizationOwned`.
+       */
+      OwnershipType: "UserOwned" | "OrganizationOwned";
+
+      /**
+       * The name of the attribute that is the primary ID for the entity.
+       */
+      PrimaryIdAttribute: string;
+
+      /**
+       * The name of the primary image attribute for an entity.
+       */
+      PrimaryImageAttribute: string;
+
+      /**
+       * The name of the primary attribute for an entity.
+       */
+      PrimaryNameAttribute: string;
+
+      /**
+       * The privilege metadata for the entity where each object contains the following attributes to define the security privilege for access to an entity
+       */
+      Privileges: EntityPrivilege[];
+
+      /**
+       * A collection of attribute metadata objects. The object returned depends on the type of attribute metadata.
+       */
+      Attributes: (
+        | Attributes.BaseAttribute
+        | Attributes.BooleanAttribute
+        | Attributes.EnumAttribute
+        | Attributes.PicklistAttribute
+        | Attributes.StateAttribute
+        | Attributes.StatusAttribute
+      )[];
+    }
+
+    namespace Attributes {
+      export interface BaseAttribute {
+        /**
+         * Type of an attribute. For a list of attribute type values, see {@link AttributeTypeCode}
+         */
+        AttributeType: AttributeTypeCode;
+
+        /**
+         *  Display name for the attribute.
+         */
+        DisplayName: string;
+
+        /**
+         *  Logical name of the entity that contains the attribute.
+         */
+        EntityLogicalName: string;
+
+        /**
+         * Logical name for the attribute.
+         */
+        LogicalName: string;
+      }
+
+      export interface BooleanAttribute extends BaseAttribute {
+        /**
+         *  Default value for a Boolean option set.
+         */
+        DefaultFormValue: boolean;
+
+        /**
+         * Options for the boolean attribute where each option is a key:value pair.
+         */
+        OptionSet: { [key in 0 | 1]: string };
+      }
+
+      export interface EnumAttribute extends BaseAttribute {
+        /**
+         * Options for the attribute where each option is a key:value pair.
+         */
+        OptionSet: { [key: number]: string };
+      }
+
+      export interface PicklistAttribute extends BaseAttribute {
+        /**
+         * Default form value for the attribute.
+         */
+        DefaultFormValue: number;
+
+        /**
+         * Options for the attribute where each option is a key:value pair.
+         */
+        OptionSet: { [key: number]: string };
+      }
+
+      export interface StateAttribute extends BaseAttribute {
+        /**
+         * Options for the attribute where each option is a key:value pair.
+         */
+        OptionSet: { [key: number]: string };
+
+        /**
+         * @param arg state value
+         * @returns default status (number) based on the passed in state value for an entity
+         * @remarks For default state and status values for an entity, see entity metadata information of the entity in {@link External Link: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/reference/about-entity-reference entity reference}.
+         */
+        getDefaultStatus(arg: number): number;
+
+        /**
+         * @param arg state value
+         * @returns possible status values (array of numbers) for a specified state value
+         * @remarks For state and status values for an entity, see entity metadata information of the entity in {@link External Link: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/reference/about-entity-reference entity reference}.
+         */
+        getStatusValuesForState(arg: number): number[];
+      }
+
+      export interface StatusAttribute extends BaseAttribute {
+        /**
+         * Options for the attribute where each option is a key:value pair.
+         */
+        OptionSet: { [key: number]: string };
+
+        /**
+         * @param arg status value
+         * @returns the state value (number) for the specified status value (number).
+         * @remarks For default state and status values for an entity, see entity metadata information of the entity in {@link External Link: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/reference/about-entity-reference entity reference}.
+         */
+        getState(arg: number): number;
+      }
+
+      /**
+       * Describes the type of an attribute.
+       * @see {@link https://learn.microsoft.com/en-us/dotnet/api/microsoft.xrm.sdk.metadata.attributetypecode External Link: Microsoft.Xrm.Sdk.Metadata.AttributeTypeCode}
+       */
+      export const enum AttributeTypeCode {
+        /**
+         * A big integer attribute.
+         */
+        BigInt = 18,
+        /**
+         * A Boolean attribute.
+         */
+        Boolean = 0,
+        /**
+         * An attribute that contains calendar rules.
+         */
+        CalendarRules = 16,
+
+        /**
+         * 	An attribute that represents a customer.
+         */
+        Customer = 1,
+        /**
+         * A date/time attribute.
+         */
+        DateTime = 2,
+
+        /**
+         * A decimal attribute.
+         */
+        Decimal = 3,
+
+        /**
+         * A double attribute.
+         */
+        Double = 4,
+
+        /**
+         * An entity name attribute.
+         */
+        EntityName = 20,
+
+        /**
+         * An integer attribute.
+         */
+        Integer = 5,
+
+        /**
+         * A lookup attribute.
+         */
+        Lookup = 6,
+
+        /**
+         * A managed property attribute.
+         */
+        ManagedProperty = 19,
+
+        /**
+         * A memo attribute.
+         */
+        Memo = 7,
+
+        /**
+         * A money attribute.
+         */
+        Money = 8,
+
+        /**
+         * An owner attribute.
+         */
+        Owner = 9,
+
+        /**
+         * A partylist attribute.
+         */
+        PartyList = 10,
+
+        /**
+         * A picklist attribute.
+         */
+        Picklist = 11,
+
+        /**
+         * A state attribute.
+         */
+        State = 12,
+
+        /**
+         * A status attribute.
+         */
+        Status = 13,
+
+        /**
+         * A string attribute.
+         */
+        String = 14,
+
+        /**
+         * An attribute that is an ID.
+         */
+        Uniqueidentifier = 15,
+
+        /**
+         * An attribute that is created by the system at run time.
+         */
+        Virtual = 17,
+      }
+    }
+
+    export interface EntityPrivilege {
+      /**
+       * Whether the privilege can be basic access level.
+       */
+      CanBeBasic: boolean;
+
+      /**
+       * Whether the privilege can be deep access level.
+       */
+      CanBeDeep: boolean;
+
+      /**
+       * Whether the privilege for an external party can be basic access level.
+       */
+      CanBeEntityReference: boolean;
+
+      /**
+       * Whether the privilege can be global access level.
+       */
+      CanBeGlobal: boolean;
+
+      /**
+       * Whether the privilege can be local access level.
+       */
+      CanBeLocal: boolean;
+
+      /**
+       * Whether the privilege for an external party can be parent access level.
+       */
+      CanBeParentEntityReference: boolean;
+
+      /**
+       * The name of the privilege.
+       */
+      Name: string;
+
+      /**
+       * The ID of the privilege.
+       */
+      PrivilegeId: string;
+
+      /**
+       * The type of privilege, which is one of the following: {@link EntityPrivilegeType}
+       */
+      PrivilegeType: EntityPrivilegeType;
+    }
+
+    export const enum EntityPrivilegeType {
+      None = 0,
+      Create = 1,
+      Read = 2,
+      Write = 3,
+      Delete = 4,
+      Assign = 5,
+      Share = 6,
+      Append = 7,
+      AppendTo = 8,
+    }
+  }
+}

package/v1.0/Environment.d.ts

@@ -0,0 +1,25 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * 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}
+     */
+    export function getEnvironment(): Promise<string>;
+
+    export interface Environment {
+      /**
+       * Application ID
+       */
+      appid: string;
+      /**
+       * Page type
+       */
+      pagetype: string;
+      /**
+       * Record ID
+       */
+      id: string;
+    }
+  }
+}

package/v1.0/PanelMode.d.ts

@@ -0,0 +1,31 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * The value to set the mode of the panel.
+     */
+    export const enum PanelMode {
+      /**
+       * Enter 0 to minimize the panel.
+       */
+      Minimized = 0,
+      /**
+       * Enter 1 to dock the panel.
+       */
+      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

@@ -0,0 +1,21 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * 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}
+     */
+    export function getWidth(): Promise<number>;
+
+    /**
+     * Sets the panel width for all the sessions.
+     * @param value The width of the panel in pixels.
+     * @remarks
+     * - 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}
+     */
+    export function setWidth(value: number): Promise<void>;
+  }
+}

package/v1.0/Search.d.ts

@@ -0,0 +1,80 @@
+declare namespace Microsoft {
+  namespace CIFramework {
+    /**
+     * 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.
+     * @param queryParameters OData system query options, `$select` and `$expand`, to retrieve your data.
+     *   * Use the `$select` system query option to limit the properties returned by including a comma-separated list of property names. This is an important performance best practice. If properties aren’t specified using `$select`, all properties will be returned.
+     *   * Use the `$expand` system query option to control what data from related entities is returned. If you just include the name of the navigation property, you’ll receive all the properties for related records. You can limit the properties returned for related records using the `$select` system query option in parentheses after the navigation property name. Use this for both single-valued and collection-valued navigation properties.
+     *
+     *    You specify the query options starting with `?`. You can also specify multiple query options by using `&` to separate the query options. For example:
+     *    ```text
+     *    ?$select=name&$expand=primarycontactid($select=contactid,fullname)
+     *    ```
+     * @param searchOnly Set the searchOnly to false when you want the search to display a single record based on the search context.
+     *    If the search result has multiple records and if you've used queryParameters to indicate the search option, then setting
+     *    searchOnly to false opens and populates the search page with the search option.
+     *    `Note:` If the search result has multiple records, then records for `Account`, `Contact`, and `Activity` entities only are opened.
+     * @param correlationId Is used to group all related API calls together for diagnostic telemetry. GUID.
+     * @param searchType 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.
+     * @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}
+     * @example
+     * // retrieve contact record
+     * Microsoft.CIFramework.searchAndOpenRecords("contact", "?$select=fullname,telephone1", false).
+     * then(
+     *     function success(result) {
+     *     res=JSON.parse(result);
+     *         console.log(`Record values: Full Name: ${res[0].fullname}, Telephone Number: ${res[0].telephone1}`);
+     *         // perform operations on record retrieval and opening
+     *     },
+     *     function (error) {
+     *         console.log(error.message);
+     *         // handle error conditions
+     *     }
+     * );
+     *
+     * @example
+     * // Retrieve Contact entity record
+     * // Change searchOnly parameter to true, if you do not want to open the search results page
+     * Microsoft.CIFramework.searchAndOpenRecords("contact", "?$select=fullname,telephone1&$filter=firstname eq 'Contoso'&$search=Contoso", false).
+     * then(
+     *     function success(result) {
+     *     res=JSON.parse(result);
+     *         console.log(`The caller name is: ${res[0].fullname}, Telephone Number: ${res[0].telephone1}`);
+     *         // perform operations on record retrieval and opening
+     *     },
+     *     function (error) {
+     *         console.log(error.message);
+     *         // handle error conditions
+     *     }
+     * );
+     */
+    export function searchAndOpenRecords(
+      entityLogicalName: string,
+      queryParameters: string,
+      searchOnly: boolean,
+      correlationId?: string,
+      searchType?: SearchType
+    ): 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}.
+     */
+    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

@@ -0,0 +1,7 @@
+/// <reference path="./ClickToAct.d.ts" />
+/// <reference path="./CRUD.d.ts" />
+/// <reference path="./EntityMetadata.d.ts" />
+/// <reference path="./Environment.d.ts" />
+/// <reference path="./PanelMode.d.ts" />
+/// <reference path="./PanelWidth.d.ts" />
+/// <reference path="./Search.d.ts" />

package/v1.0/tsconfig.json

@@ -0,0 +1,5 @@
+{
+    "compilerOptions": {
+        "typeRoots": ["./index.d.ts"]
+    }
+}

package/v2.0/PanelMode.d.ts

@@ -0,0 +1,11 @@
+/// <reference path="../v1.0/PanelMode.d.ts" />
+declare namespace Microsoft {
+  namespace CIFramework {
+    export const enum PanelMode {
+      /**
+       * Enter 2 to hide the panel.
+       */
+      Hidden = 2,
+    }
+  }
+}

package/v2.0/index.d.ts

@@ -0,0 +1,7 @@
+/// <reference path="../v1.0/ClickToAct.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="./PanelMode.d.ts" />
+/// <reference path="../v1.0/PanelWidth.d.ts" />
+/// <reference path="../v1.0/Search.d.ts" />

package/v2.0/tsconfig.json

@@ -0,0 +1,5 @@
+{
+    "compilerOptions": {
+        "typeRoots": ["./index.d.ts"]
+    }
+}