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

package/dist/definitions/resources/SecurityCache/SecurityCacheInterfaces.d.ts

@@ -1,137 +1,137 @@
-import { Paginated } from '../BaseInterfaces';
-import { PermissionIdentityType, ScheduleType, SecurityCacheStateOptions, SecurityProviderReferenceType, SecurityProviderType } from '../Enums';
-import { ParameterModel, UserIdentityModel } from '../Sources';
-export interface ScheduleModel {
-    enabled: boolean;
-    frequency?: ScheduleFrequency;
-    id: string;
-    organizationId?: string;
-    refreshType?: string;
-    resourceId?: string;
-    scheduleType?: string;
-}
-export interface SecurityCacheStatus {
-    currentStatus?: CurrentStatusModel;
-    statistics?: SecurityProviderStatisticsModel;
-}
-export interface SecurityCacheIdentityModel {
-    data?: string;
-    provider?: string;
-}
-export interface SecurityProviderModel {
-    cascadingSecurityProviders?: Record<string, CascadingSecurityProvider>;
-    caseSensitive?: boolean;
-    crawlingModuleId?: string;
-    displayName?: string;
-    id: string;
-    instanceId?: string;
-    name: string;
-    nodeRequired?: boolean;
-    nodeTypeName?: string;
-    onPremisesEnabled?: boolean;
-    organizationId?: string;
-    parameters?: ParameterModel;
-    referencedBy?: SecurityProviderReferenceModel[];
-    sourceTypeName?: string;
-    type?: SecurityProviderType;
-    userIdentities?: UserIdentityModel;
-}
-export interface SecurityProviderModelWithStatus extends Required<SecurityProviderModel> {
-    currentStatus: CurrentStatusModel;
-    lastRefreshOperation: LastRefreshOperation;
-    statistics: SecurityProviderStatisticsModel;
-}
-export interface CascadingSecurityProvider {
-    id: string;
-    name: string;
-    type?: SecurityProviderType;
-    typeName?: string;
-}
-export interface ScheduleFrequency {
-    hourMinute?: HourMinutePair;
-    monthDay?: number;
-    seed?: number;
-    type?: ScheduleType;
-    value?: number;
-    weekDays?: string[];
-}
-export interface HourMinutePair {
-    hour?: number;
-    minute?: number;
-}
-export interface LastRefreshOperation {
-    errorCode?: string;
-    id: string;
-    numberOfEntitiesProcessed?: number;
-    operationType?: string;
-    result?: string;
-    timestamp?: number;
-}
-export interface SecurityProviderReferenceModel {
-    attributes?: SecurityProviderReferenceModelAttributes;
-    id: string;
-    type?: SecurityProviderReferenceType;
-}
-export interface CurrentStatusModel {
-    numberOfEntitiesInError?: number;
-    numberOfEntitiesProcessed?: number;
-    refreshType?: string;
-    totalNumberOfEntities?: number;
-    type?: string;
-}
-export interface SecurityProviderStatisticsModel {
-    numberOfEntitiesByState?: {
-        DISABLED: number;
-        IN_ERROR: number;
-        NOT_UPDATED: number;
-        OUT_OF_DATE: number;
-        UP_TO_DATE: number;
-    };
-    numberOfEntitiesInError?: number;
-    numberOfPermissionModels?: number;
-    numberOfProviders?: number;
-    totalNumberOfEntities?: number;
-}
-export interface SecurityProviderReferenceModelAttributes {
-    crawlerInstanceType?: string;
-    id: string;
-    name: string;
-    onPremisesEnabled?: boolean;
-    pushEnabled?: boolean;
-    streamEnabled?: boolean;
-    sourceType?: string;
-}
-export interface SecurityCacheListOptions extends Paginated {
-    from?: string;
-    organisationId?: string;
-    securityProviderId?: string;
-    states?: SecurityCacheStateOptions;
-    to?: string;
-}
-export interface SecurityProviderIdentitiesFilters extends Paginated {
-    filterTerm?: string;
-    identityTypes?: PermissionIdentityType[];
-}
-export interface SecurityCacheListRelationshipsOptions extends Paginated {
-    recursive?: boolean;
-}
-export interface SecurityCacheMemberModel {
-    infos?: SecurityCacheMemberInfoModel[];
-    name: string;
-    provider?: string;
-    type?: PermissionIdentityType;
-}
-export interface DetailedSecurityCacheMemberModel extends SecurityCacheMemberModel {
-    lastUpdateDate?: number;
-    lastUpdateErrorDetail?: string;
-    lastUpdateResult?: string;
-    state?: string;
-}
-export interface SecurityCacheMemberInfoModel {
-    key: string;
-    value: string;
-}
-export interface SecurityProvider {
-    name?: string;
-    typeName?: string;
-}
+import { Paginated } from '../BaseInterfaces';
+import { PermissionIdentityType, ScheduleType, SecurityCacheStateOptions, SecurityProviderReferenceType, SecurityProviderType } from '../Enums';
+import { ParameterModel, UserIdentityModel } from '../Sources';
+export interface ScheduleModel {
+    enabled: boolean;
+    frequency?: ScheduleFrequency;
+    id: string;
+    organizationId?: string;
+    refreshType?: string;
+    resourceId?: string;
+    scheduleType?: string;
+}
+export interface SecurityCacheStatus {
+    currentStatus?: CurrentStatusModel;
+    statistics?: SecurityProviderStatisticsModel;
+}
+export interface SecurityCacheIdentityModel {
+    data?: string;
+    provider?: string;
+}
+export interface SecurityProviderModel {
+    cascadingSecurityProviders?: Record<string, CascadingSecurityProvider>;
+    caseSensitive?: boolean;
+    crawlingModuleId?: string;
+    displayName?: string;
+    id: string;
+    instanceId?: string;
+    name: string;
+    nodeRequired?: boolean;
+    nodeTypeName?: string;
+    onPremisesEnabled?: boolean;
+    organizationId?: string;
+    parameters?: ParameterModel;
+    referencedBy?: SecurityProviderReferenceModel[];
+    sourceTypeName?: string;
+    type?: SecurityProviderType;
+    userIdentities?: UserIdentityModel;
+}
+export interface SecurityProviderModelWithStatus extends Required<SecurityProviderModel> {
+    currentStatus: CurrentStatusModel;
+    lastRefreshOperation: LastRefreshOperation;
+    statistics: SecurityProviderStatisticsModel;
+}
+export interface CascadingSecurityProvider {
+    id: string;
+    name: string;
+    type?: SecurityProviderType;
+    typeName?: string;
+}
+export interface ScheduleFrequency {
+    hourMinute?: HourMinutePair;
+    monthDay?: number;
+    seed?: number;
+    type?: ScheduleType;
+    value?: number;
+    weekDays?: string[];
+}
+export interface HourMinutePair {
+    hour?: number;
+    minute?: number;
+}
+export interface LastRefreshOperation {
+    errorCode?: string;
+    id: string;
+    numberOfEntitiesProcessed?: number;
+    operationType?: string;
+    result?: string;
+    timestamp?: number;
+}
+export interface SecurityProviderReferenceModel {
+    attributes?: SecurityProviderReferenceModelAttributes;
+    id: string;
+    type?: SecurityProviderReferenceType;
+}
+export interface CurrentStatusModel {
+    numberOfEntitiesInError?: number;
+    numberOfEntitiesProcessed?: number;
+    refreshType?: string;
+    totalNumberOfEntities?: number;
+    type?: string;
+}
+export interface SecurityProviderStatisticsModel {
+    numberOfEntitiesByState?: {
+        DISABLED: number;
+        IN_ERROR: number;
+        NOT_UPDATED: number;
+        OUT_OF_DATE: number;
+        UP_TO_DATE: number;
+    };
+    numberOfEntitiesInError?: number;
+    numberOfPermissionModels?: number;
+    numberOfProviders?: number;
+    totalNumberOfEntities?: number;
+}
+export interface SecurityProviderReferenceModelAttributes {
+    crawlerInstanceType?: string;
+    id: string;
+    name: string;
+    onPremisesEnabled?: boolean;
+    pushEnabled?: boolean;
+    streamEnabled?: boolean;
+    sourceType?: string;
+}
+export interface SecurityCacheListOptions extends Paginated {
+    from?: string;
+    organisationId?: string;
+    securityProviderId?: string;
+    states?: SecurityCacheStateOptions;
+    to?: string;
+}
+export interface SecurityProviderIdentitiesFilters extends Paginated {
+    filterTerm?: string;
+    identityTypes?: PermissionIdentityType[];
+}
+export interface SecurityCacheListRelationshipsOptions extends Paginated {
+    recursive?: boolean;
+}
+export interface SecurityCacheMemberModel {
+    infos?: SecurityCacheMemberInfoModel[];
+    name: string;
+    provider?: string;
+    type?: PermissionIdentityType;
+}
+export interface DetailedSecurityCacheMemberModel extends SecurityCacheMemberModel {
+    lastUpdateDate?: number;
+    lastUpdateErrorDetail?: string;
+    lastUpdateResult?: string;
+    state?: string;
+}
+export interface SecurityCacheMemberInfoModel {
+    key: string;
+    value: string;
+}
+export interface SecurityProvider {
+    name?: string;
+    typeName?: string;
+}

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

