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

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

@@ -1,114 +1,114 @@
-import { GranularResource, Paginated } from '../BaseInterfaces';
-import { FilterHostType, FilterLastOperationResultType, FilterLastOperationType, FilterStatusType, SortingOrder, SortingType, SourceOperationalStatus, SourceSecurityOption, SourceType, SourceVisibility } from '../Enums';
-import { SecurityProvider, SecurityProviderModel } from '../SecurityCache/SecurityCacheInterfaces';
-import * as SourcesSubInterface from './SourcesSubInterfaces';
-import { MappingModel } from './SourcesMappings';
-export * from './SourcesSubInterfaces';
-interface ListParams extends Paginated {
-    filter?: string;
-    sortingOrder?: SortingOrder;
-    sortingType?: SortingType;
-    writeAccessOnly?: boolean;
-}
-export interface ListOperationalStatusSourcesParams extends ListParams {
-    sourceOperationalStatus: SourceOperationalStatus;
-}
-export interface ListSourcesParams extends ListParams {
-    filterHostType?: FilterHostType;
-    filterLastOperationResultType?: FilterLastOperationResultType;
-    filterLastOperationType?: FilterLastOperationType;
-    filterStatusType?: FilterStatusType;
-}
-export interface ExtendedConfig {
-    addressPatterns?: SourcesSubInterface.AddressPattern[];
-    authenticationForms?: Record<string, SourcesSubInterface.FormAuthentication>;
-    caseSensitivePatterns?: boolean;
-    dataFiles?: Record<string, SourcesSubInterface.DataFile>;
-    dbConnectionString?: string;
-    documentConfig?: SourcesSubInterface.DocumentConfig;
-    documentConsumerURI?: string;
-    extendedDataFiles?: Record<string, SourcesSubInterface.ExtendedDataFile>;
-    indexIdentifier?: string;
-    metricsEnabled?: boolean;
-    parameters?: Record<string, SourcesSubInterface.ParameterModel>;
-    permissions?: SourcesSubInterface.PermissionLevel[];
-    securityProviders?: Record<string, SecurityProvider>;
-    sourceInformation?: SourcesSubInterface.SourceInformation;
-    sourceSecurityOption?: SourceSecurityOption;
-    startingAddresses?: string[];
-    userIdentities?: Record<string, SourcesSubInterface.UserIdentityModel>;
-}
-export interface RawSourceConfig extends GranularResource {
-    additionalComments?: string;
-    additionalInfos?: any;
-    configuration?: ExtendedConfig;
-    crawlerInstanceType?: string;
-    crawlingModuleId?: string;
-    fromRaw?: boolean;
-    id?: string;
-    logicalIndex?: string;
-    mappings?: MappingModel[];
-    name?: string;
-    onPremisesEnabled?: boolean;
-    owner?: string;
-    postConversionExtensions?: SourcesSubInterface.SourceExtensionModel[];
-    preConversionExtensions?: SourcesSubInterface.SourceExtensionModel[];
-    pushEnabled?: boolean;
-    streamEnabled?: boolean;
-    resourceId?: string;
-    securityProviderReferences?: string[];
-    securityProviders?: SecurityProviderModel[];
-    sourceType?: SourceType;
-}
-export interface SourceModel extends GranularResource {
-    alwaysTrustCertificates?: boolean;
-    configurationError?: SourcesSubInterface.ConfigurationError;
-    crawlingModuleId?: string;
-    customParameters?: Record<string, string>;
-    formAuthenticationConfig?: SourcesSubInterface.FormAuthenticationConfig;
-    id?: string;
-    information?: SourcesSubInterface.SourceInformation;
-    logicalIndex?: string;
-    mappings?: MappingModel[];
-    name?: string;
-    ocrFileTypes?: string[];
-    onPremisesEnabled?: boolean;
-    owner?: string;
-    password?: string;
-    pendingCrawlingModuleId?: string;
-    permissions?: SourcesSubInterface.DocumentPermissionModel;
-    postConversionExtensions?: SourcesSubInterface.SourceExtensionModel[];
-    preConversionExtensions?: SourcesSubInterface.SourceExtensionModel[];
-    pushEnabled?: boolean;
-    resourceId?: string;
-    securityProviderReferences?: string[];
-    sourceType?: SourceType;
-    sourceVisibility?: SourceVisibility;
-    streamEnabled?: boolean;
-    urlFilters?: SourcesSubInterface.UrlFilter[];
-    username?: string;
-}
-export interface LightSourceModel {
-    crawlerInstanceType?: string;
-    id?: string;
-    name?: string;
-    onPremisesEnabled?: boolean;
-    pushEnabled?: boolean;
-    streamEnabled?: boolean;
-    sourceType?: SourceType;
-}
-export interface CreateSourceModel extends SourceModel, SourcesSubInterface.SourceInformation {
-    AutomaticFormAuth?: string;
-    FormAuth?: string;
-    authentication?: string;
-    ocrType?: string;
-    passwordInputName?: string;
-    passwordInputValue?: string;
-    usernameInputName?: string;
-    usernameInputValue?: string;
-    [key: string]: any;
-}
-export interface CreateSourceOptions {
-    rebuild?: boolean;
-    updateSecurityProviders?: boolean;
-}
+import { GranularResource, Paginated } from '../BaseInterfaces';
+import { FilterHostType, FilterLastOperationResultType, FilterLastOperationType, FilterStatusType, SortingOrder, SortingType, SourceOperationalStatus, SourceSecurityOption, SourceType, SourceVisibility } from '../Enums';
+import { SecurityProvider, SecurityProviderModel } from '../SecurityCache/SecurityCacheInterfaces';
+import * as SourcesSubInterface from './SourcesSubInterfaces';
+import { MappingModel } from './SourcesMappings';
+export * from './SourcesSubInterfaces';
+interface ListParams extends Paginated {
+    filter?: string;
+    sortingOrder?: SortingOrder;
+    sortingType?: SortingType;
+    writeAccessOnly?: boolean;
+}
+export interface ListOperationalStatusSourcesParams extends ListParams {
+    sourceOperationalStatus: SourceOperationalStatus;
+}
+export interface ListSourcesParams extends ListParams {
+    filterHostType?: FilterHostType;
+    filterLastOperationResultType?: FilterLastOperationResultType;
+    filterLastOperationType?: FilterLastOperationType;
+    filterStatusType?: FilterStatusType;
+}
+export interface ExtendedConfig {
+    addressPatterns?: SourcesSubInterface.AddressPattern[];
+    authenticationForms?: Record<string, SourcesSubInterface.FormAuthentication>;
+    caseSensitivePatterns?: boolean;
+    dataFiles?: Record<string, SourcesSubInterface.DataFile>;
+    dbConnectionString?: string;
+    documentConfig?: SourcesSubInterface.DocumentConfig;
+    documentConsumerURI?: string;
+    extendedDataFiles?: Record<string, SourcesSubInterface.ExtendedDataFile>;
+    indexIdentifier?: string;
+    metricsEnabled?: boolean;
+    parameters?: Record<string, SourcesSubInterface.ParameterModel>;
+    permissions?: SourcesSubInterface.PermissionLevel[];
+    securityProviders?: Record<string, SecurityProvider>;
+    sourceInformation?: SourcesSubInterface.SourceInformation;
+    sourceSecurityOption?: SourceSecurityOption;
+    startingAddresses?: string[];
+    userIdentities?: Record<string, SourcesSubInterface.UserIdentityModel>;
+}
+export interface RawSourceConfig extends GranularResource {
+    additionalComments?: string;
+    additionalInfos?: any;
+    configuration?: ExtendedConfig;
+    crawlerInstanceType?: string;
+    crawlingModuleId?: string;
+    fromRaw?: boolean;
+    id?: string;
+    logicalIndex?: string;
+    mappings?: MappingModel[];
+    name?: string;
+    onPremisesEnabled?: boolean;
+    owner?: string;
+    postConversionExtensions?: SourcesSubInterface.SourceExtensionModel[];
+    preConversionExtensions?: SourcesSubInterface.SourceExtensionModel[];
+    pushEnabled?: boolean;
+    streamEnabled?: boolean;
+    resourceId?: string;
+    securityProviderReferences?: string[];
+    securityProviders?: SecurityProviderModel[];
+    sourceType?: SourceType;
+}
+export interface SourceModel extends GranularResource {
+    alwaysTrustCertificates?: boolean;
+    configurationError?: SourcesSubInterface.ConfigurationError;
+    crawlingModuleId?: string;
+    customParameters?: Record<string, string>;
+    formAuthenticationConfig?: SourcesSubInterface.FormAuthenticationConfig;
+    id?: string;
+    information?: SourcesSubInterface.SourceInformation;
+    logicalIndex?: string;
+    mappings?: MappingModel[];
+    name?: string;
+    ocrFileTypes?: string[];
+    onPremisesEnabled?: boolean;
+    owner?: string;
+    password?: string;
+    pendingCrawlingModuleId?: string;
+    permissions?: SourcesSubInterface.DocumentPermissionModel;
+    postConversionExtensions?: SourcesSubInterface.SourceExtensionModel[];
+    preConversionExtensions?: SourcesSubInterface.SourceExtensionModel[];
+    pushEnabled?: boolean;
+    resourceId?: string;
+    securityProviderReferences?: string[];
+    sourceType?: SourceType;
+    sourceVisibility?: SourceVisibility;
+    streamEnabled?: boolean;
+    urlFilters?: SourcesSubInterface.UrlFilter[];
+    username?: string;
+}
+export interface LightSourceModel {
+    crawlerInstanceType?: string;
+    id?: string;
+    name?: string;
+    onPremisesEnabled?: boolean;
+    pushEnabled?: boolean;
+    streamEnabled?: boolean;
+    sourceType?: SourceType;
+}
+export interface CreateSourceModel extends SourceModel, SourcesSubInterface.SourceInformation {
+    AutomaticFormAuth?: string;
+    FormAuth?: string;
+    authentication?: string;
+    ocrType?: string;
+    passwordInputName?: string;
+    passwordInputValue?: string;
+    usernameInputName?: string;
+    usernameInputValue?: string;
+    [key: string]: any;
+}
+export interface CreateSourceOptions {
+    rebuild?: boolean;
+    updateSecurityProviders?: boolean;
+}

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

