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

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

@@ -1,65 +1,65 @@
-import { GranularResource } from '../BaseInterfaces';
-import { IntervalUnit } from '../Enums';
-import { MLModel } from './Models';
-export interface RegistrationModel extends GranularResource {
-    engineId: string;
-    modelName: string;
-    modelDisplayName?: string;
-    /**
-     * The period to export data from. Unless an exportOffset is specified, the exportPeriod uses the moment when the model was generated as a base.
-     * Must be in the ISO8601 period format (i.e., PyYmMwWdDThHmMsS)
-     */
-    exportPeriod: string;
-    intervalTime: number;
-    intervalUnit: IntervalUnit;
-    /**
-     * The offset period to apply to the export.
-     * An undefined exportOffset means that the exportPeriod is based on the moment when the model was generated.
-     * An exportOffset of P1W means that the exportPeriod is based on the moment one week before the model was generated.
-     * If specified, must be in the ISO8601 period format (i.e., PyYmMwWdDThHmMsS)
-     */
-    exportOffset?: string;
-    commandLineParameters?: string[];
-    extraConfig?: {
-        [key: string]: any;
-    };
-    /**
-     * The filter to apply to the common event dimensions (shared by all event types) in the export.
-     * Multiple filter parameters are joined with the AND operator
-     */
-    commonFilter?: string;
-    /**
-     * The filter to apply to the custom event dimensions in the export.
-     * Multiple filter parameters are joined with the AND operator
-     */
-    customEventFilter?: string;
-    /**
-     * The filter to apply to the click and search event dimensions in the export.
-     * Multiple filter parameters are joined with the AND operator
-     */
-    searchEventFilter?: string;
-    /**
-     * The filter to apply to the view event dimensions (shared by all event types) in the export.
-     * Multiple filter parameters are joined with the AND operator
-     */
-    viewEventFilter?: string;
-    /**
-     * The version matcher to select the valid drills.
-     * See the documentation https://github.com/zafarkhaja/jsemver/#external-dsl
-     */
-    versionMatcher?: string;
-}
-export interface MLModelCreated extends MLModel {
-    modelId?: string;
-    /**
-     * The epoch date when the schedule will end.
-     * If there is no end date, the schedule will last forever.
-     */
-    endTime?: number;
-    /**
-     * A timestamp indicating when to begin the first job (in milliseconds since UNIX epoch format).
-     * If no start date is specified, the job starts immediately
-     */
-    startTime?: number;
-    resourceId?: string;
-}
+import { GranularResource } from '../BaseInterfaces';
+import { IntervalUnit } from '../Enums';
+import { MLModel } from './Models';
+export interface RegistrationModel extends GranularResource {
+    engineId: string;
+    modelName: string;
+    modelDisplayName?: string;
+    /**
+     * The period to export data from. Unless an exportOffset is specified, the exportPeriod uses the moment when the model was generated as a base.
+     * Must be in the ISO8601 period format (i.e., PyYmMwWdDThHmMsS)
+     */
+    exportPeriod: string;
+    intervalTime: number;
+    intervalUnit: IntervalUnit;
+    /**
+     * The offset period to apply to the export.
+     * An undefined exportOffset means that the exportPeriod is based on the moment when the model was generated.
+     * An exportOffset of P1W means that the exportPeriod is based on the moment one week before the model was generated.
+     * If specified, must be in the ISO8601 period format (i.e., PyYmMwWdDThHmMsS)
+     */
+    exportOffset?: string;
+    commandLineParameters?: string[];
+    extraConfig?: {
+        [key: string]: any;
+    };
+    /**
+     * The filter to apply to the common event dimensions (shared by all event types) in the export.
+     * Multiple filter parameters are joined with the AND operator
+     */
+    commonFilter?: string;
+    /**
+     * The filter to apply to the custom event dimensions in the export.
+     * Multiple filter parameters are joined with the AND operator
+     */
+    customEventFilter?: string;
+    /**
+     * The filter to apply to the click and search event dimensions in the export.
+     * Multiple filter parameters are joined with the AND operator
+     */
+    searchEventFilter?: string;
+    /**
+     * The filter to apply to the view event dimensions (shared by all event types) in the export.
+     * Multiple filter parameters are joined with the AND operator
+     */
+    viewEventFilter?: string;
+    /**
+     * The version matcher to select the valid drills.
+     * See the documentation https://github.com/zafarkhaja/jsemver/#external-dsl
+     */
+    versionMatcher?: string;
+}
+export interface MLModelCreated extends MLModel {
+    modelId?: string;
+    /**
+     * The epoch date when the schedule will end.
+     * If there is no end date, the schedule will last forever.
+     */
+    endTime?: number;
+    /**
+     * A timestamp indicating when to begin the first job (in milliseconds since UNIX epoch format).
+     * If no start date is specified, the job starts immediately
+     */
+    startTime?: number;
+    resourceId?: string;
+}

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

