@coveo/platform-client 37.4.0 → 37.5.0-alpha.0

package/dist/definitions/resources/MachineLearning/PQSConfiguration/PQSConfigurationInterfaces.d.ts

@@ -1,40 +1,40 @@
-import { IntervalUnit } from '../../Enums';
-export interface PQSConfigurationModel {
-    /**
-     * The unique identifier of the catalog to be used by the model to infer
-     * personalized suggestions based on product vectors.
-     */
-    catalogId: string;
-    /**
-     * The filter to apply to the 'Common' event dimensions (shared by all event types)
-     * of the UA data to learn from when rebuilding the model.
-     */
-    commonFilter?: string;
-    /**
-     * The period of UA data to learn from when rebuilding the model.
-     * The exportPeriod uses the moment when the model was last generated as a base.
-     * Must be in the ISO8601 period format (i.e., PyYmMwWdDThHmMsS).
-     */
-    exportPeriod?: string;
-    /**
-     * The number of intervalUnit to wait between each rebuild of the model.
-     * Must be greater than or equal to 1.
-     */
-    intervalTime?: number;
-    /**
-     * The duration unit to use when interpreting the rebuild intervalTime for the model.
-     */
-    intervalUnit?: IntervalUnit;
-    /**
-     * The model display name in the Coveo Administration console.
-     */
-    modelDisplayName: string;
-    /**
-     * The unique identifier of the target machine learning model.
-     */
-    modelId?: string;
-    /**
-     * The filter to apply to the 'Click' and 'Search' event dimensions of the UA data to learn from when rebuilding the model.
-     */
-    searchEventFilter?: string;
-}
+import { IntervalUnit } from '../../Enums';
+export interface PQSConfigurationModel {
+    /**
+     * The unique identifier of the catalog to be used by the model to infer
+     * personalized suggestions based on product vectors.
+     */
+    catalogId: string;
+    /**
+     * The filter to apply to the 'Common' event dimensions (shared by all event types)
+     * of the UA data to learn from when rebuilding the model.
+     */
+    commonFilter?: string;
+    /**
+     * The period of UA data to learn from when rebuilding the model.
+     * The exportPeriod uses the moment when the model was last generated as a base.
+     * Must be in the ISO8601 period format (i.e., PyYmMwWdDThHmMsS).
+     */
+    exportPeriod?: string;
+    /**
+     * The number of intervalUnit to wait between each rebuild of the model.
+     * Must be greater than or equal to 1.
+     */
+    intervalTime?: number;
+    /**
+     * The duration unit to use when interpreting the rebuild intervalTime for the model.
+     */
+    intervalUnit?: IntervalUnit;
+    /**
+     * The model display name in the Coveo Administration console.
+     */
+    modelDisplayName: string;
+    /**
+     * The unique identifier of the target machine learning model.
+     */
+    modelId?: string;
+    /**
+     * The filter to apply to the 'Click' and 'Search' event dimensions of the UA data to learn from when rebuilding the model.
+     */
+    searchEventFilter?: string;
+}

package/dist/definitions/resources/MachineLearning/PQSConfiguration/index.d.ts

@@ -1,2 +1,2 @@
-export * from './PQSConfiguration';
-export * from './PQSConfigurationInterfaces';
+export * from './PQSConfiguration';
+export * from './PQSConfigurationInterfaces';

package/dist/definitions/resources/MachineLearning/SmartSnippetsConfiguration/SmartSnippetsConfiguration.d.ts

