@coveo/platform-client 35.0.0

package/dist/definitions/resources/InsightPanelConfigs/InsightPanelConfigInterfaces.d.ts

@@ -0,0 +1,158 @@
+import { WithRequiredProperty } from '../../utils';
+import { Paginated } from '../BaseInterfaces';
+/**
+ * Defines the options to list Insight Panel configurations.
+ */
+export interface InsightPanelConfigListOptions extends Paginated {
+    /**
+     * The zero-based page to retrieve.
+     *
+     * @default `0`
+     */
+    page?: number;
+    /**
+     * The number of configurations to return per page.
+     *
+     * @default `10`
+     */
+    perPage?: number;
+    /**
+     * A substring that must appear in a search interface configuration name for this configuration to appear in results.
+     */
+    filter?: string;
+    /**
+     * The sort order to apply on the Insight Panel configuration name.
+     *
+     * **Allowed values:**
+     * - `undefined`: Configurations are returned in no specific order.
+     * - `asc`: Sort configurations by name in ascending order.
+     * - `desc`: Sort configurations by name in descending order.
+     *
+     * @default `undefined`
+     */
+    order?: 'asc' | 'desc';
+}
+/**
+ * Defines the parameters required to create an Insight Panel configuration.
+ */
+export interface InsightPanelConfigCreationParams {
+    /**
+     * The ID of the Insight Panel configuration.
+     */
+    id: string;
+    /**
+     * The name of the Insight Panel configuration.
+     */
+    name: string;
+    /**
+     * The ID of the associated query pipeline.
+     */
+    pipeline: string;
+    /**
+     * The context field mappings to use when performing queries. This mapping allows an Insight Panel integration to retrieve the context information from the CRM and pass it to the Coveo platform when executing Insight Panel queries.
+     *
+     * The key is the context information such as `subject` or `description`.
+     *
+     * The value is a CRM reference allowing the Insight Panel integration to retrieve the context information from the CRM.
+     *
+     * @example
+     * ```json
+     * {
+     *   "subject": "Case_subject",
+     *   "description": "Case_description"
+     * }
+     * ```
+     */
+    contextFields?: Record<string, string>;
+}
+/**
+ * Defines the parameters required to update an Insight Panel configuration.
+ */
+export interface InsightPanelConfigUpdateParams extends WithRequiredProperty<InsightPanelConfigCreationParams, 'contextFields'> {
+    /**
+     * A list of the associated interface configs.
+     */
+    interfaces?: string[];
+}
+/**
+ * Defines an Insight Panel configuration.
+ */
+export interface InsightPanelConfigModel {
+    /**
+     * The Insight Panel configuration ID.
+     */
+    id: string;
+    /**
+     * The Insight Panel configuration name.
+     */
+    name: string;
+    /**
+     * The summary information specific to the associated query pipeline.
+     */
+    pipeline: {
+        /**
+         * The query pipeline ID.
+         */
+        id: string;
+        /**
+         * The query pipeline name.
+         */
+        name: string;
+        /**
+         * The associated ML models information.
+         */
+        models: {
+            /**
+             * Information related to the Automatic Relevance Tuning (ART) ML model.
+             */
+            art: {
+                /**
+                 * Indicates whether an ART ML model is configured in the query pipeline.
+                 */
+                enabled: boolean;
+            };
+            /**
+             * Information related to the Dynamic Navigation Experience (DNE) ML model.
+             */
+            dne: {
+                /**
+                 * Indicates whether a DNE ML model is configured in the query pipeline.
+                 */
+                enabled: boolean;
+            };
+            /**
+             * Information related to the Query Suggestions (QS) ML model.
+             */
+            qs: {
+                /**
+                 * Indicates whether a QS ML model is configured in the query pipeline.
+                 */
+                enabled: boolean;
+            };
+        };
+    };
+    /**
+     * The search hub value affected to this Insight Panel configuration.
+     */
+    searchHub: string;
+    /**
+     * The context field mappings to use when performing queries. This mapping allows an Insight Panel integration to retrieve the context information from the CRM and pass it to the Coveo platform when executing Insight Panel queries.
+     *
+     * The key is the context information such as `subject` or `description`.
+     *
+     * The value is a CRM reference allowing the Insight Panel integration to retrieve the context information from the CRM.
+     *
+     * @example
+     * ```json
+     * {
+     *   "subject": "Case_subject",
+     *   "description": "Case_description"
+     * }
+     * ```
+     */
+    contextFields: Record<string, string>;
+    /**
+     * A list of the associated interface configs.
+     */
+    interfaces: string[];
+}

