@coveo/platform-client 35.0.0

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

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

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

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

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

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

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

@@ -0,0 +1,9 @@
+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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +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';

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

@@ -0,0 +1,6 @@
+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

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

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

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

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

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

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

@@ -0,0 +1,9 @@
+import API from '../../APICore';
+import Resource from '../Resource';
+import ContentQuery from './ContentQuery/ContentQuery';
+export default class TableauService extends Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    contentQuery: ContentQuery;
+    constructor(api: API, serverlessApi: API);
+}

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

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

package/dist/definitions/resources/UsageAnalytics/Read/Administration/Administration.d.ts

@@ -0,0 +1,10 @@
+import { RedshiftEndpointStatus } from '../../../Enums';
+import Resource from '../../../Resource';
+import { AccountInfoModelV15, AccountResponseV15, StrictValidationTestParams, StrictValidationTestResponseV15 } from './AdministrationInterfaces';
+export default class Administration extends Resource {
+    static baseUrl: string;
+    getAccount(): Promise<AccountResponseV15>;
+    updateAccount(model: AccountInfoModelV15): Promise<AccountResponseV15>;
+    setRedshiftStatus(endpoint: string, status: RedshiftEndpointStatus): Promise<Record<string, unknown>>;
+    getStrictValidationTest(params: StrictValidationTestParams): Promise<StrictValidationTestResponseV15>;
+}

package/dist/definitions/resources/UsageAnalytics/Read/Administration/AdministrationInterfaces.d.ts

@@ -0,0 +1,21 @@
+export interface AccountInfoModelV15 {
+    internalEventIps: string[];
+    useStrictFieldValidation: boolean;
+}
+export interface AccountResponseV15 extends AccountInfoModelV15 {
+    name: string;
+    enabled: boolean;
+    status: any;
+}
+export interface StrictValidationTestResponseV15 {
+    dimensionName: string;
+    validationTestResults: Array<Record<string, unknown>>;
+}
+export interface StrictValidationTestParams {
+    from: string;
+    to: string;
+    d: string;
+    p?: number;
+    n?: number;
+    org?: string;
+}

package/dist/definitions/resources/UsageAnalytics/Read/Administration/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Administration';
+export * from './AdministrationInterfaces';

package/dist/definitions/resources/UsageAnalytics/Read/DataShare/DataShare.d.ts

@@ -0,0 +1,9 @@
+import Resource from '../../../Resource';
+import { SnowflakeAccountDataSharingParams, SnowflakeAccountDataSharingAccountModel, SnowflakeAccountDataSharingRegionsModel } from './DataShareInterfaces';
+export default class DataShare extends Resource {
+    static baseUrl: string;
+    listSnowflakeAccount(): Promise<SnowflakeAccountDataSharingAccountModel[]>;
+    addSnowflakeAccount(snowflakeAccount: SnowflakeAccountDataSharingParams): Promise<void>;
+    deleteSnowflakeAccount(params: SnowflakeAccountDataSharingParams): Promise<void>;
+    listAllowedSnowflakeRegions(): Promise<SnowflakeAccountDataSharingRegionsModel>;
+}

package/dist/definitions/resources/UsageAnalytics/Read/DataShare/DataShareInterfaces.d.ts

@@ -0,0 +1,43 @@
+import { DataShareStatus } from '../../../Enums';
+export interface SnowflakeAccountDataSharingAccountModel {
+    /**
+     * The Snowflake account locator.
+     */
+    locator: string;
+    /**
+     * The region the Snowflake account resides in.
+     */
+    region: string;
+    /**
+     * The date and time at which the share was initiated.
+     */
+    createdAt?: string;
+    /**
+     * The share status of the account.
+     */
+    status: DataShareStatus;
+    /**
+     * The error message in case of an 'UNKNOWN' or 'INVALID' status.
+     */
+    errorMessage?: string;
+}
+export interface SnowflakeAccountDataSharingParams {
+    /**
+     * The snowflake account locator.
+     */
+    accountLocator: string;
+    /**
+     * The region of the snowflake account.
+     */
+    snowflakeRegion: string;
+}
+export interface SnowflakeAccountDataSharingRegionsModel {
+    /**
+     * The primary Snowflake region.
+     */
+    primaryRegion: string;
+    /**
+     * Other supported Snowflake regions.
+     */
+    secondaryRegions: string[];
+}

package/dist/definitions/resources/UsageAnalytics/Read/DataShare/index.d.ts

@@ -0,0 +1,2 @@
+export * from './DataShare';
+export * from './DataShareInterfaces';

package/dist/definitions/resources/UsageAnalytics/Read/Dimensions/Dimensions.d.ts