@@ -1,17 +1,17 @@
-import { New } from '../../BaseInterfaces';
-import Resource from '../../Resource';
-import { SmartSnippetsConfigurationModel, SmartSnippetsContentFields, SmartSnippetsContentFieldsParams, SmartSnippetsDocumentGroupPreview, SmartSnippetsDocumentGroupPreviewParams, SmartSnippetsDocumentTypes, SmartSnippetsDocumentTypesParams } from './SmartSnippetsConfigurationInterfaces';
-export default class SmartSnippetsConfiguration extends Resource {
-    static baseUrl: string;
-    static modelUrl: string;
-    static contentFieldsUrl: string;
-    static documentTypesUrl: string;
-    static previewUrl: string;
-    create(configModel: New<SmartSnippetsConfigurationModel, 'modelId'>): Promise<SmartSnippetsConfigurationModel>;
-    delete(modelId: string): Promise<Record<string, unknown>>;
-    get(modelId: string): Promise<SmartSnippetsConfigurationModel>;
-    update(configModel: SmartSnippetsConfigurationModel): Promise<SmartSnippetsConfigurationModel>;
-    contentFields(params: SmartSnippetsContentFieldsParams): Promise<SmartSnippetsContentFields>;
-    documentTypes(params: SmartSnippetsDocumentTypesParams): Promise<SmartSnippetsDocumentTypes>;
-    preview(params: SmartSnippetsDocumentGroupPreviewParams): Promise<SmartSnippetsDocumentGroupPreview>;
-}
+import { New } from '../../BaseInterfaces';
+import Resource from '../../Resource';
+import { SmartSnippetsConfigurationModel, SmartSnippetsContentFields, SmartSnippetsContentFieldsParams, SmartSnippetsDocumentGroupPreview, SmartSnippetsDocumentGroupPreviewParams, SmartSnippetsDocumentTypes, SmartSnippetsDocumentTypesParams } from './SmartSnippetsConfigurationInterfaces';
+export default class SmartSnippetsConfiguration extends Resource {
+    static baseUrl: string;
+    static modelUrl: string;
+    static contentFieldsUrl: string;
+    static documentTypesUrl: string;
+    static previewUrl: string;
+    create(configModel: New<SmartSnippetsConfigurationModel, 'modelId'>): Promise<SmartSnippetsConfigurationModel>;
+    delete(modelId: string): Promise<Record<string, unknown>>;
+    get(modelId: string): Promise<SmartSnippetsConfigurationModel>;
+    update(configModel: SmartSnippetsConfigurationModel): Promise<SmartSnippetsConfigurationModel>;
+    contentFields(params: SmartSnippetsContentFieldsParams): Promise<SmartSnippetsContentFields>;
+    documentTypes(params: SmartSnippetsDocumentTypesParams): Promise<SmartSnippetsDocumentTypes>;
+    preview(params: SmartSnippetsDocumentGroupPreviewParams): Promise<SmartSnippetsDocumentGroupPreview>;
+}

package/dist/definitions/resources/MachineLearning/SmartSnippetsConfiguration/SmartSnippetsConfigurationInterfaces.d.ts