@@ -1,2 +1,2 @@
-export * from './SecurityCache';
-export * from './SecurityCacheInterfaces';
+export * from './SecurityCache';
+export * from './SecurityCacheInterfaces';

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

@@ -1,67 +1,67 @@
-import API from '../../APICore';
-import { New, PageModel } from '../BaseInterfaces';
-import { ActivityOperation } from '../Enums';
-import Resource from '../Resource';
-import { ScheduleModel } from '../SecurityCache';
-import SourcesDatasets from './SourcesDatasets/SourcesDatasets';
-import SourcesFields from './SourcesFields/SourcesFields';
-import { CreateSourceModel, CreateSourceOptions, LightSourceModel, ListOperationalStatusSourcesParams, ListSourcesParams, RawSourceConfig, SourceModel } from './SourcesInterfaces';
-import SourcesMappings from './SourcesMappings/SourcesMappings';
-import SourcesMetadata from './SourcesMetadata/SourcesMetadata';
-export default class Sources extends Resource {
-    protected api: API;
-    protected serverlessApi: API;
-    static baseUrl: string;
-    field: SourcesFields;
-    mappings: SourcesMappings;
-    datasets: SourcesDatasets;
-    metadata: SourcesMetadata;
-    constructor(api: API, serverlessApi: API);
-    create(source: New<CreateSourceModel, 'resourceId'>, options?: CreateSourceOptions): Promise<{
-        id: string;
-    }>;
-    list(params?: ListSourcesParams): Promise<PageModel<SourceModel, "sourceModels">>;
-    /**
-     * @description New API resource for the list of sources
-     * @experimental
-     */
-    listOperationalStatus(params?: ListOperationalStatusSourcesParams): Promise<PageModel<SourceModel, "sourceModels">>;
-    createFromRaw(rawSourceConfig: RawSourceConfig, options?: CreateSourceOptions): Promise<{
-        id: string;
-    }>;
-    delete(sourceId: string): Promise<Record<string, unknown>>;
-    get(sourceId: string): Promise<SourceModel>;
-    update(sourceId: string, source: CreateSourceModel, options?: CreateSourceOptions): Promise<{
-        id: string;
-    }>;
-    applyChanges(sourceId: string): Promise<Record<string, unknown>>;
-    isDedicated(sourceId: string): Promise<{
-        value: boolean;
-    }>;
-    setDedicated(sourceId: string, enabled?: boolean): Promise<Record<string, unknown>>;
-    dumpRefresh(sourceId: string): Promise<{
-        value: boolean;
-    }>;
-    duplicate(sourceId: string, newSourceName: string, logicalIndexId?: string): Promise<SourceModel>;
-    evictCachedCrawlerConfig(sourceId: string): Promise<Record<string, unknown>>;
-    fullRefresh(sourceId: string): Promise<SourceModel>;
-    incrementalRefresh(sourceId: string): Promise<SourceModel>;
-    listSourceItemTypes(sourceId: string): Promise<string[]>;
-    getLightSource(sourceId: string): Promise<LightSourceModel>;
-    pauseRefresh(sourceId: string): Promise<SourceModel>;
-    setPushRefreshStatus(sourceId: string, activityOperation: ActivityOperation): Promise<Record<string, unknown>>;
-    getRawSource(sourceId: string): Promise<RawSourceConfig>;
-    updateRawSource(sourceId: string, platformSourceConfig: RawSourceConfig, options?: CreateSourceOptions): Promise<{
-        id: string;
-    }>;
-    rebuild(sourceId: string): Promise<SourceModel>;
-    resumeRefresh(sourceId: string): Promise<SourceModel>;
-    retryCreation(sourceId: string): Promise<SourceModel>;
-    listSchedules(sourceId: string): Promise<ScheduleModel[]>;
-    createSchedule(sourceId: string, sourceSchedule: ScheduleModel): Promise<ScheduleModel>;
-    deleteSchedule(sourceId: string, scheduleId: string): Promise<Record<string, unknown>>;
-    updateSchedule(sourceId: string, scheduleId: string, sourceSchedule: ScheduleModel): Promise<ScheduleModel>;
-    startRefresh(sourceId: string): Promise<SourceModel>;
-    stopRefresh(sourceId: string): Promise<SourceModel>;
-    abortTaskForActivity(sourceId: string, activityId: string): Promise<Record<string, unknown>>;
-}
+import API from '../../APICore';
+import { New, PageModel } from '../BaseInterfaces';
+import { ActivityOperation } from '../Enums';
+import Resource from '../Resource';
+import { ScheduleModel } from '../SecurityCache';
+import SourcesDatasets from './SourcesDatasets/SourcesDatasets';
+import SourcesFields from './SourcesFields/SourcesFields';
+import { CreateSourceModel, CreateSourceOptions, LightSourceModel, ListOperationalStatusSourcesParams, ListSourcesParams, RawSourceConfig, SourceModel } from './SourcesInterfaces';
+import SourcesMappings from './SourcesMappings/SourcesMappings';
+import SourcesMetadata from './SourcesMetadata/SourcesMetadata';
+export default class Sources extends Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    static baseUrl: string;
+    field: SourcesFields;
+    mappings: SourcesMappings;
+    datasets: SourcesDatasets;
+    metadata: SourcesMetadata;
+    constructor(api: API, serverlessApi: API);
+    create(source: New<CreateSourceModel, 'resourceId'>, options?: CreateSourceOptions): Promise<{
+        id: string;
+    }>;
+    list(params?: ListSourcesParams): Promise<PageModel<SourceModel, "sourceModels">>;
+    /**
+     * @description New API resource for the list of sources
+     * @experimental
+     */
+    listOperationalStatus(params?: ListOperationalStatusSourcesParams): Promise<PageModel<SourceModel, "sourceModels">>;
+    createFromRaw(rawSourceConfig: RawSourceConfig, options?: CreateSourceOptions): Promise<{
+        id: string;
+    }>;
+    delete(sourceId: string): Promise<Record<string, unknown>>;
+    get(sourceId: string): Promise<SourceModel>;
+    update(sourceId: string, source: CreateSourceModel, options?: CreateSourceOptions): Promise<{
+        id: string;
+    }>;
+    applyChanges(sourceId: string): Promise<Record<string, unknown>>;
+    isDedicated(sourceId: string): Promise<{
+        value: boolean;
+    }>;
+    setDedicated(sourceId: string, enabled?: boolean): Promise<Record<string, unknown>>;
+    dumpRefresh(sourceId: string): Promise<{
+        value: boolean;
+    }>;
+    duplicate(sourceId: string, newSourceName: string, logicalIndexId?: string): Promise<SourceModel>;
+    evictCachedCrawlerConfig(sourceId: string): Promise<Record<string, unknown>>;
+    fullRefresh(sourceId: string): Promise<SourceModel>;
+    incrementalRefresh(sourceId: string): Promise<SourceModel>;
+    listSourceItemTypes(sourceId: string): Promise<string[]>;
+    getLightSource(sourceId: string): Promise<LightSourceModel>;
+    pauseRefresh(sourceId: string): Promise<SourceModel>;
+    setPushRefreshStatus(sourceId: string, activityOperation: ActivityOperation): Promise<Record<string, unknown>>;
+    getRawSource(sourceId: string): Promise<RawSourceConfig>;
+    updateRawSource(sourceId: string, platformSourceConfig: RawSourceConfig, options?: CreateSourceOptions): Promise<{
+        id: string;
+    }>;
+    rebuild(sourceId: string): Promise<SourceModel>;
+    resumeRefresh(sourceId: string): Promise<SourceModel>;
+    retryCreation(sourceId: string): Promise<SourceModel>;
+    listSchedules(sourceId: string): Promise<ScheduleModel[]>;
+    createSchedule(sourceId: string, sourceSchedule: ScheduleModel): Promise<ScheduleModel>;
+    deleteSchedule(sourceId: string, scheduleId: string): Promise<Record<string, unknown>>;
+    updateSchedule(sourceId: string, scheduleId: string, sourceSchedule: ScheduleModel): Promise<ScheduleModel>;
+    startRefresh(sourceId: string): Promise<SourceModel>;
+    stopRefresh(sourceId: string): Promise<SourceModel>;
+    abortTaskForActivity(sourceId: string, activityId: string): Promise<Record<string, unknown>>;
+}

