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

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

@@ -1,194 +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"
-}
+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

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

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

@@ -1,12 +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[]>;
-}
+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

@@ -1,38 +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;
-}
+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

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

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

@@ -1,5 +1,5 @@
-import Resource from '../Resource';
-export default class Links extends Resource {
-    static baseUrl: string;
-    deleteAll(): Promise<Record<string, unknown>>;
-}
+import Resource from '../Resource';
+export default class Links extends Resource {
+    static baseUrl: string;
+    deleteAll(): Promise<Record<string, unknown>>;
+}

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

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

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

@@ -1,8 +1,8 @@
-import Resource from '../Resource';
-import { FacetsModel, FacetsWithCountsModel, GetFacetsParams, GetLogsOrFacetsRequestBodyModel, GetLogsParams, LogsModel } from './LogsInterfaces';
-export default class Logs extends Resource {
-    static baseUrl: string;
-    get(params: GetLogsParams, options: GetLogsOrFacetsRequestBodyModel): Promise<LogsModel>;
-    getFacets(params: GetFacetsParams, options: GetLogsOrFacetsRequestBodyModel): Promise<FacetsModel>;
-    getFacetsStats(params: GetFacetsParams, options: GetLogsOrFacetsRequestBodyModel): Promise<FacetsWithCountsModel>;
-}
+import Resource from '../Resource';
+import { FacetsModel, FacetsWithCountsModel, GetFacetsParams, GetLogsOrFacetsRequestBodyModel, GetLogsParams, LogsModel } from './LogsInterfaces';
+export default class Logs extends Resource {
+    static baseUrl: string;
+    get(params: GetLogsParams, options: GetLogsOrFacetsRequestBodyModel): Promise<LogsModel>;
+    getFacets(params: GetFacetsParams, options: GetLogsOrFacetsRequestBodyModel): Promise<FacetsModel>;
+    getFacetsStats(params: GetFacetsParams, options: GetLogsOrFacetsRequestBodyModel): Promise<FacetsWithCountsModel>;
+}

package/dist/definitions/resources/Logs/LogsInterfaces.d.ts

@@ -1,47 +1,47 @@
-import { Paginated } from '../BaseInterfaces';
-import { IndexingPipelineLogOperations, IndexingPipelineLogResults, IndexingPipelineLogTasks } from '../Enums';
-export interface GetLogsParams extends GetFacetsParams, Paginated {
-}
-export interface GetFacetsParams {
-    from: string;
-    to: string;
-    documentId?: string;
-}
-export interface GetLogsOrFacetsRequestBodyModel extends FacetsModel {
-    excludeOperations?: IndexingPipelineLogOperations[];
-    excludeResourceIds?: string[];
-    excludeResults?: IndexingPipelineLogResults[];
-    excludeSourceIds?: string[];
-    excludeTasks?: IndexingPipelineLogTasks[];
-}
-export interface FacetsModel {
-    operations?: IndexingPipelineLogOperations[];
-    resourceIds?: string[];
-    results?: IndexingPipelineLogResults[];
-    sourceIds?: string[];
-    tasks?: IndexingPipelineLogTasks[];
-}
-export interface LogsModel {
-    documentLogEntries: IndexingPipelineLogEntry[];
-    hasNextPage: boolean;
-}
-export interface IndexingPipelineLogEntry {
-    datetime: string;
-    guid: string;
-    id: string;
-    meta: Record<string, any>;
-    operation: IndexingPipelineLogOperations;
-    organizationId: string;
-    requestId: string;
-    resourceId: string;
-    result: IndexingPipelineLogResults;
-    sourceId: string;
-    task: IndexingPipelineLogTasks;
-}
-export interface FacetsWithCountsModel {
-    operations: Record<IndexingPipelineLogOperations, number>;
-    resourceIds: Record<string, number>;
-    results: Record<IndexingPipelineLogResults, number>;
-    sourceIds: Record<string, number>;
-    tasks: Record<IndexingPipelineLogTasks, number>;
-}
+import { Paginated } from '../BaseInterfaces';
+import { IndexingPipelineLogOperations, IndexingPipelineLogResults, IndexingPipelineLogTasks } from '../Enums';
+export interface GetLogsParams extends GetFacetsParams, Paginated {
+}
+export interface GetFacetsParams {
+    from: string;
+    to: string;
+    documentId?: string;
+}
+export interface GetLogsOrFacetsRequestBodyModel extends FacetsModel {
+    excludeOperations?: IndexingPipelineLogOperations[];
+    excludeResourceIds?: string[];
+    excludeResults?: IndexingPipelineLogResults[];
+    excludeSourceIds?: string[];
+    excludeTasks?: IndexingPipelineLogTasks[];
+}
+export interface FacetsModel {
+    operations?: IndexingPipelineLogOperations[];
+    resourceIds?: string[];
+    results?: IndexingPipelineLogResults[];
+    sourceIds?: string[];
+    tasks?: IndexingPipelineLogTasks[];
+}
+export interface LogsModel {
+    documentLogEntries: IndexingPipelineLogEntry[];
+    hasNextPage: boolean;
+}
+export interface IndexingPipelineLogEntry {
+    datetime: string;
+    guid: string;
+    id: string;
+    meta: Record<string, any>;
+    operation: IndexingPipelineLogOperations;
+    organizationId: string;
+    requestId: string;
+    resourceId: string;
+    result: IndexingPipelineLogResults;
+    sourceId: string;
+    task: IndexingPipelineLogTasks;
+}
+export interface FacetsWithCountsModel {
+    operations: Record<IndexingPipelineLogOperations, number>;
+    resourceIds: Record<string, number>;
+    results: Record<IndexingPipelineLogResults, number>;
+    sourceIds: Record<string, number>;
+    tasks: Record<IndexingPipelineLogTasks, number>;
+}

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

@@ -1,2 +1,2 @@
-export * from './Logs';
-export * from './LogsInterfaces';
+export * from './Logs';
+export * from './LogsInterfaces';