@@ -1,7 +1,7 @@
-import Resource from '../../Resource';
-import { MappingsConfiguration, UpdateMappingsConfiguration } from './SourcesMappingsInterfaces';
-export default class SourcesMappings extends Resource {
-    static baseUrl: string;
-    get(sourceId: string): Promise<MappingsConfiguration>;
-    update(sourceId: string, mappingsConfiguration: UpdateMappingsConfiguration, rebuild?: boolean): Promise<Record<string, unknown>>;
-}
+import Resource from '../../Resource';
+import { MappingsConfiguration, UpdateMappingsConfiguration } from './SourcesMappingsInterfaces';
+export default class SourcesMappings extends Resource {
+    static baseUrl: string;
+    get(sourceId: string): Promise<MappingsConfiguration>;
+    update(sourceId: string, mappingsConfiguration: UpdateMappingsConfiguration, rebuild?: boolean): Promise<Record<string, unknown>>;
+}

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

@@ -1,72 +1,72 @@
-import { FieldTypes, MappingModelKind } from '../../Enums';
-export interface MappingSettingsModel {
-    /**
-     * The [mapping](https://docs.coveo.com/en/217/) rules.
-     * See [Mapping Rule Syntax Reference](https://docs.coveo.com/en/1839/).
-     */
-    rules: MappingRule[];
-}
-export interface UpdateTypedMappingSettingsModel extends MappingSettingsModel {
-    /**
-     * The unique identifier of the mapping.
-     * Note: Typically matches the type value.
-     * Example: Video
-     */
-    type: string;
-}
-export interface TypedMappingSettingsModel extends UpdateTypedMappingSettingsModel {
-    /**
-     * The [type](https://docs.coveo.com/en/210/) of item for which the mapping applies.
-     * Example: Video
-     */
-    id: string;
-}
-export interface MappingsConfiguration {
-    common: MappingSettingsModel;
-    types: TypedMappingSettingsModel[];
-}
-export interface UpdateMappingsConfiguration {
-    /**
-     * The common [mappings](https://docs.coveo.com/en/217/)
-     * (i.e., the mappings that apply to all [item](https://docs.coveo.com/en/210/) types).
-     */
-    common: MappingSettingsModel;
-    /**
-     * The specific [mappings](The specific mappings (i.e., the mappings that apply only to specified item types).)
-     * (i.e., the mappings that apply only to specified [item](https://docs.coveo.com/en/210/) types).
-     */
-    types: UpdateTypedMappingSettingsModel[];
-}
-export interface MappingModel {
-    content?: string;
-    extractionMethod?: string;
-    fieldName?: string;
-    fieldTypeHint?: FieldTypes;
-    id?: string;
-    kind?: MappingModelKind;
-    type?: string;
-    literalContent?: string;
-    metadataContent?: string;
-}
-export interface UpdateMappingRule {
-    /**
-     *
-     * The mapping rule statements.
-     * Example: ["%[internal_rating]"]
-     * See [Mapping Rule Syntax Reference](https://docs.coveo.com/en/1839/).
-     */
-    content: string[];
-    /**
-     * The name of the target [field](https://docs.coveo.com/en/200/) to populate with
-     * the first non-null value yielded by a mapping rule statement from the content array.
-     * Example: rating
-     */
-    field: string;
-}
-export interface MappingRule extends UpdateMappingRule {
-    /**
-     * The unique identifier of the mapping rule.
-     * Example: q5dpywnbpb3ul7xpyodh3e2j7i
-     */
-    id: string;
-}
+import { FieldTypes, MappingModelKind } from '../../Enums';
+export interface MappingSettingsModel {
+    /**
+     * The [mapping](https://docs.coveo.com/en/217/) rules.
+     * See [Mapping Rule Syntax Reference](https://docs.coveo.com/en/1839/).
+     */
+    rules: MappingRule[];
+}
+export interface UpdateTypedMappingSettingsModel extends MappingSettingsModel {
+    /**
+     * The unique identifier of the mapping.
+     * Note: Typically matches the type value.
+     * Example: Video
+     */
+    type: string;
+}
+export interface TypedMappingSettingsModel extends UpdateTypedMappingSettingsModel {
+    /**
+     * The [type](https://docs.coveo.com/en/210/) of item for which the mapping applies.
+     * Example: Video
+     */
+    id: string;
+}
+export interface MappingsConfiguration {
+    common: MappingSettingsModel;
+    types: TypedMappingSettingsModel[];
+}
+export interface UpdateMappingsConfiguration {
+    /**
+     * The common [mappings](https://docs.coveo.com/en/217/)
+     * (i.e., the mappings that apply to all [item](https://docs.coveo.com/en/210/) types).
+     */
+    common: MappingSettingsModel;
+    /**
+     * The specific [mappings](The specific mappings (i.e., the mappings that apply only to specified item types).)
+     * (i.e., the mappings that apply only to specified [item](https://docs.coveo.com/en/210/) types).
+     */
+    types: UpdateTypedMappingSettingsModel[];
+}
+export interface MappingModel {
+    content?: string;
+    extractionMethod?: string;
+    fieldName?: string;
+    fieldTypeHint?: FieldTypes;
+    id?: string;
+    kind?: MappingModelKind;
+    type?: string;
+    literalContent?: string;
+    metadataContent?: string;
+}
+export interface UpdateMappingRule {
+    /**
+     *
+     * The mapping rule statements.
+     * Example: ["%[internal_rating]"]
+     * See [Mapping Rule Syntax Reference](https://docs.coveo.com/en/1839/).
+     */
+    content: string[];
+    /**
+     * The name of the target [field](https://docs.coveo.com/en/200/) to populate with
+     * the first non-null value yielded by a mapping rule statement from the content array.
+     * Example: rating
+     */
+    field: string;
+}
+export interface MappingRule extends UpdateMappingRule {
+    /**
+     * The unique identifier of the mapping rule.
+     * Example: q5dpywnbpb3ul7xpyodh3e2j7i
+     */
+    id: string;
+}

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