package/dist/definitions/resources/InsightPanelConfigs/index.d.ts

@@ -0,0 +1,2 @@
+export * from './InsightPanelConfig';
+export * from './InsightPanelConfigInterfaces';

package/dist/definitions/resources/InsightPanelInterfaces/InsightPanelInterface.d.ts

@@ -0,0 +1,11 @@
+import { New, PageModel } from '../BaseInterfaces';
+import Resource from '../Resource';
+import { IListInsightPanelInterfacesParameters, InsightPanelInterfaceConfiguration } from './InsightPanelInterface.model';
+export default class InsightPanelInterface extends Resource {
+    static baseUrl: string;
+    list(options?: IListInsightPanelInterfacesParameters): Promise<PageModel<InsightPanelInterfaceConfiguration, "items">>;
+    create(ipInterfaceConfig: New<InsightPanelInterfaceConfiguration>): Promise<InsightPanelInterfaceConfiguration>;
+    delete(insightPanelInterfaceId: string): Promise<Record<string, unknown>>;
+    get(insightPanelInterfaceId: string): Promise<InsightPanelInterfaceConfiguration>;
+    update(ipInterfaceConfig: InsightPanelInterfaceConfiguration): Promise<InsightPanelInterfaceConfiguration>;
+}

package/dist/definitions/resources/InsightPanelInterfaces/InsightPanelInterface.model.d.ts