package/dist/definitions/resources/Sources/SourcesDatasets/SourcesDatasets.d.ts

@@ -1,8 +1,8 @@
-import { DatasetImportProgressModel, DatasetModel, DatasetType } from './SourcesDatasetsInterfaces';
-import Resource from '../../Resource';
-export default class SourcesDatasets extends Resource {
-    static baseUrl: string;
-    list(): Promise<DatasetModel>;
-    import(datasetName: DatasetType, withContent?: boolean): Promise<string>;
-    progress(requestId: string): Promise<DatasetImportProgressModel>;
-}
+import { DatasetImportProgressModel, DatasetModel, DatasetType } from './SourcesDatasetsInterfaces';
+import Resource from '../../Resource';
+export default class SourcesDatasets extends Resource {
+    static baseUrl: string;
+    list(): Promise<DatasetModel>;
+    import(datasetName: DatasetType, withContent?: boolean): Promise<string>;
+    progress(requestId: string): Promise<DatasetImportProgressModel>;
+}

package/dist/definitions/resources/Sources/SourcesDatasets/SourcesDatasetsInterfaces.d.ts

@@ -1,24 +1,24 @@
-export interface DatasetModel {
-    hasStaticContent: boolean;
-    name: string;
-    note: string;
-}
-export declare enum DatasetType {
-    web = "WEB",
-    ecommerce = "ecommerce"
-}
-export declare enum DatasetResult {
-    error = "ERROR",
-    success = "SUCCESS"
-}
-export declare enum DatasetStatus {
-    completed = "COMPLETED",
-    inProgress = "IN_PROGRESS",
-    pending = "PENDING"
-}
-export interface DatasetImportProgressModel {
-    errorCode: string;
-    requestId: string;
-    result: DatasetResult;
-    status: DatasetStatus;
-}
+export interface DatasetModel {
+    hasStaticContent: boolean;
+    name: string;
+    note: string;
+}
+export declare enum DatasetType {
+    web = "WEB",
+    ecommerce = "ecommerce"
+}
+export declare enum DatasetResult {
+    error = "ERROR",
+    success = "SUCCESS"
+}
+export declare enum DatasetStatus {
+    completed = "COMPLETED",
+    inProgress = "IN_PROGRESS",
+    pending = "PENDING"
+}
+export interface DatasetImportProgressModel {
+    errorCode: string;
+    requestId: string;
+    result: DatasetResult;
+    status: DatasetStatus;
+}