@@ -1,2 +1,2 @@
-export * from './SourcesMappings';
-export * from './SourcesMappingsInterfaces';
+export * from './SourcesMappings';
+export * from './SourcesMappingsInterfaces';

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

@@ -1,9 +1,9 @@
-import Resource from '../../Resource';
-import { Paginated } from '../../BaseInterfaces';
-import { MetadataPageModel, MetadataReportStatus } from './SourcesMetadataInterfaces';
-export default class SourcesMetadata extends Resource {
-    static baseUrl: string;
-    generateReport(sourceId: string): Promise<void>;
-    getReport(sourceId: string, params?: Paginated): Promise<MetadataPageModel>;
-    getReportStatus(sourceId: string): Promise<MetadataReportStatus>;
-}
+import Resource from '../../Resource';
+import { Paginated } from '../../BaseInterfaces';
+import { MetadataPageModel, MetadataReportStatus } from './SourcesMetadataInterfaces';
+export default class SourcesMetadata extends Resource {
+    static baseUrl: string;
+    generateReport(sourceId: string): Promise<void>;
+    getReport(sourceId: string, params?: Paginated): Promise<MetadataPageModel>;
+    getReportStatus(sourceId: string): Promise<MetadataReportStatus>;
+}

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

@@ -1,55 +1,55 @@
-import { PageModel } from '../../BaseInterfaces';
-export interface MetadataPageModel extends PageModel {
-    items: Metadata[];
-    creationDate: number;
-    expirationDate: number;
-    sampledDocumentCount: number;
-    documentErrorCount: number;
-}
-export interface MetadataValue {
-    /**
-     * The metadata value
-     */
-    metadataValue: any;
-    /**
-     * The number of time the value has been seen on documents
-     */
-    count: number;
-}
-export interface Metadata {
-    /**
-     * The key for a metadata.
-     */
-    key: string;
-    /**
-     * The frequency in % at which this metadata has been seen on documents.
-     */
-    frequency: number;
-    /**
-     * Subset of sample values for the metadata.
-     */
-    values: MetadataValue[];
-    /**
-     * The origin of the metadata.
-     */
-    origin: string;
-    /**
-     * Whether the origin is mapped or not.
-     */
-    isMapped: boolean;
-}
-export interface MetadataReportStatus {
-    /**
-     * Indicates that a report is being generated.
-     */
-    reportGenerationInProgress: boolean;
-    /**
-     * Indicates if a report is available.
-     */
-    reportAvailable: boolean;
-    /**
-     * Indicates if the source has documents sampled.
-     * If false, reports cannot be generated.
-     */
-    sampleAvailable: boolean;
-}
+import { PageModel } from '../../BaseInterfaces';
+export interface MetadataPageModel extends PageModel {
+    items: Metadata[];
+    creationDate: number;
+    expirationDate: number;
+    sampledDocumentCount: number;
+    documentErrorCount: number;
+}
+export interface MetadataValue {
+    /**
+     * The metadata value
+     */
+    metadataValue: any;
+    /**
+     * The number of time the value has been seen on documents
+     */
+    count: number;
+}
+export interface Metadata {
+    /**
+     * The key for a metadata.
+     */
+    key: string;
+    /**
+     * The frequency in % at which this metadata has been seen on documents.
+     */
+    frequency: number;
+    /**
+     * Subset of sample values for the metadata.
+     */
+    values: MetadataValue[];
+    /**
+     * The origin of the metadata.
+     */
+    origin: string;
+    /**
+     * Whether the origin is mapped or not.
+     */
+    isMapped: boolean;
+}
+export interface MetadataReportStatus {
+    /**
+     * Indicates that a report is being generated.
+     */
+    reportGenerationInProgress: boolean;
+    /**
+     * Indicates if a report is available.
+     */
+    reportAvailable: boolean;
+    /**
+     * Indicates if the source has documents sampled.
+     * If false, reports cannot be generated.
+     */
+    sampleAvailable: boolean;
+}

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

