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

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

@@ -1,104 +1,104 @@
-import { ExcerptSource, ExtensionSettingAction, ExtensionSettingActionOnError, ExtensionSettingConverter } from '../../Enums';
-export interface DataFile {
-    data?: string;
-    sensitive?: boolean;
-}
-export interface CharsetDetectionHint {
-    charset?: string;
-    confidence?: number;
-}
-export interface DocumentProcessorParameters {
-    condition?: any;
-    deleteOnError?: boolean;
-    values?: any;
-}
-export interface DocumentProcessor {
-    parameters?: DocumentProcessorParameters;
-    type?: string;
-}
-export interface ExtensionSetting {
-    action?: ExtensionSettingAction;
-    actionOnError?: ExtensionSettingActionOnError;
-    convertDirectlyToHtml?: boolean;
-    converter?: ExtensionSettingConverter;
-    customConverter?: DocumentProcessor;
-    excerptSource?: ExcerptSource;
-    fileTypeValue?: string;
-    generateThumbnail?: boolean;
-    indexContainer?: boolean;
-    openResultWithQuickView?: boolean;
-    saveExcerptBlob?: boolean;
-    summarizeDocument?: boolean;
-    useContentType?: boolean;
-    useExternalHTMLGenerator?: boolean;
-}
-export interface ExtensionSettingByExtension {
-    extensionSetting?: ExtensionSetting;
-    extensions?: string[];
-}
-export interface ExtensionSettings {
-    byContentTypes?: ExtensionSettingByExtension[];
-    byExtensions?: ExtensionSettingByExtension[];
-    noExtension?: ExtensionSetting;
-    other?: ExtensionSetting;
-}
-export interface LanguageHint {
-    language?: string;
-    probability?: number;
-}
-export interface XMLMetaData {
-    name?: string;
-    value?: string;
-}
-export interface XMLRecordDefinition {
-    author?: string;
-    body?: string;
-    date?: string;
-    dateFormat?: string;
-    metaData?: XMLMetaData[];
-    root?: string;
-    summary?: string;
-    title?: string;
-    unescapeXMLEntities?: boolean;
-    uniqueId?: string;
-    uri?: string;
-}
-export interface DocumentProcessorConfig {
-    addRawTextDataStream?: boolean;
-    beautifyDocuments?: boolean;
-    charsetDetectionHint?: CharsetDetectionHint;
-    excelFloatingPointPrecision?: number;
-    excerptSource?: ExcerptSource;
-    extensionSettings?: ExtensionSettings;
-    fieldMappingOrigin?: string;
-    generateHTML?: boolean;
-    imageMinimumSize?: number;
-    indexExcelNumbers?: boolean;
-    indexMeta?: boolean;
-    languageHints?: LanguageHint[];
-    languagesSettings?: string;
-    maxHTMLOutputSize?: number;
-    maxTextOutputSize?: number;
-    maximumDocumentSize?: number;
-    maximumNumberOfPagesToConvert?: number;
-    openResultWithQuickView?: boolean;
-    reportProgressionTimeout?: number;
-    saveExcerptBlob?: boolean;
-    styleSheet?: string;
-    summarizeDocument?: boolean;
-    summarySize?: number;
-    timeout?: number;
-    titleGrammaticalScoreWeight?: number;
-    titleLengthProbabilityWeight?: number;
-    titlePercentageOfCapsFirstLettersWeight?: number;
-    titlePositionScoreWeight?: number;
-    useClickableUriAsBasePath?: boolean;
-    xmlrecordDefinitions?: XMLRecordDefinition[];
-}
-export interface DocumentConfig {
-    documentProcessorConfig?: DocumentProcessorConfig;
-    indexUri?: string;
-    parameters?: any;
-    postConversions?: DocumentProcessor[];
-    preConversions?: DocumentProcessor[];
-}
+import { ExcerptSource, ExtensionSettingAction, ExtensionSettingActionOnError, ExtensionSettingConverter } from '../../Enums';
+export interface DataFile {
+    data?: string;
+    sensitive?: boolean;
+}
+export interface CharsetDetectionHint {
+    charset?: string;
+    confidence?: number;
+}
+export interface DocumentProcessorParameters {
+    condition?: any;
+    deleteOnError?: boolean;
+    values?: any;
+}
+export interface DocumentProcessor {
+    parameters?: DocumentProcessorParameters;
+    type?: string;
+}
+export interface ExtensionSetting {
+    action?: ExtensionSettingAction;
+    actionOnError?: ExtensionSettingActionOnError;
+    convertDirectlyToHtml?: boolean;
+    converter?: ExtensionSettingConverter;
+    customConverter?: DocumentProcessor;
+    excerptSource?: ExcerptSource;
+    fileTypeValue?: string;
+    generateThumbnail?: boolean;
+    indexContainer?: boolean;
+    openResultWithQuickView?: boolean;
+    saveExcerptBlob?: boolean;
+    summarizeDocument?: boolean;
+    useContentType?: boolean;
+    useExternalHTMLGenerator?: boolean;
+}
+export interface ExtensionSettingByExtension {
+    extensionSetting?: ExtensionSetting;
+    extensions?: string[];
+}
+export interface ExtensionSettings {
+    byContentTypes?: ExtensionSettingByExtension[];
+    byExtensions?: ExtensionSettingByExtension[];
+    noExtension?: ExtensionSetting;
+    other?: ExtensionSetting;
+}
+export interface LanguageHint {
+    language?: string;
+    probability?: number;
+}
+export interface XMLMetaData {
+    name?: string;
+    value?: string;
+}
+export interface XMLRecordDefinition {
+    author?: string;
+    body?: string;
+    date?: string;
+    dateFormat?: string;
+    metaData?: XMLMetaData[];
+    root?: string;
+    summary?: string;
+    title?: string;
+    unescapeXMLEntities?: boolean;
+    uniqueId?: string;
+    uri?: string;
+}
+export interface DocumentProcessorConfig {
+    addRawTextDataStream?: boolean;
+    beautifyDocuments?: boolean;
+    charsetDetectionHint?: CharsetDetectionHint;
+    excelFloatingPointPrecision?: number;
+    excerptSource?: ExcerptSource;
+    extensionSettings?: ExtensionSettings;
+    fieldMappingOrigin?: string;
+    generateHTML?: boolean;
+    imageMinimumSize?: number;
+    indexExcelNumbers?: boolean;
+    indexMeta?: boolean;
+    languageHints?: LanguageHint[];
+    languagesSettings?: string;
+    maxHTMLOutputSize?: number;
+    maxTextOutputSize?: number;
+    maximumDocumentSize?: number;
+    maximumNumberOfPagesToConvert?: number;
+    openResultWithQuickView?: boolean;
+    reportProgressionTimeout?: number;
+    saveExcerptBlob?: boolean;
+    styleSheet?: string;
+    summarizeDocument?: boolean;
+    summarySize?: number;
+    timeout?: number;
+    titleGrammaticalScoreWeight?: number;
+    titleLengthProbabilityWeight?: number;
+    titlePercentageOfCapsFirstLettersWeight?: number;
+    titlePositionScoreWeight?: number;
+    useClickableUriAsBasePath?: boolean;
+    xmlrecordDefinitions?: XMLRecordDefinition[];
+}
+export interface DocumentConfig {
+    documentProcessorConfig?: DocumentProcessorConfig;
+    indexUri?: string;
+    parameters?: any;
+    postConversions?: DocumentProcessor[];
+    preConversions?: DocumentProcessor[];
+}

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