@@ -0,0 +1,240 @@
+import { Paginated } from '../BaseInterfaces';
+export declare enum InsightPanelConditionOperator {
+    isDefined = "isDefined",
+    isNotDefined = "isNotDefined",
+    MustMatch = "mustMatch",
+    MustNotMatch = "mustNotMatch"
+}
+export declare enum InsightPanelResultTemplateLayout {
+    Default = "default",
+    Thumbnail = "thumbnail"
+}
+interface InsightPanelOption {
+    enabled: boolean;
+}
+interface InsightPanelResultTagOptions {
+    enabled: boolean;
+    color: string;
+}
+export interface InsightPanelResultTemplateBadge {
+    /**
+     * The field who's value should be displayed in the badge.
+     */
+    field: string;
+    /**
+     * The text to display in the badge.
+     */
+    label?: string;
+    /**
+     * The RGB HEX code for the color of the badge.
+     */
+    color: string;
+}
+export interface InsightPanelCondition {
+    /**
+     * The [field](https://docs.coveo.com/en/200) to evaluate.
+     */
+    field: string;
+    /**
+     * The operator used to evaluate the field condition.
+     * Possible values are:
+     * - `'isDefined'`
+     * - `'isNotDefined'`
+     * - `'mustMatch'`
+     * - `'mustNotMatch'`
+     */
+    conditionType: InsightPanelConditionOperator;
+    /**
+     * The values used as the right side operand when the `operator` is one of:
+     * - `'mustMatch'`
+     * - `'mustNotMatch'`
+     */
+    values?: string[];
+}
+export interface InsightPanelResultTemplateDetail {
+    /**
+     * The [field](https://docs.coveo.com/en/200) containing the metadata to display.
+     */
+    field: string;
+    /**
+     * The label to show describing the metadata.
+     */
+    label: string;
+}
+export interface InsightPanelResultActions {
+    /**
+     * An option enabling the ability to attach a given result to a case record.
+     */
+    attachToCase?: InsightPanelOption;
+    /**
+     * An option enabling the ability to copy result metadata to the clipboard.
+     */
+    copyToClipboard?: InsightPanelOption;
+    /**
+     * An option enabling the ability to view the result document in a quick view modal.
+     */
+    quickView?: InsightPanelOption;
+    /**
+     * An option enabling the ability to send the result as an email.
+     */
+    sendAsEmail?: InsightPanelOption;
+    /**
+     * An option enabling the ability to send the result to the case feed.
+     */
+    sendToFeed?: InsightPanelOption;
+}
+export interface InsightPanelResultTags {
+    /**
+     * An option enabling a tag identifying results that have been viewed by the customer who submitted the case.
+     */
+    viewedByCustomer?: InsightPanelResultTagOptions;
+    /**
+     * An option enabling a tag identifying recommended results.
+     */
+    recommended?: InsightPanelResultTagOptions;
+}
+export interface InsightPanelResultTemplate {
+    /**
+     * The name of the result template.
+     */
+    name: string;
+    /**
+     * The template layout to use.
+     * Possible values are:
+     * - `'default'`
+     * - `'thumbnail'`
+     */
+    layout: InsightPanelResultTemplateLayout;
+    /**
+     * The conditions a result needs to meet to use the template.
+     */
+    conditions: InsightPanelCondition[];
+    /**
+     * The badge to display.
+     */
+    badge: InsightPanelResultTemplateBadge;
+    /**
+     * The metadata details to display.
+     */
+    details: InsightPanelResultTemplateDetail[];
+    /**
+     * The available result actions.
+     */
+    resultActions: InsightPanelResultActions;
+    /**
+     * The tags allowed to be displayed.
+     */
+    tags: InsightPanelResultTags;
+}
+export declare type DisplayValueType = 'checkbox' | 'link';
+export interface InsightPanelFacet {
+    /**
+     * The [field](https://docs.coveo.com/en/200) on which the facet is based.
+     */
+    field: string;
+    /**
+     * The label of the facet.
+     */
+    label: string;
+    /**
+     * Whether to display the facet values as checkboxes (multiple selection) or links (single selection).
+     * Possible values are:
+     * - `'checkbox'`
+     * - `'link'`
+     */
+    displayValuesAs: DisplayValueType;
+}
+export interface InsightPanelTab {
+    /**
+     * The label to be displayed in the tab.
+     */
+    label: string;
+    /**
+     * A constant query expression or filter that the Tab should add to any outgoing query.
+     *
+     * **Example:**
+     *
+     * `@objecttype==Message`
+     */
+    conditions: InsightPanelCondition[];
+}
+export interface UserActionsOptions {
+    /**
+     * Whether to enable the feature.
+     */
+    enabled: boolean;
+    /**
+     * Whether to show documents recently clicked by the user.
+     */
+    recentClickedDocuments: InsightPanelOption;
+    /**
+     * Whether to show recent queries performed by the user.
+     */
+    recentQueries: InsightPanelOption;
+    /**
+     * Whether to show a timeline of the user's actions.
+     */
+    timeline: InsightPanelOption;
+}
+export interface InsightPanelSettings {
+    /**
+     * Display a button to create a knowledge article.
+     */
+    createArticle: InsightPanelOption;
+    /**
+     * Display a button to open a full search page.
+     */
+    fullSearch: InsightPanelOption;
+    /**
+     * Options to configure a view of the actions taken by the user who submitted the case.
+     */
+    userActions: UserActionsOptions;
+}
+export interface InsightPanelInterfaceConfiguration {
+    /**
+     * The configuration identifier.
+     */
+    id: string;
+    /**
+     * The name of the insight panel interface configuration.
+     */
+    name: string;
+    /**
+     * The list of result templates defined for the insight panel.
+     */
+    resultTemplates: InsightPanelResultTemplate[];
+    /**
+     * The list of facets to display.
+     */
+    facets: InsightPanelFacet[];
+    /**
+     * The list of tabs to display.
+     */
+    tabs: InsightPanelTab[];
+    /**
+     * The insight panel settings.
+     */
+    settings: InsightPanelSettings;
+}
+export interface IListInsightPanelInterfacesParameters extends Paginated {
+    /**
+     * A substring that must appear in an insight panel interface configuration name for this configuration to appear in results.
+     */
+    filter?: string;
+    /**
+     * The sort direction of the results.
+     * Possible values:
+     * - `'asc'`: ascending order
+     * - `'desc'`: descending order.
+     */
+    order?: 'desc' | 'asc';
+    /**
+     * The 0-based number of the page of configurations to list.
+     */
+    page?: number;
+    /**
+     * The maximum number of configurations to include per page.
+     */
+    perPage?: number;
+}
+export {};

package/dist/definitions/resources/InsightPanelInterfaces/index.d.ts

@@ -0,0 +1,2 @@
+export * from './InsightPanelInterface';
+export * from './InsightPanelInterface.model';

package/dist/definitions/resources/InternalBaseInterface.d.ts

@@ -0,0 +1,12 @@
+export interface DeprecatedPaginated {
+    /**
+     * The 0-based index number of the page of elements to retrieve.
+     */
+    page?: number;
+    /**
+     * The number of elements to list per page.
+     *
+     * @deprecated use @see {Paginated} and @see {perPage} instead.
+     */
+    pageSize?: number;
+}

package/dist/definitions/resources/License/License.d.ts