@@ -0,0 +1,21 @@
+import { DimensionEventTypes } from '../../../Enums';
+import Resource from '../../../Resource';
+import { CreateCustomDimensionParams, CustomDimensionModel, CustomDimensionSuggestionModel, DimensionModel, DimensionValuesModel, GetDimensionValuesParams, ListDimensionsParams, ListUncreatedDimensionsParams } from './DimensionsInterfaces';
+export default class Dimensions extends Resource {
+    static baseUrl: string;
+    list(params?: ListDimensionsParams): Promise<DimensionModel[]>;
+    listExportableDimensions(params?: ListDimensionsParams): Promise<DimensionModel[]>;
+    get(apiName: string): Promise<DimensionModel>;
+    getValues(dimension: string, params?: GetDimensionValuesParams): Promise<DimensionValuesModel>;
+    getStatus(): Promise<Record<string, string>>;
+    checkHealth(): Promise<Record<string, string>>;
+    listCustomDimensions(includeOnlyParents?: boolean): Promise<DimensionModel[]>;
+    createCustomDimension(model: CustomDimensionModel, params: CreateCustomDimensionParams): Promise<DimensionModel>;
+    getCustomDimension(apiName: string): Promise<DimensionModel>;
+    getCustomDimensionValues(dimension: string, params?: GetDimensionValuesParams): Promise<DimensionValuesModel>;
+    updateCustomDimension(apiName: string, model: CustomDimensionModel, updatePastEvents?: boolean): Promise<DimensionModel>;
+    deleteCustomDimension(apiName: string): Promise<void>;
+    getCustomDimensionStatus(): Promise<Record<string, string>>;
+    checkCustomDimensionHealth(): Promise<Record<string, string>>;
+    listUncreatedDimensions(event: DimensionEventTypes, params?: ListUncreatedDimensionsParams): Promise<CustomDimensionSuggestionModel[]>;
+}

package/dist/definitions/resources/UsageAnalytics/Read/Dimensions/DimensionsInterfaces.d.ts

@@ -0,0 +1,101 @@
+import { DimensionStatus, DimensionType } from '../../../Enums';
+export interface DimensionModel {
+    /**
+     * A collection of possible names to use when querying the statistics service with this dimension
+     */
+    apiNames: string[];
+    /**
+     * Whether the dimension is available in a visit's statistics.
+     */
+    availableInVisit?: boolean;
+    /**
+     * A flag indicating if the dimension is a custom dimension
+     */
+    custom: boolean;
+    /**
+     * The display name of the dimension
+     */
+    displayName: string;
+    /**
+     * Indicates the type of events that this dimension can be attached to.
+     */
+    eventTypes: string[];
+    /**
+     * The name of the dimension when returned by the statistics service
+     */
+    returnName: string;
+    /**
+     * The status of the dimension
+     */
+    status: DimensionStatus;
+    /**
+     * The type of the dimension
+     */
+    type: DimensionType;
+    /**
+     * The path in the custom_datas map corresponding to this dimension. For custom dimensions only.
+     */
+    path?: string[];
+}
+export interface DimensionValuesModel {
+    values: Array<Record<string, string | number>>;
+}
+export interface CustomDimensionSuggestionModel {
+    eventName?: string;
+    apiName?: string;
+    values?: string[];
+}
+export interface CustomDimensionModel {
+    /**
+     * The type of the dimension.
+     */
+    type: DimensionType;
+    /**
+     * The display name of the dimension. Should be human readable.
+     */
+    displayName: string;
+    /**
+     * The path in the custom_datas map corresponding to this dimension. For custom dimensions only.
+     */
+    path?: string[];
+}
+export interface ListDimensionsParams {
+    org?: string;
+    includeOnlyParents?: boolean;
+    includeCustom?: boolean;
+}
+export interface GetDimensionValuesParams {
+    from: string;
+    to: string;
+    tz?: string;
+    org?: string;
+    f?: string[];
+    p?: number;
+    n?: number;
+}
+export interface CreateCustomDimensionParams {
+    /**
+     * The name of the custom dimension. It should start with the 'c_' prefix.
+     * If not present, the prefix will be added automatically.
+     */
+    name: string;
+    /**
+     * The name of the organization (Coveo Cloud V2 only)
+     */
+    org?: string;
+    /**
+     * The types of event where this dimension will be added.
+     */
+    event?: string[];
+    /**
+     * Whether to update the custom dimension in past events.
+     */
+    updatePastEvents?: boolean;
+}
+export interface ListUncreatedDimensionsParams {
+    org?: string;
+    from?: string;
+    to?: string;
+    includeValueSamples?: boolean;
+    depth?: number;
+}

package/dist/definitions/resources/UsageAnalytics/Read/Dimensions/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Dimensions';
+export * from './DimensionsInterfaces';

package/dist/definitions/resources/UsageAnalytics/Read/Exports/Exports.d.ts

@@ -0,0 +1,20 @@
+import Resource from '../../../Resource';
+import { CreateExportScheduleModel, EstimateExportParams, EstimateVisitExportParams, ExportDownloadLink, ExportEstimateModel, ExportModel, ExportScheduleModel, GenerateExportParams, GenerateVisitExportParams } from './ExportsInterfaces';
+export default class Exports extends Resource {
+    static baseUrl: string;
+    list(): Promise<ExportModel[]>;
+    generate(params: GenerateExportParams): Promise<ExportModel>;
+    get(exportId: string, redirect?: boolean): Promise<ExportModel>;
+    getExportDownloadLink(exportId: string): Promise<ExportDownloadLink>;
+    delete(exportId: string): Promise<void>;
+    estimateRowsCount(params: EstimateExportParams): Promise<ExportEstimateModel>;
+    getStatus(): Promise<Record<string, string>>;
+    checkHealth(): Promise<Record<string, string>>;
+    generateVisitExport(params: GenerateVisitExportParams): Promise<ExportModel>;
+    estimateVisitExportRowsCount(params: EstimateVisitExportParams): Promise<ExportEstimateModel>;
+    listSchedules(): Promise<ExportScheduleModel[]>;
+    createSchedule(model: CreateExportScheduleModel): Promise<ExportScheduleModel>;
+    getSchedule(exportScheduleId: string): Promise<ExportScheduleModel>;
+    updateSchedule(exportScheduleId: string, model: CreateExportScheduleModel): Promise<ExportScheduleModel>;
+    deleteSchedule(exportScheduleId: string): Promise<void>;
+}