@@ -1,131 +1,131 @@
-import { FilterConditions } from '../FilterConditions';
-export interface DocumentType {
-    /**
-     * The fields containing the content to use for smart snippets.
-     */
-    contentFields: string[];
-    /**
-     * The document type.
-     */
-    documentType: string;
-}
-export interface SmartSnippetsConfigurationModel {
-    /**
-     * The unique ID of the model.
-     */
-    modelId: string;
-    /**
-     * The model name to display.
-     * Example: My First Model
-     */
-    modelDisplayName: string;
-    /**
-     * The sources to consider.
-     */
-    sources: string[];
-    /**
-     * An array of filtering conditions.
-     */
-    filterConditions: FilterConditions[];
-    /**
-     * An array of css selectors to evaluate content to exclude.
-     */
-    cssSelectorsToExclude?: string[];
-    /**
-     * The document type for which content is in custom index fields.
-     */
-    documentTypes?: DocumentType[];
-}
-export declare type SmartSnippetsDocumentRequirementStatus = 'OK' | 'INSUFFICIENT_DOCUMENTS';
-export interface SmartSnippetsDocumentGroupPreviewParams {
-    /**
-     * The sources to consider.
-     */
-    sources: string[];
-    /**
-     * An array of filtering conditions.
-     */
-    filterConditions: FilterConditions[];
-}
-export interface SmartSnippetsDocumentGroupPreview {
-    /**
-     * The query that was used to fetch document information.
-     */
-    query: string;
-    /**
-     * Status indicating whether there are enough candidates for learning.
-     */
-    documentRequirementStatus: SmartSnippetsDocumentRequirementStatus;
-    /**
-     * The total number of documents in all sources.
-     */
-    numberOfDocuments: number;
-    /**
-     * The number of documents that match the conditions.
-     */
-    numberOfDocumentsMatchingConditions: number;
-    /**
-     * The number of documents that match the conditions and have a permanent id.
-     */
-    numberOfDocumentsWithPermanentId: number;
-    /**
-     * The number of documents that are candidates for learning.
-     */
-    numberOfValidDocuments: number;
-}
-export interface SmartSnippetsContentFieldsParams {
-    /**
-     * The type of documents to target.
-     */
-    documentType: string;
-    /**
-     * The sources to consider.
-     */
-    sources: string[];
-    /**
-     * An array of filtering conditions.
-     */
-    filterConditions: FilterConditions[];
-}
-export interface SmartSnippetsContentField {
-    /**
-     * The name of the field.
-     */
-    name: string;
-}
-export interface SmartSnippetsContentFields {
-    /**
-     * The query that was used to fetch document information.
-     */
-    query: string;
-    /**
-     * The list of fields that are non-empty for at least one document.
-     */
-    fields: SmartSnippetsContentField[];
-}
-export interface SmartSnippetsDocumentTypesParams {
-    /**
-     * The sources to consider.
-     */
-    sources: string[];
-    /**
-     * An array of filtering conditions.
-     */
-    filterConditions: FilterConditions[];
-}
-export interface SmartSnippetsDocumentType {
-    /**
-     * The document type.
-     */
-    documentType: string;
-}
-export interface SmartSnippetsDocumentTypes {
-    /**
-     * The query that was used to fetch document information.
-     */
-    query: string;
-    /**
-     * The document types in all sources.
-     */
-    documentTypes: SmartSnippetsDocumentType[];
-}
+import { FilterConditions } from '../FilterConditions';
+export interface DocumentType {
+    /**
+     * The fields containing the content to use for smart snippets.
+     */
+    contentFields: string[];
+    /**
+     * The document type.
+     */
+    documentType: string;
+}
+export interface SmartSnippetsConfigurationModel {
+    /**
+     * The unique ID of the model.
+     */
+    modelId: string;
+    /**
+     * The model name to display.
+     * Example: My First Model
+     */
+    modelDisplayName: string;
+    /**
+     * The sources to consider.
+     */
+    sources: string[];
+    /**
+     * An array of filtering conditions.
+     */
+    filterConditions: FilterConditions[];
+    /**
+     * An array of css selectors to evaluate content to exclude.
+     */
+    cssSelectorsToExclude?: string[];
+    /**
+     * The document type for which content is in custom index fields.
+     */
+    documentTypes?: DocumentType[];
+}
+export declare type SmartSnippetsDocumentRequirementStatus = 'OK' | 'INSUFFICIENT_DOCUMENTS';
+export interface SmartSnippetsDocumentGroupPreviewParams {
+    /**
+     * The sources to consider.
+     */
+    sources: string[];
+    /**
+     * An array of filtering conditions.
+     */
+    filterConditions: FilterConditions[];
+}
+export interface SmartSnippetsDocumentGroupPreview {
+    /**
+     * The query that was used to fetch document information.
+     */
+    query: string;
+    /**
+     * Status indicating whether there are enough candidates for learning.
+     */
+    documentRequirementStatus: SmartSnippetsDocumentRequirementStatus;
+    /**
+     * The total number of documents in all sources.
+     */
+    numberOfDocuments: number;
+    /**
+     * The number of documents that match the conditions.
+     */
+    numberOfDocumentsMatchingConditions: number;
+    /**
+     * The number of documents that match the conditions and have a permanent id.
+     */
+    numberOfDocumentsWithPermanentId: number;
+    /**
+     * The number of documents that are candidates for learning.
+     */
+    numberOfValidDocuments: number;
+}
+export interface SmartSnippetsContentFieldsParams {
+    /**
+     * The type of documents to target.
+     */
+    documentType: string;
+    /**
+     * The sources to consider.
+     */
+    sources: string[];
+    /**
+     * An array of filtering conditions.
+     */
+    filterConditions: FilterConditions[];
+}
+export interface SmartSnippetsContentField {
+    /**
+     * The name of the field.
+     */
+    name: string;
+}
+export interface SmartSnippetsContentFields {
+    /**
+     * The query that was used to fetch document information.
+     */
+    query: string;
+    /**
+     * The list of fields that are non-empty for at least one document.
+     */
+    fields: SmartSnippetsContentField[];
+}
+export interface SmartSnippetsDocumentTypesParams {
+    /**
+     * The sources to consider.
+     */
+    sources: string[];
+    /**
+     * An array of filtering conditions.
+     */
+    filterConditions: FilterConditions[];
+}
+export interface SmartSnippetsDocumentType {
+    /**
+     * The document type.
+     */
+    documentType: string;
+}
+export interface SmartSnippetsDocumentTypes {
+    /**
+     * The query that was used to fetch document information.
+     */
+    query: string;
+    /**
+     * The document types in all sources.
+     */
+    documentTypes: SmartSnippetsDocumentType[];
+}

package/dist/definitions/resources/MachineLearning/SmartSnippetsConfiguration/index.d.ts

@@ -1,2 +1,2 @@
-export * from './SmartSnippetsConfiguration';
-export * from './SmartSnippetsConfigurationInterfaces';
+export * from './SmartSnippetsConfiguration';
+export * from './SmartSnippetsConfigurationInterfaces';

package/dist/definitions/resources/MachineLearning/UserActionHistoryConfiguration/UserActionHistoryConfiguration.d.ts