@@ -1,4 +1,4 @@
-export interface ConfigurationError {
-    errorCode?: string;
-    message?: string;
-}
+export interface ConfigurationError {
+    errorCode?: string;
+    message?: string;
+}

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

@@ -1,5 +1,5 @@
-export interface ExtendedDataFile {
-    data?: string;
-    extendedData?: any;
-    sensitive?: boolean;
-}
+export interface ExtendedDataFile {
+    data?: string;
+    extendedData?: any;
+    sensitive?: boolean;
+}

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

@@ -1,9 +1,9 @@
-import { SourceExtensionActionOnError } from '../../Enums';
-export interface SourceExtensionModel {
-    actionOnError?: SourceExtensionActionOnError;
-    condition?: string;
-    extensionId?: string;
-    itemType?: string;
-    parameters?: Record<string, string>;
-    versionId?: string;
-}
+import { SourceExtensionActionOnError } from '../../Enums';
+export interface SourceExtensionModel {
+    actionOnError?: SourceExtensionActionOnError;
+    condition?: string;
+    extensionId?: string;
+    itemType?: string;
+    parameters?: Record<string, string>;
+    versionId?: string;
+}

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

@@ -1,59 +1,59 @@
-import { ActivityOperation, OperationType, SourceStatusType, SourceStatusTypeWithTransition } from '../../Enums';
-export interface SourceCurrentOperation {
-    itemsAdded?: number;
-    itemsFiltered?: number;
-    itemsRemoved?: number;
-    itemsUnchanged?: number;
-    itemsUpdated?: number;
-    operationType: OperationType;
-    statusMessage?: string;
-}
-export interface SourceLastOperation {
-    errorCode?: string;
-    id?: string;
-    initialBuild?: boolean;
-    itemsAdded?: number;
-    itemsFiltered?: number;
-    itemsRemoved?: number;
-    itemsUnchanged?: number;
-    itemsUpdated?: number;
-    numberOfDocuments?: number;
-    operationType: OperationType;
-    result?: string;
-    timestamp?: number;
-}
-export interface NextOperation {
-    operationType?: OperationType;
-    timestamp?: number;
-}
-export interface SourceStatus {
-    allowedOperations?: ActivityOperation[];
-    /**
-     * The status type including transition statuses.
-     */
-    extendedCurrentStatus?: SourceStatusTypeWithTransition;
-    initialBuild?: boolean;
-    numberOfDocuments?: number;
-    numberOfProcessedDocuments?: number;
-    pausedOnErrorCode?: string;
-    refreshType?: OperationType;
-    timestamp?: number;
-    /**
-     * The status type.
-     */
-    type?: SourceStatusType;
-}
-export interface SourceInformation {
-    id?: string;
-    collectionId?: number;
-    collectionName?: string;
-    currentOperation?: SourceCurrentOperation;
-    documentsTotalSize?: number;
-    lastOperation?: SourceLastOperation;
-    nextOperation?: NextOperation;
-    numberOfDocuments?: number;
-    rebuildRequired?: boolean;
-    sourceId?: number;
-    sourceName?: string;
-    sourceStatus?: SourceStatus;
-}
+import { ActivityOperation, OperationType, SourceStatusType, SourceStatusTypeWithTransition } from '../../Enums';
+export interface SourceCurrentOperation {
+    itemsAdded?: number;
+    itemsFiltered?: number;
+    itemsRemoved?: number;
+    itemsUnchanged?: number;
+    itemsUpdated?: number;
+    operationType: OperationType;
+    statusMessage?: string;
+}
+export interface SourceLastOperation {
+    errorCode?: string;
+    id?: string;
+    initialBuild?: boolean;
+    itemsAdded?: number;
+    itemsFiltered?: number;
+    itemsRemoved?: number;
+    itemsUnchanged?: number;
+    itemsUpdated?: number;
+    numberOfDocuments?: number;
+    operationType: OperationType;
+    result?: string;
+    timestamp?: number;
+}
+export interface NextOperation {
+    operationType?: OperationType;
+    timestamp?: number;
+}
+export interface SourceStatus {
+    allowedOperations?: ActivityOperation[];
+    /**
+     * The status type including transition statuses.
+     */
+    extendedCurrentStatus?: SourceStatusTypeWithTransition;
+    initialBuild?: boolean;
+    numberOfDocuments?: number;
+    numberOfProcessedDocuments?: number;
+    pausedOnErrorCode?: string;
+    refreshType?: OperationType;
+    timestamp?: number;
+    /**
+     * The status type.
+     */
+    type?: SourceStatusType;
+}
+export interface SourceInformation {
+    id?: string;
+    collectionId?: number;
+    collectionName?: string;
+    currentOperation?: SourceCurrentOperation;
+    documentsTotalSize?: number;
+    lastOperation?: SourceLastOperation;
+    nextOperation?: NextOperation;
+    numberOfDocuments?: number;
+    rebuildRequired?: boolean;
+    sourceId?: number;
+    sourceName?: string;
+    sourceStatus?: SourceStatus;
+}

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