@@ -0,0 +1,12 @@
+import { LicenseSection } from '../Enums';
+import Resource from '../Resource';
+import { LicenseExpirationDateOptions, LicenseModel, LicenseSourceTypeModel } from './LicenseInterfaces';
+export default class License extends Resource {
+    static baseUrl: string;
+    get(sectionName?: LicenseSection): Promise<LicenseModel>;
+    full(): Promise<LicenseModel>;
+    update(sectionName: LicenseSection, licenseSection: Record<string, number>): Promise<LicenseModel>;
+    updateLicense(license: LicenseModel): Promise<LicenseModel>;
+    updateExpirationDate(options: LicenseExpirationDateOptions): Promise<LicenseModel>;
+    getPossibleSourceTypes(): Promise<LicenseSourceTypeModel[]>;
+}

package/dist/definitions/resources/License/LicenseInterfaces.d.ts

@@ -0,0 +1,194 @@
+import { IndexBackupTypes, IndexType, ProductEdition, ProductName, ProductType, ScheduleType, SourceType, SourceVisibility } from '../Enums';
+export interface LicenseConnectorScheduleModel {
+    /**
+     * The refresh type of use for a given connector.
+     */
+    refreshType: string;
+    /**
+     * The frequency at which to refresh the connector.
+     */
+    scheduleFrequencies: ScheduleType[];
+}
+export interface LicenseConnectorModel {
+    /**
+     * Whether the connector is allowed to execute.
+     */
+    allowed: boolean;
+    /**
+     * A set of schedule models that are allowed to refresh the connector
+     */
+    allowedSchedules: LicenseConnectorScheduleModel[];
+    /**
+     * The visibility level of the connector
+     */
+    sourceVisibilities: SourceVisibility[];
+    /**
+     * The type of connector
+     */
+    type: SourceType;
+}
+export interface LicenseModel {
+    /**
+     * The unique identifier of the account that created the organization.
+     */
+    accountId: string;
+    /**
+     * The name of the account.
+     */
+    accountName: string;
+    /**
+     * A set of connectors that the license has access to.
+     */
+    connectors: LicenseConnectorModel[];
+    /**
+     * The department the organization was created for.
+     */
+    department: string;
+    /**
+     * A set of entitlements describing what the organization has access to.
+     */
+    entitlements: EntitlementModel[];
+    /**
+     * The date at which the license will expire in number of milliseconds since UNIX epoch.
+     */
+    expirationDate: number;
+    /**
+     * The index backup type in Coveo Cloud V2.
+     */
+    indexBackupType: IndexBackupTypes;
+    /**
+     * The type of index that is used for all sources in an organization.
+     */
+    indexType: IndexType;
+    /**
+     * The level of monitoring to apply to the license
+     */
+    monitoringLevel: LicenseMonitoringLevel;
+    /**
+     * The edition of Coveo Cloud in which the organization is registered as.
+     */
+    productEdition: ProductEdition;
+    /**
+     * The product integration of which the organization has been registered.
+     */
+    productName: ProductName;
+    /**
+     * The type of product integration in which the organization has been registered.
+     */
+    productType: ProductType;
+    /**
+     * Various properties/configurations settings that apply to the organization.
+     */
+    properties: any;
+    /**
+     * The type of the license
+     */
+    type: string;
+}
+export interface EntitlementModel {
+    itemLimit: number;
+    lrpmLimit: number;
+    id: string;
+    productId: string;
+    productName: string;
+    pricingUnit: string;
+    displayName: string;
+    qpmLimit: number;
+    recommendationLimit: number;
+    status: string;
+    unlimitedQPM: boolean;
+    unlimitedRecommendations: boolean;
+    unlimitedUsers: boolean;
+    useCase: string;
+    userLimit: number;
+}
+/**
+ * Simplified version of a License's LicenseConnectorModel
+ * Mostly used to list what's possible, compared to a license who will itself only list what's enabled
+ */
+export interface LicenseSourceTypeModel {
+    /**
+     * Type of Source, e.g.CATALOG, PUSH, WEB, SALESFORCE etc.
+     */
+    type: string;
+}
+/**
+ * Request parameters when updating an organization's expiration date
+ */
+export interface LicenseExpirationDateOptions {
+    /**
+     * Expiration date in epoch in milliseconds, e.g. 1625518417000
+     */
+    expirationDate: number;
+}
+/**
+ * Monitoring level determines the alerts raised when a problem is detected on an organization
+ */
+export declare enum LicenseMonitoringLevel {
+    /**
+     * The organization is completely ignored, no one will be alerted or try to save it if the search is down
+     */
+    NO_MONITORING = "NO_MONITORING",
+    /**
+     * The organization is monitored but problems are raised as low level alerts
+     * People on maintenance will try to fix the organization if they happen to look at the low-level alerting channels
+     */
+    BASIC_MONITORING = "BASIC_MONITORING",
+    /**
+     * The organization is actively monitored and problems raise pagers that would wake up on-duty developers at night
+     */
+    REGULAR_MONITORING = "REGULAR_MONITORING",
+    /**
+     * The organization is actively monitored with an aggressive schedule so any potential problem
+     * is identified under a minute
+     */
+    STRATEGIC_MONITORING = "STRATEGIC_MONITORING"
+}
+/**
+ * Back-up type determines which index data is backed-up periodically
+ */
+export declare enum LicenseIndexBackType {
+    /**
+     * The organization's index is not backed-up. If the organization is deleted all the data must be crawled again.
+     */
+    NONE = "NONE",
+    /**
+     * The organization's index is backed-up periodically. If the organization is deleted all the data can be restored.
+     */
+    REGULAR = "REGULAR",
+    /**
+     * The organization's index is backed-up periodically. If the organization is deleted all the data can be restored.
+     * Equivalent to REGULAR
+     */
+    FULL = "FULL"
+}
+/**
+ * Configurability level of ML models
+ */
+export declare enum LicenseMlModelConfigurability {
+    /**
+     * No advanced configurability available
+     */
+    NONE = "NONE",
+    /**
+     * All advanced configurability options available
+     */
+    FULL = "FULL"
+}
+/**
+ * Usage analytics visualization levels
+ */
+export declare enum LicenseDataVisualizationAccessLevel {
+    /**
+     * Basic access
+     */
+    BASIC = "BASIC",
+    /**
+     * Read access to Tableau data
+     */
+    TABLEAU_READ = "TABLEAU_READ",
+    /**
+     * Write access to Tableau data
+     */
+    TABLEAU_WRITE = "TABLEAU_WRITE"
+}