@@ -1,2 +1,2 @@
-export * from './SourcesMetadata';
-export * from './SourcesMetadataInterfaces';
+export * from './SourcesMetadata';
+export * from './SourcesMetadataInterfaces';

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

@@ -1,6 +1,6 @@
-import { PatternType } from '../../Enums';
-export interface AddressPattern {
-    allowed?: boolean;
-    expression?: string;
-    patternType?: PatternType;
-}
+import { PatternType } from '../../Enums';
+export interface AddressPattern {
+    allowed?: boolean;
+    expression?: string;
+    patternType?: PatternType;
+}

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

@@ -1,37 +1,37 @@
-import { AuthenticationActionMethod, AuthenticationInputType, FormAuthenticationFailedMethod, FormInputType } from '../../Enums';
-export interface FormAuthenticationFailedConfiguration {
-    method: FormAuthenticationFailedMethod;
-    values: string[];
-}
-export interface FormInput {
-    name: string;
-    value?: string;
-    inputType: FormInputType;
-}
-export interface FormAuthenticationConfig {
-    actionMethod?: string;
-    actionUrl?: string;
-    addFoundInputs?: boolean;
-    authenticationFailed?: FormAuthenticationFailedConfiguration;
-    enableJavaScript?: boolean;
-    forceLogin?: boolean;
-    formContentType?: string;
-    formId?: string;
-    formUrl?: string;
-    inputs?: FormInput[];
-    javaScriptLoadingDelayInMilliseconds?: number;
-    customLoginSequence?: any;
-}
-export interface FormAuthenticationInput {
-    name?: string;
-    type?: AuthenticationInputType;
-    value?: string;
-}
-export interface FormAuthentication {
-    actionMethod?: AuthenticationActionMethod;
-    actionURL?: string;
-    formURL?: string;
-    inputs?: FormAuthenticationInput[];
-    reauthenticate?: boolean;
-    secureURL?: string;
-}
+import { AuthenticationActionMethod, AuthenticationInputType, FormAuthenticationFailedMethod, FormInputType } from '../../Enums';
+export interface FormAuthenticationFailedConfiguration {
+    method: FormAuthenticationFailedMethod;
+    values: string[];
+}
+export interface FormInput {
+    name: string;
+    value?: string;
+    inputType: FormInputType;
+}
+export interface FormAuthenticationConfig {
+    actionMethod?: string;
+    actionUrl?: string;
+    addFoundInputs?: boolean;
+    authenticationFailed?: FormAuthenticationFailedConfiguration;
+    enableJavaScript?: boolean;
+    forceLogin?: boolean;
+    formContentType?: string;
+    formId?: string;
+    formUrl?: string;
+    inputs?: FormInput[];
+    javaScriptLoadingDelayInMilliseconds?: number;
+    customLoginSequence?: any;
+}
+export interface FormAuthenticationInput {
+    name?: string;
+    type?: AuthenticationInputType;
+    value?: string;
+}
+export interface FormAuthentication {
+    actionMethod?: AuthenticationActionMethod;
+    actionURL?: string;
+    formURL?: string;
+    inputs?: FormAuthenticationInput[];
+    reauthenticate?: boolean;
+    secureURL?: string;
+}