@coveo/platform-client 0.0.0-clidev.1 → 0.0.0-development

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

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

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

@@ -0,0 +1,59 @@
+import { ActivityOperation, OperationType, SourceStatusType, SourceStatusTypeWithTransition } from '../../Enums.js';
+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/types/resources/Sources/SourcesSubInterfaces/Permission.d.ts

@@ -0,0 +1,42 @@
+import { DocumentPermissionState, PermissionIdentityType, SinglePermissionIdentityType, SinglePermissionResult, SinglePermissionState } from '../../Enums.js';
+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/types/resources/Sources/SourcesSubInterfaces/Url.d.ts

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

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

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

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

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

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

@@ -0,0 +1,8 @@
+import Resource from '../../Resource.js';
+import { TableauDashboardParams, TableauDashboardResponse, TableauDashboardViewParams, TableauReportParams, TableauReportResponse } from './ContentQueryInterfaces.js';
+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/types/resources/TableauService/ContentQuery/index.d.ts

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

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

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

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

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

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

@@ -0,0 +1,19 @@
+import ReadServiceResource from '../ReadServiceResource.js';
+import { AccountInfoModelV15, AccountResponseV15, StrictValidationTestParams, StrictValidationTestResponseV15 } from './AdministrationInterfaces.js';
+export default class Administration extends ReadServiceResource {
+    static baseUrl: string;
+    /**
+     * Get an account.
+     */
+    getAccount(): Promise<AccountResponseV15>;
+    /**
+     * Edit an account.
+     *
+     * @param model The account information.
+     */
+    updateAccount(model: AccountInfoModelV15): Promise<AccountResponseV15>;
+    /**
+     * Get example values that would be rejected by strict validation for the specified dimension.
+     */
+    getStrictValidationTest(params: StrictValidationTestParams): Promise<StrictValidationTestResponseV15>;
+}

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

@@ -0,0 +1,21 @@
+import { AccountStatus } from '../../../Enums.js';
+import { DeprecatedShortPaginatedParamParts, OrganizationParamParts, TimeRangeParamParts } from '../CommonParamParts.js';
+export interface AccountInfoModelV15 {
+    internalEventIps: string[];
+    useStrictFieldValidation: boolean;
+}
+export interface AccountResponseV15 extends AccountInfoModelV15 {
+    name: string;
+    enabled: boolean;
+    status: AccountStatus;
+}
+export interface StrictValidationTestResponseV15 {
+    dimensionName: string;
+    validationTestResults: Array<Record<string, unknown>>;
+}
+export interface StrictValidationTestParams extends OrganizationParamParts, TimeRangeParamParts, DeprecatedShortPaginatedParamParts {
+    /**
+     * The dimension to fetch.
+     */
+    d: string;
+}

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

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

package/dist/types/resources/UsageAnalytics/Read/CommonParamParts.d.ts