@@ -1,7 +1,7 @@
-import Resource from '../../Resource';
-import { AdvancedRegistrationConfigFile, AdvancedRegistrationConfigFileCreationResponse } from './ModelConfigurationInterfaces';
-export default class ModelConfiguration extends Resource {
-    static getBaseUrl: (modelId: string) => string;
-    getAdvancedConfig(modelId: string): Promise<AdvancedRegistrationConfigFile>;
-    updateAdvancedConfig(modelId: string, modelConfigFileContents: string): Promise<AdvancedRegistrationConfigFileCreationResponse>;
-}
+import Resource from '../../Resource';
+import { AdvancedRegistrationConfigFile, AdvancedRegistrationConfigFileCreationResponse } from './ModelConfigurationInterfaces';
+export default class ModelConfiguration extends Resource {
+    static getBaseUrl: (modelId: string) => string;
+    getAdvancedConfig(modelId: string): Promise<AdvancedRegistrationConfigFile>;
+    updateAdvancedConfig(modelId: string, modelConfigFileContents: string): Promise<AdvancedRegistrationConfigFileCreationResponse>;
+}

package/dist/definitions/resources/MachineLearning/ModelConfiguration/ModelConfigurationInterfaces.d.ts

@@ -1,10 +1,10 @@
-export interface AdvancedRegistrationConfigFile {
-    fileContents?: string;
-    lastModified?: string;
-    modelId?: string;
-    orgId?: string;
-}
-export interface AdvancedRegistrationConfigFileCreationResponse {
-    filePath?: string;
-    modelId?: string;
-}
+export interface AdvancedRegistrationConfigFile {
+    fileContents?: string;
+    lastModified?: string;
+    modelId?: string;
+    orgId?: string;
+}
+export interface AdvancedRegistrationConfigFileCreationResponse {
+    filePath?: string;
+    modelId?: string;
+}

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

@@ -1,2 +1,2 @@
-export * from './ModelConfiguration';
-export * from './ModelConfigurationInterfaces';
+export * from './ModelConfiguration';
+export * from './ModelConfigurationInterfaces';

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

@@ -1,10 +1,10 @@
-import Resource from '../../Resource';
-import { RegistrationModel } from '../MachineLearningInterfaces';
-import { MLModelInfo, MLModelTypeInfo } from './ModelInformationInterfaces';
-import { MLModel } from '../Models';
-export default class ModelInformation extends Resource {
-    static getBaseUrl: (engineId: string, modelName: string) => string;
-    get<T extends MLModelTypeInfo>(engineId: string, modelName: string): Promise<MLModelInfo<T>>;
-    delete(engineId: string, modelName: string): Promise<Record<string, unknown>>;
-    update(engineId: string, modelName: string, modelInformation: RegistrationModel): Promise<Partial<MLModel<never>>>;
-}
+import Resource from '../../Resource';
+import { RegistrationModel } from '../MachineLearningInterfaces';
+import { MLModelInfo, MLModelTypeInfo } from './ModelInformationInterfaces';
+import { MLModel } from '../Models';
+export default class ModelInformation extends Resource {
+    static getBaseUrl: (engineId: string, modelName: string) => string;
+    get<T extends MLModelTypeInfo>(engineId: string, modelName: string): Promise<MLModelInfo<T>>;
+    delete(engineId: string, modelName: string): Promise<Record<string, unknown>>;
+    update(engineId: string, modelName: string, modelInformation: RegistrationModel): Promise<Partial<MLModel<never>>>;
+}