@coveo/platform-client 40.0.0 → 40.1.0

package/dist/types/resources/HostedInterfacesCore/HostedInterfaceCoreConfig.model.d.ts

@@ -0,0 +1,141 @@
+import { Paginated } from '../BaseInterfaces.js';
+export interface HostedInterfaceResultTemplateBadge {
+    /**
+     * 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 declare enum HostedInterfaceConditionOperator {
+    IsDefined = "isDefined",
+    IsNotDefined = "isNotDefined",
+    MustMatch = "mustMatch",
+    MustNotMatch = "mustNotMatch"
+}
+export interface HostedInterfaceCondition {
+    /**
+     * The [field](https://docs.coveo.com/en/200) to evaluate.
+     */
+    field: string;
+    /**
+     * The values used as the right side operand when the `operator` is one of:
+     * - `'mustMatch'`
+     * - `'mustNotMatch'`
+     */
+    values?: string[];
+    /**
+     * The operator used to evaluate the field condition.
+     * Possible values are:
+     * - `'isDefined'`
+     * - `'isNotDefined'`
+     * - `'mustMatch'`
+     * - `'mustNotMatch'`
+     */
+    conditionType: HostedInterfaceConditionOperator;
+}
+export interface HostedInterfaceResultTemplateDetail {
+    /**
+     * 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 type DisplayValueType = 'checkbox' | 'link';
+export interface HostedInterfaceFacet {
+    /**
+     * 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 HostedInterfaceTab {
+    /**
+     * 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: HostedInterfaceCondition[];
+}
+export interface ListHostedInterfacesParams extends Paginated {
+    /**
+     * A substring that must appear in a hosted 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 interface HostedInterfaceResultTemplate {
+    /**
+     * The name of the result template.
+     */
+    name: string;
+    /**
+     * The conditions a result needs to meet to use the template.
+     */
+    conditions: HostedInterfaceCondition[];
+    /**
+     * The badge to display.
+     */
+    badge: HostedInterfaceResultTemplateBadge;
+    /**
+     * The metadata details to display.
+     */
+    details: HostedInterfaceResultTemplateDetail[];
+}
+export interface HostedInterfaceConfiguration {
+    /**
+     * The configuration identifier.
+     */
+    id: string;
+    /**
+     * The name of the insight panel interface configuration.
+     */
+    name: string;
+    /**
+     * The list of facets to display.
+     */
+    facets: HostedInterfaceFacet[];
+    /**
+     * The list of tabs to display.
+     */
+    tabs: HostedInterfaceTab[];
+}