@@ -1,4 +1,4 @@
-export interface ParameterModel {
-    sensitive?: boolean;
-    value?: string;
-}
+export interface ParameterModel {
+    sensitive?: boolean;
+    value?: string;
+}

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

@@ -1,42 +1,42 @@
-import { DocumentPermissionState, PermissionIdentityType, SinglePermissionIdentityType, SinglePermissionResult, SinglePermissionState } from '../../Enums';
-export interface SinglePermissionModel {
-    additionalInfo?: any;
-    allowed?: boolean;
-    identity?: string;
-    identityType?: SinglePermissionIdentityType;
-    lastUpdateDate?: number;
-    lastUpdateErrorDetail?: string;
-    lastUpdateResult?: SinglePermissionResult;
-    securityProvider?: string;
-    state?: SinglePermissionState;
-}
-export interface PermissionSetModel {
-    anonymousAllowed?: boolean;
-    name?: string;
-    permissions?: SinglePermissionModel[];
-}
-export interface PermissionLevelModel {
-    name?: string;
-    permissionSets?: PermissionSetModel[];
-}
-export interface DocumentPermissionModel {
-    lastUpdatedDate?: number;
-    permissionLevels?: PermissionLevelModel[];
-    state?: DocumentPermissionState;
-}
-export interface Permission {
-    additionalInfo?: any;
-    identity?: string;
-    identityType?: PermissionIdentityType;
-    securityProvider?: string;
-}
-export interface PermissionSet {
-    allowAnonymous?: boolean;
-    allowedPermissions?: Permission[];
-    deniedPermissions?: Permission[];
-    name?: string;
-}
-export interface PermissionLevel {
-    name?: string;
-    permissionSets?: PermissionSet[];
-}
+import { DocumentPermissionState, PermissionIdentityType, SinglePermissionIdentityType, SinglePermissionResult, SinglePermissionState } from '../../Enums';
+export interface SinglePermissionModel {
+    additionalInfo?: any;
+    allowed?: boolean;
+    identity?: string;
+    identityType?: SinglePermissionIdentityType;
+    lastUpdateDate?: number;
+    lastUpdateErrorDetail?: string;
+    lastUpdateResult?: SinglePermissionResult;
+    securityProvider?: string;
+    state?: SinglePermissionState;
+}
+export interface PermissionSetModel {
+    anonymousAllowed?: boolean;
+    name?: string;
+    permissions?: SinglePermissionModel[];
+}
+export interface PermissionLevelModel {
+    name?: string;
+    permissionSets?: PermissionSetModel[];
+}
+export interface DocumentPermissionModel {
+    lastUpdatedDate?: number;
+    permissionLevels?: PermissionLevelModel[];
+    state?: DocumentPermissionState;
+}
+export interface Permission {
+    additionalInfo?: any;
+    identity?: string;
+    identityType?: PermissionIdentityType;
+    securityProvider?: string;
+}
+export interface PermissionSet {
+    allowAnonymous?: boolean;
+    allowedPermissions?: Permission[];
+    deniedPermissions?: Permission[];
+    name?: string;
+}
+export interface PermissionLevel {
+    name?: string;
+    permissionSets?: PermissionSet[];
+}

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