package/dist/definitions/resources/License/index.d.ts

@@ -0,0 +1,2 @@
+export * from './License';
+export * from './LicenseInterfaces';

package/dist/definitions/resources/Limits/Limits.d.ts

@@ -0,0 +1,12 @@
+import { LicenseSection } from '../Enums';
+import Resource from '../Resource';
+import { AllLimitsModel, LimitHistoryDataPointModel, LimitHistoryOptions, LimitsModel, LimitType } from './LimitsInterfaces';
+export default class Limits extends Resource {
+    static getBaseUrl: () => string;
+    static getWithSection: (sectionName: LicenseSection) => string;
+    static getWithSectionAndHistory: (sectionName: LicenseSection, limitKey: string) => string;
+    get(sectionName: LicenseSection): Promise<LimitsModel>;
+    getAll(): Promise<AllLimitsModel>;
+    getAllPerLimitType(limitType: LimitType): Promise<AllLimitsModel>;
+    getHistoryLimit(sectionName: LicenseSection, limitKey: string, options?: LimitHistoryOptions): Promise<LimitHistoryDataPointModel[]>;
+}

package/dist/definitions/resources/Limits/LimitsInterfaces.d.ts

@@ -0,0 +1,38 @@
+export interface LimitModel {
+    actualCount?: number;
+    limit: number;
+}
+export interface LimitsModel {
+    [name: string]: LimitModel;
+}
+export interface AllLimitsModel {
+    [name: string]: LimitsModel;
+}
+export declare enum LimitType {
+    USAGE = "USAGE",
+    TECHNICAL = "TECHNICAL"
+}
+export interface LimitHistoryDataPointModel {
+    /**
+     * The date at which the limit value was set in number of milliseconds since UNIX epoch.
+       Example: 1511049600000
+     */
+    date: number;
+    /**
+     * The limit value for the given date.
+       Example: 49624
+     */
+    limitValue: number;
+}
+export interface LimitHistoryOptions {
+    /**
+     * The beginning of the date range for which to show limit history in ISO 8601 format.
+     * Example:2022-05-08T01:30:00.000-05:00
+     */
+    from?: string;
+    /**
+     * The ending of the date range for which to show limit history in ISO 8601 format.
+     * Example:2022-05-08T01:30:00.000-05:00
+     */
+    to?: string;
+}

package/dist/definitions/resources/Limits/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Limits';
+export * from './LimitsInterfaces';