package/dist/definitions/resources/Sources/SourcesDatasets/index.d.ts

@@ -1,2 +1,2 @@
-export * from './SourcesDatasets';
-export * from './SourcesDatasetsInterfaces';
+export * from './SourcesDatasets';
+export * from './SourcesDatasetsInterfaces';

package/dist/definitions/resources/Sources/SourcesFields/SourcesFields.d.ts

@@ -1,10 +1,10 @@
-import { PageModel } from '../../BaseInterfaces';
-import Resource from '../../Resource';
-import { ListSourcesFieldsParams, SourceFieldModel } from './SourcesFieldsInterfaces';
-export default class SourcesFields extends Resource {
-    static baseUrl: string;
-    list(params?: ListSourcesFieldsParams): Promise<PageModel<SourceFieldModel, "items">>;
-    get(fieldId: string, includeMappings?: boolean): Promise<SourceFieldModel>;
-    create(fieldModel: SourceFieldModel): Promise<Record<string, unknown>>;
-    update(fieldId: string, fieldModel: SourceFieldModel): Promise<Record<string, unknown>>;
-}
+import { PageModel } from '../../BaseInterfaces';
+import Resource from '../../Resource';
+import { ListSourcesFieldsParams, SourceFieldModel } from './SourcesFieldsInterfaces';
+export default class SourcesFields extends Resource {
+    static baseUrl: string;
+    list(params?: ListSourcesFieldsParams): Promise<PageModel<SourceFieldModel, "items">>;
+    get(fieldId: string, includeMappings?: boolean): Promise<SourceFieldModel>;
+    create(fieldModel: SourceFieldModel): Promise<Record<string, unknown>>;
+    update(fieldId: string, fieldModel: SourceFieldModel): Promise<Record<string, unknown>>;
+}