@@ -1,6 +1,6 @@
-import { UrlFilterType } from '../../Enums';
-export interface UrlFilter {
-    filter?: string;
-    filterType?: UrlFilterType;
-    includeFilter?: boolean;
-}
+import { UrlFilterType } from '../../Enums';
+export interface UrlFilter {
+    filter?: string;
+    filterType?: UrlFilterType;
+    includeFilter?: boolean;
+}

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

@@ -1,5 +1,5 @@
-export interface UserIdentityModel {
-    name?: string;
-    password?: string;
-    userName?: string;
-}
+export interface UserIdentityModel {
+    name?: string;
+    password?: string;
+    userName?: string;
+}

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

@@ -1,11 +1,11 @@
-export * from './Address';
-export * from './Authentification';
-export * from './Document';
-export * from './Error';
-export * from './ExtendedDataFile';
-export * from './Extension';
-export * from './Information';
-export * from './Parameter';
-export * from './Permission';
-export * from './Url';
-export * from './User';
+export * from './Address';
+export * from './Authentification';
+export * from './Document';
+export * from './Error';
+export * from './ExtendedDataFile';
+export * from './Extension';
+export * from './Information';
+export * from './Parameter';
+export * from './Permission';
+export * from './Url';
+export * from './User';

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

@@ -1,6 +1,6 @@
-export * from './Sources';
-export * from './SourcesInterfaces';
-export * from './SourcesFields';
-export * from './SourcesMappings';
-export * from './SourcesDatasets';
-export * from './SourcesMetadata';
+export * from './Sources';
+export * from './SourcesInterfaces';
+export * from './SourcesFields';
+export * from './SourcesMappings';
+export * from './SourcesDatasets';
+export * from './SourcesMetadata';