@@ -1,7 +1,7 @@
-import Resource from '../../Resource';
-export default class UserActionHistoryConfiguration extends Resource {
-    static baseUrl: string;
-    create(): Promise<void>;
-    delete(): Promise<void>;
-    get(): Promise<boolean>;
-}
+import Resource from '../../Resource';
+export default class UserActionHistoryConfiguration extends Resource {
+    static baseUrl: string;
+    create(): Promise<void>;
+    delete(): Promise<void>;
+    get(): Promise<boolean>;
+}

package/dist/definitions/resources/MachineLearning/UserActionHistoryConfiguration/index.d.ts

@@ -1 +1 @@
-export * from './UserActionHistoryConfiguration';
+export * from './UserActionHistoryConfiguration';

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

@@ -1,11 +1,11 @@
-export * from './MachineLearning';
-export * from './MachineLearningInterfaces';
-export * from './FilterConditions';
-export * from './Models/';
-export * from './ModelInformation/';
-export * from './ModelConfiguration/';
-export * from './DNEConfiguration';
-export * from './CaseClassificationConfiguration';
-export * from './SmartSnippetsConfiguration';
-export * from './PQSConfiguration';
-export * from './UserActionHistoryConfiguration';
+export * from './MachineLearning';
+export * from './MachineLearningInterfaces';
+export * from './FilterConditions';
+export * from './Models/';
+export * from './ModelInformation/';
+export * from './ModelConfiguration/';
+export * from './DNEConfiguration';
+export * from './CaseClassificationConfiguration';
+export * from './SmartSnippetsConfiguration';
+export * from './PQSConfiguration';
+export * from './UserActionHistoryConfiguration';

package/dist/definitions/resources/ModifierTemplates/ModifierTemplateInterfaces.d.ts

@@ -1,71 +1,71 @@
-export interface ModifierModel {
-    /**
-     * Unique identifier
-     */
-    id: string;
-    /**
-     * English human friendly name
-     */
-    displayName: string;
-    /**
-     * Category the modifier belongs to.
-     * LICENSE and SYSTEM are more for internal use and might need to be filtered out from display
-     */
-    modifierType: ModifierType;
-    /**
-     * List of statements contained in the modifier
-     */
-    statements: ModifierStatementModel[];
-}
-export interface ModifierStatementModel {
-    /**
-     * The statement key to apply the value to
-     */
-    key: string;
-    /**
-     * The value to set on the key, always a string so "0" or "true" are correct
-     */
-    value: string;
-    /**
-     * How the value will be applied if there are other statements on the same key
-     */
-    operation: StatementOperation;
-}
-export interface ModifierStatementDetailModel {
-    /**
-     * The statement key to apply the value to
-     */
-    statementKey: string;
-    /**
-     * The license property the statement affects
-     */
-    mapping: string;
-    /**
-     * The type of value that should be used in the license when recomputing the properties
-     */
-    valueType: StatementOperation;
-    /**
-     * The strategy that will be used to resolve conflicts for statements on the same key
-     */
-    mergeStrategy: MergeStrategy;
-}
-export declare enum ModifierType {
-    system = "SYSTEM",
-    license = "LICENSE",
-    integration = "INTEGRATION",
-    extension = "EXTENSION",
-    feature = "FEATURE"
-}
-export declare enum StatementOperation {
-    set = "SET",
-    append = "APPEND",
-    remove = "REMOVE"
-}
-export declare enum MergeStrategy {
-    integerBiggerWins = "INTEGER_BIGGER_WINS",
-    integerLowerWins = "INTEGER_LOWER_WINS",
-    booleanFalseWins = "BOOLEAN_FALSE_WINS",
-    booleanTrueWins = "BOOLEAN_TRUE_WINS",
-    specificEnumValueWins = "SPECIFIC_ENUM_VALUE_WINS",
-    noMerge = "NO_MERGE"
-}
+export interface ModifierModel {
+    /**
+     * Unique identifier
+     */
+    id: string;
+    /**
+     * English human friendly name
+     */
+    displayName: string;
+    /**
+     * Category the modifier belongs to.
+     * LICENSE and SYSTEM are more for internal use and might need to be filtered out from display
+     */
+    modifierType: ModifierType;
+    /**
+     * List of statements contained in the modifier
+     */
+    statements: ModifierStatementModel[];
+}
+export interface ModifierStatementModel {
+    /**
+     * The statement key to apply the value to
+     */
+    key: string;
+    /**
+     * The value to set on the key, always a string so "0" or "true" are correct
+     */
+    value: string;
+    /**
+     * How the value will be applied if there are other statements on the same key
+     */
+    operation: StatementOperation;
+}
+export interface ModifierStatementDetailModel {
+    /**
+     * The statement key to apply the value to
+     */
+    statementKey: string;
+    /**
+     * The license property the statement affects
+     */
+    mapping: string;
+    /**
+     * The type of value that should be used in the license when recomputing the properties
+     */
+    valueType: StatementOperation;
+    /**
+     * The strategy that will be used to resolve conflicts for statements on the same key
+     */
+    mergeStrategy: MergeStrategy;
+}
+export declare enum ModifierType {
+    system = "SYSTEM",
+    license = "LICENSE",
+    integration = "INTEGRATION",
+    extension = "EXTENSION",
+    feature = "FEATURE"
+}
+export declare enum StatementOperation {
+    set = "SET",
+    append = "APPEND",
+    remove = "REMOVE"
+}
+export declare enum MergeStrategy {
+    integerBiggerWins = "INTEGER_BIGGER_WINS",
+    integerLowerWins = "INTEGER_LOWER_WINS",
+    booleanFalseWins = "BOOLEAN_FALSE_WINS",
+    booleanTrueWins = "BOOLEAN_TRUE_WINS",
+    specificEnumValueWins = "SPECIFIC_ENUM_VALUE_WINS",
+    noMerge = "NO_MERGE"
+}

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