@@ -0,0 +1,119 @@
+import { MetricsInterval } from './ReadServiceCommon.js';
+/**
+ * Almost all calls of the Read service have an optional `org` query parameter.
+ * (Notable exceptions are service status monitoring calls).
+ */
+export interface OrganizationParamParts {
+    /**
+     * The name of the organization (Coveo Cloud V2 only)
+     */
+    org?: string;
+}
+/**
+ * Required `d` parameter, encoding dimensions.
+ */
+export interface EventDimensionsParamParts {
+    /**
+     * The dimensions to fetch.
+     */
+    d: string[];
+}
+/**
+ * Optional `f` parameter, encoding dimension filters.
+ */
+export interface EventDimensionsFilterParamParts {
+    /**
+     * The filter that will be applied to the event dimensions.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    f?: string[];
+}
+/**
+ * Optional `fn` parameter, encoding dimension based exclusion filters.
+ */
+export interface EventDimensionsExcludeFilterParamParts {
+    /**
+     * The filter that will be applied to dimensions to exclude events from the results.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    fn?: string[];
+}
+/**
+ * Optional `fn` parameter, encoding dimension based event exclusion filters.
+ */
+export interface EventDimensionsHideEventsFilterParamParts {
+    /**
+     * Each specified filter is inverted in order to hide events.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    hideEventFilters?: string[];
+}
+/**
+ * Required `m` parameter, encoding metrics.
+ */
+export interface EventMetricsParamParts {
+    /**
+     * The metrics to fetch.
+     */
+    m: string[];
+}
+/**
+ * Optional `i` parameter, encoding the interval to use when calculating metrics.
+ */
+export interface EventMetricsIntervalParamParts {
+    /**
+     * The interval on which data will be grouped. Default value is 'DAY'.
+     */
+    i?: MetricsInterval;
+}
+/**
+ * Optional `fm` parameter, encoding metric based filters.
+ */
+export interface EventMetricsFilterParamParts {
+    /**
+     * The filter that will be applied to the metrics.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    fm?: string[];
+}
+/**
+ * Required `from` and `to` parameters, encoding a time range.
+ */
+export interface TimeRangeParamParts {
+    /**
+     * The beginning date of the date range for the request, as an ISO-8601 encoded string.
+     * The date/time should include an offset, or `Z` for UTC.
+     * Format: `YYYY-MM-DDThh:mm:ss.sssZ`.
+     */
+    from: string;
+    /**
+     * The end date of the date range for the request, as an ISO-8601 encoded string.
+     * The date/time should include an offset, or `Z` for UTC.
+     * Format: `YYYY-MM-DDThh:mm:ss.sssZ`.
+     */
+    to: string;
+}
+/**
+ * Optional `tz` parameters, encoding a time zone.
+ */
+export interface TimeZoneParamParts {
+    /**
+     * Timezone/offset used for calculations.
+     * Defaults to `Z` (UTC).
+     */
+    tz?: string;
+}
+/**
+ * Paginated `p` and `n` query parameters used by some Read service calls.
+ * (Deprecated because it doesn't align with Coveo's standard `page` (0-based) and `perPage` query parameters).
+ */
+export interface DeprecatedShortPaginatedParamParts {
+    /**
+     * The response's page to access, starting at 1.
+     */
+    p?: number;
+    /**
+     * The number of result to include in a page.
+     */
+    n?: number;
+}

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

@@ -0,0 +1,21 @@
+import ReadServiceResource from '../ReadServiceResource.js';
+import { SnowflakeAccountDataSharingParams, SnowflakeAccountDataSharingAccountModel, SnowflakeAccountDataSharingRegionsModel } from './DataShareInterfaces.js';
+export default class DataShare extends ReadServiceResource {
+    static baseUrl: string;
+    /**
+     * Retrieve Snowflake accounts currently associated in Secure Data Sharing.
+     */
+    listSnowflakeAccount(): Promise<SnowflakeAccountDataSharingAccountModel[]>;
+    /**
+     * Add a Snowflake account to Secure Data Sharing.
+     */
+    addSnowflakeAccount(params: SnowflakeAccountDataSharingParams): Promise<void>;
+    /**
+     * Removes a Snowflake account from Secure Data Sharing.
+     */
+    deleteSnowflakeAccount(params: SnowflakeAccountDataSharingParams): Promise<void>;
+    /**
+     * Retrieve allowed Snowflake regions for Secure Data Sharing.
+     */
+    listAllowedSnowflakeRegions(): Promise<SnowflakeAccountDataSharingRegionsModel>;
+}

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

@@ -0,0 +1,43 @@
+import { DataShareStatus } from '../../../Enums.js';
+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/types/resources/UsageAnalytics/Read/DataShare/index.d.ts

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

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

@@ -0,0 +1,79 @@
+import { DimensionEventTypes } from '../../../Enums.js';
+import { ReadServiceHealthResponse, ReadServiceHealthApi, ReadServiceStatusResponse } from '../ReadServiceCommon.js';
+import ReadServiceResource from '../ReadServiceResource.js';
+import { CreateCustomDimensionParams, CustomDimensionModel, CustomDimensionSuggestionsModel, DimensionModel, DimensionValuesModel, GetDimensionValuesParams, ListDimensionsParams, ListUncreatedDimensionsParams } from './DimensionsInterfaces.js';
+export default class Dimensions extends ReadServiceResource implements ReadServiceHealthApi {
+    static baseUrl: string;
+    /**
+     * Get all the dimensions.
+     */
+    list(params?: ListDimensionsParams): Promise<DimensionModel[]>;
+    /**
+     * Get all the exportable dimensions.
+     */
+    listExportableDimensions(params?: ListDimensionsParams): Promise<DimensionModel[]>;
+    /**
+     * Get a dimension.
+     *
+     * @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
+     */
+    get(apiName: string): Promise<DimensionModel>;
+    /**
+     * Get the values for a dimension.
+     *
+     * @param dimension The dimension to fetch.
+     */
+    getValues(dimension: string, params?: GetDimensionValuesParams): Promise<DimensionValuesModel>;
+    /**
+     * Get all the custom dimensions.
+     *
+     * @param includeOnlyParents This will filter out dimensions which are covered by others.
+     * Only parent/master dimensions will be output.
+     */
+    listCustomDimensions(includeOnlyParents?: boolean): Promise<DimensionModel[]>;
+    /**
+     * Create a custom dimension.
+     */
+    createCustomDimension(model: CustomDimensionModel, params: CreateCustomDimensionParams): Promise<DimensionModel>;
+    /**
+     * Get a custom dimension.
+     *
+     * @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
+     */
+    getCustomDimension(apiName: string): Promise<DimensionModel>;
+    /**
+     * Get the values for a custom dimension.
+     *
+     * @param dimension The dimension to fetch.
+     */
+    getCustomDimensionValues(dimension: string, params?: GetDimensionValuesParams): Promise<DimensionValuesModel>;
+    /**
+     * Create or edit a custom dimension.
+     *
+     * @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
+     * @param updatePastEvents Whether to update the custom dimension in past events (deprecated).
+     */
+    updateCustomDimension(apiName: string, model: CustomDimensionModel, updatePastEvents?: boolean): Promise<DimensionModel>;
+    /**
+     * Delete a custom dimension.
+     *
+     * @param apiName Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
+     */
+    deleteCustomDimension(apiName: string): Promise<void>;
+    /**
+     * Get the custom dimensions service status.
+     */
+    getCustomDimensionStatus(): Promise<Record<string, string>>;
+    /**
+     * Health check for the custom dimensions service.
+     */
+    checkCustomDimensionHealth(): Promise<Record<string, string>>;
+    /**
+     * Get a list of dimensions that have data but are not created yet.
+     *
+     * @param event The type of event for which to look for suggestions.
+     */
+    listUncreatedDimensions(event: DimensionEventTypes, params?: ListUncreatedDimensionsParams): Promise<CustomDimensionSuggestionsModel>;
+    checkHealth(): Promise<ReadServiceHealthResponse>;
+    checkStatus(): Promise<ReadServiceStatusResponse>;
+}

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

@@ -0,0 +1,117 @@
+import { DimensionStatus, DimensionType } from '../../../Enums.js';
+import { DeprecatedShortPaginatedParamParts, EventDimensionsFilterParamParts, OrganizationParamParts, TimeRangeParamParts, TimeZoneParamParts } from '../CommonParamParts.js';
+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 CustomDimensionSuggestionsModel {
+    /**
+     * Suggestions of custom dimensions that could be created
+     */
+    suggestions: CustomDimensionSuggestionModel[];
+}
+export interface CustomDimensionSuggestionModel {
+    /**
+     * The event type of the custom dimension
+     */
+    eventName?: string;
+    /**
+     * The api name of the custom dimension
+     */
+    apiName?: string;
+    /**
+     * The existing values for the custom dimension
+     */
+    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 extends OrganizationParamParts {
+    /**
+     * This will filter out dimensions which are covered by others.
+     * Only parent/master dimensions will be output.
+     */
+    includeOnlyParents?: boolean;
+    /**
+     * Whether to include custom dimensions within the results.
+     */
+    includeCustom?: boolean;
+}
+export interface GetDimensionValuesParams extends OrganizationParamParts, EventDimensionsFilterParamParts, TimeRangeParamParts, TimeZoneParamParts, DeprecatedShortPaginatedParamParts {
+}
+export interface CreateCustomDimensionParams extends OrganizationParamParts {
+    /**
+     * 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 types of event where this dimension will be added.
+     */
+    event?: string[];
+    /**
+     * Whether to update the custom dimension in past events.
+     *
+     * @deprecated
+     */
+    updatePastEvents?: boolean;
+}
+export interface ListUncreatedDimensionsParams extends OrganizationParamParts, TimeRangeParamParts {
+    /**
+     * Whether value samples should be included in the response.
+     */
+    includeValueSamples?: boolean;
+    /**
+     * The number of events to look at when getting suggestions. A larger depth means more suggestions but also slower performance.
+     */
+    depth?: number;
+}

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

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