package/dist/definitions/resources/TableauService/ContentQuery/ContentQuery.d.ts

@@ -1,8 +1,8 @@
-import Resource from '../../Resource';
-import { TableauDashboardParams, TableauDashboardResponse, TableauDashboardViewParams, TableauReportParams, TableauReportResponse } from './ContentQueryInterfaces';
-export default class ContentQuery extends Resource {
-    static baseUrl: string;
-    listTableauReports(params: TableauReportParams): Promise<TableauReportResponse[]>;
-    getTableauDashboard(params: TableauDashboardParams): Promise<TableauDashboardResponse>;
-    getTableauDashboardView(params: TableauDashboardViewParams): Promise<TableauDashboardResponse>;
-}
+import Resource from '../../Resource';
+import { TableauDashboardParams, TableauDashboardResponse, TableauDashboardViewParams, TableauReportParams, TableauReportResponse } from './ContentQueryInterfaces';
+export default class ContentQuery extends Resource {
+    static baseUrl: string;
+    listTableauReports(params: TableauReportParams): Promise<TableauReportResponse[]>;
+    getTableauDashboard(params: TableauDashboardParams): Promise<TableauDashboardResponse>;
+    getTableauDashboardView(params: TableauDashboardViewParams): Promise<TableauDashboardResponse>;
+}

package/dist/definitions/resources/TableauService/ContentQuery/ContentQueryInterfaces.d.ts

@@ -1,58 +1,58 @@
-export interface TableauReportParams {
-    /**
-     * The type of content of the dashboard. Can be either components, dashboards or datasources
-     */
-    contentType: string;
-    /**
-     * The organization Id
-     */
-    organizationId: string;
-}
-export interface TableauDashboardParams extends TableauReportParams {
-    /**
-     * The url of the report dashboard
-     */
-    dashboardContentUrl: string;
-}
-export interface TableauDashboardViewParams extends TableauDashboardParams {
-    /**
-     * The url of a specific view in the dashboard
-     */
-    viewContentUrl: string;
-}
-export interface TableauReportResponse {
-    /**
-     * The content url of the dashboard
-     */
-    contentUrl: string;
-    /**
-     * The description of the dashboard
-     */
-    description: string;
-    /**
-     * The name of the dashboard
-     */
-    name: string;
-    /**
-     * The last dashboard update
-     */
-    updatedAt: string;
-}
-export interface TableauDashboardResponse {
-    /**
-     * The authenticated url for embeding purpose
-     */
-    authenticatedUrl: string;
-    /**
-     * The content url of the dashboard
-     */
-    contentUrl: string;
-    /**
-     * The specific dashboard
-     */
-    dashboard: TableauReportResponse;
-    /**
-     * The name of the dashboard view
-     */
-    name: string;
-}
+export interface TableauReportParams {
+    /**
+     * The type of content of the dashboard. Can be either components, dashboards or datasources
+     */
+    contentType: string;
+    /**
+     * The organization Id
+     */
+    organizationId: string;
+}
+export interface TableauDashboardParams extends TableauReportParams {
+    /**
+     * The url of the report dashboard
+     */
+    dashboardContentUrl: string;
+}
+export interface TableauDashboardViewParams extends TableauDashboardParams {
+    /**
+     * The url of a specific view in the dashboard
+     */
+    viewContentUrl: string;
+}
+export interface TableauReportResponse {
+    /**
+     * The content url of the dashboard
+     */
+    contentUrl: string;
+    /**
+     * The description of the dashboard
+     */
+    description: string;
+    /**
+     * The name of the dashboard
+     */
+    name: string;
+    /**
+     * The last dashboard update
+     */
+    updatedAt: string;
+}
+export interface TableauDashboardResponse {
+    /**
+     * The authenticated url for embeding purpose
+     */
+    authenticatedUrl: string;
+    /**
+     * The content url of the dashboard
+     */
+    contentUrl: string;
+    /**
+     * The specific dashboard
+     */
+    dashboard: TableauReportResponse;
+    /**
+     * The name of the dashboard view
+     */
+    name: string;
+}

package/dist/definitions/resources/TableauService/ContentQuery/index.d.ts

@@ -1,2 +1,2 @@
-export * from './ContentQuery';
-export * from './ContentQueryInterfaces';
+export * from './ContentQuery';
+export * from './ContentQueryInterfaces';