@@ -1,7 +1,7 @@
-import Resource from '../Resource';
-import { ModifierModel, ModifierStatementDetailModel } from './ModifierTemplateInterfaces';
-export default class ModifierTemplates extends Resource {
-    static baseUrl: string;
-    list(): Promise<ModifierModel[]>;
-    listPossibleStatements(): Promise<ModifierStatementDetailModel[]>;
-}
+import Resource from '../Resource';
+import { ModifierModel, ModifierStatementDetailModel } from './ModifierTemplateInterfaces';
+export default class ModifierTemplates extends Resource {
+    static baseUrl: string;
+    list(): Promise<ModifierModel[]>;
+    listPossibleStatements(): Promise<ModifierStatementDetailModel[]>;
+}

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

@@ -1,2 +1,2 @@
-export * from './ModifierTemplates';
-export * from './ModifierTemplateInterfaces';
+export * from './ModifierTemplates';
+export * from './ModifierTemplateInterfaces';

package/dist/definitions/resources/Notification/Subscription/Subscription.d.ts

@@ -1,21 +1,21 @@
-import Ressource from '../../Resource';
-import { EditSubscriptionModel, SubscriptionModel } from './SubscriptionInterfaces';
-export default class Subscription extends Ressource {
-    static getBaseUrl: (orgId: string) => string;
-    list(): Promise<SubscriptionModel[]>;
-    listCurrent(): Promise<SubscriptionModel[]>;
-    show(subscriptionId: string): Promise<SubscriptionModel>;
-    showCurrent(subscriptionId: string): Promise<SubscriptionModel>;
-    create(editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
-    createCurrent(editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
-    edit(subscriptionId: string, editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
-    editCurrent(subscriptionId: string, editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
-    delete(subscriptionId: string): Promise<Record<string, unknown>>;
-    deleteCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
-    enable(subscriptionId: string): Promise<Record<string, unknown>>;
-    enableCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
-    disable(subscriptionId: string): Promise<Record<string, unknown>>;
-    disableCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
-    test(subscriptionId: string): Promise<Record<string, unknown>>;
-    testCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
-}
+import Ressource from '../../Resource';
+import { EditSubscriptionModel, SubscriptionModel } from './SubscriptionInterfaces';
+export default class Subscription extends Ressource {
+    static getBaseUrl: (orgId: string) => string;
+    list(): Promise<SubscriptionModel[]>;
+    listCurrent(): Promise<SubscriptionModel[]>;
+    show(subscriptionId: string): Promise<SubscriptionModel>;
+    showCurrent(subscriptionId: string): Promise<SubscriptionModel>;
+    create(editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
+    createCurrent(editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
+    edit(subscriptionId: string, editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
+    editCurrent(subscriptionId: string, editSubscriptionModel: EditSubscriptionModel): Promise<SubscriptionModel>;
+    delete(subscriptionId: string): Promise<Record<string, unknown>>;
+    deleteCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
+    enable(subscriptionId: string): Promise<Record<string, unknown>>;
+    enableCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
+    disable(subscriptionId: string): Promise<Record<string, unknown>>;
+    disableCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
+    test(subscriptionId: string): Promise<Record<string, unknown>>;
+    testCurrent(subscriptionId: string): Promise<Record<string, unknown>>;
+}