package/dist/definitions/resources/Sources/SourcesFields/SourcesFieldsInterfaces.d.ts

@@ -1,15 +1,15 @@
-import { FieldModel, ListFieldsParams } from '../../Fields';
-import { LightSourceModel } from '../SourcesInterfaces';
-import { MappingModel } from '../SourcesMappings';
-export interface ListSourcesFieldsParams extends ListFieldsParams {
-    includeMappings?: boolean;
-}
-export interface SourceFieldModel extends FieldModel {
-    sources?: LightSourceModel[];
-    mappings?: FieldMappingModel[];
-}
-export interface FieldMappingModel {
-    mappings: MappingModel[];
-    sourceId: string;
-    sourceName: string;
-}
+import { FieldModel, ListFieldsParams } from '../../Fields';
+import { LightSourceModel } from '../SourcesInterfaces';
+import { MappingModel } from '../SourcesMappings';
+export interface ListSourcesFieldsParams extends ListFieldsParams {
+    includeMappings?: boolean;
+}
+export interface SourceFieldModel extends FieldModel {
+    sources?: LightSourceModel[];
+    mappings?: FieldMappingModel[];
+}
+export interface FieldMappingModel {
+    mappings: MappingModel[];
+    sourceId: string;
+    sourceName: string;
+}

package/dist/definitions/resources/Sources/SourcesFields/index.d.ts

@@ -1,2 +1,2 @@
-export * from './SourcesFields';
-export * from './SourcesFieldsInterfaces';
+export * from './SourcesFields';
+export * from './SourcesFieldsInterfaces';