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

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

@@ -1,101 +1,101 @@
-import { CSVFileFormat, DayOfWeek, ExportScheduleFrequency, ExportStatus, ExportTablesType } from '../../../Enums';
-export interface ExportModel {
-    id: string;
-    author: string;
-    downloadLink?: string;
-    startDate: number;
-    from: number;
-    to: number;
-    filters: Record<string, string>;
-    description: string;
-    size: number;
-    status: ExportStatus;
-    tables?: string[];
-    downloadable: boolean;
-    dimensions?: string[];
-    replayable?: boolean;
-    usingDisplayNames?: boolean;
-    scheduleId?: string;
-}
-export interface ExportEstimateModel {
-    estimates: Record<string, number>;
-}
-export interface ExportDownloadLink {
-    /**
-     * The export's unique identifier
-     */
-    id: string;
-    /**
-     * The export download link. Only appears when export is ready
-     */
-    downloadLink?: string;
-}
-interface EstimateExportCommonParams {
-    from: string;
-    to: string;
-    /**
-     * The filter that will be applied to the events common dimensions (shared by all types of events).
-     * Multiple filter parameters are joined with the AND operator.
-     */
-    f?: string[];
-}
-export interface EstimateExportParams extends EstimateExportCommonParams {
-    tables?: ExportTablesType[];
-    /**
-     * The filter that will be applied to the click and search events dimensions.
-     * Multiple filter parameters are joined with the AND operator.
-     */
-    fs?: string[];
-    /**
-     * The filter that will be applied to the custom events dimensions.
-     * Multiple filter parameters are joined with the AND operator.
-     */
-    fc?: string[];
-}
-export interface EstimateVisitExportParams extends EstimateExportCommonParams {
-    hideEventFilters?: string[];
-    /**
-     * 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[];
-}
-interface GenerateExportCommonParams {
-    filename?: string;
-    /**
-     * Export's description.
-     */
-    d?: string;
-    dimensions?: string[];
-    format?: CSVFileFormat;
-    useDisplayNames?: boolean;
-}
-export declare type GenerateExportParams = EstimateExportParams & GenerateExportCommonParams;
-export declare type GenerateVisitExportParams = EstimateVisitExportParams & GenerateExportCommonParams & {
-    ordered?: boolean;
-};
-interface ScheduleCommonProperties {
-    frequency: ExportScheduleFrequency;
-    dayOfWeek?: DayOfWeek;
-    timezone: string;
-    dimensions?: string[];
-    usingDisplayNames?: boolean;
-    notificationsEmails?: string[];
-}
-export interface ExportScheduleModel extends ScheduleCommonProperties {
-    id: string;
-    author: string;
-    filters: Record<string, string>;
-    tables?: string[];
-    description: string;
-    errorInfo?: Record<string, string>;
-}
-export interface CreateExportScheduleModel extends ScheduleCommonProperties {
-    commonFilters?: string[];
-    searchesFilters?: string[];
-    customEventsFilters?: string[];
-    description?: string;
-    tables?: ExportTablesType[];
-    exportFormat?: CSVFileFormat;
-}
-export {};
+import { CSVFileFormat, DayOfWeek, ExportScheduleFrequency, ExportStatus, ExportTablesType } from '../../../Enums';
+export interface ExportModel {
+    id: string;
+    author: string;
+    downloadLink?: string;
+    startDate: number;
+    from: number;
+    to: number;
+    filters: Record<string, string>;
+    description: string;
+    size: number;
+    status: ExportStatus;
+    tables?: string[];
+    downloadable: boolean;
+    dimensions?: string[];
+    replayable?: boolean;
+    usingDisplayNames?: boolean;
+    scheduleId?: string;
+}
+export interface ExportEstimateModel {
+    estimates: Record<string, number>;
+}
+export interface ExportDownloadLink {
+    /**
+     * The export's unique identifier
+     */
+    id: string;
+    /**
+     * The export download link. Only appears when export is ready
+     */
+    downloadLink?: string;
+}
+interface EstimateExportCommonParams {
+    from: string;
+    to: string;
+    /**
+     * The filter that will be applied to the events common dimensions (shared by all types of events).
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    f?: string[];
+}
+export interface EstimateExportParams extends EstimateExportCommonParams {
+    tables?: ExportTablesType[];
+    /**
+     * The filter that will be applied to the click and search events dimensions.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    fs?: string[];
+    /**
+     * The filter that will be applied to the custom events dimensions.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    fc?: string[];
+}
+export interface EstimateVisitExportParams extends EstimateExportCommonParams {
+    hideEventFilters?: string[];
+    /**
+     * 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[];
+}
+interface GenerateExportCommonParams {
+    filename?: string;
+    /**
+     * Export's description.
+     */
+    d?: string;
+    dimensions?: string[];
+    format?: CSVFileFormat;
+    useDisplayNames?: boolean;
+}
+export declare type GenerateExportParams = EstimateExportParams & GenerateExportCommonParams;
+export declare type GenerateVisitExportParams = EstimateVisitExportParams & GenerateExportCommonParams & {
+    ordered?: boolean;
+};
+interface ScheduleCommonProperties {
+    frequency: ExportScheduleFrequency;
+    dayOfWeek?: DayOfWeek;
+    timezone: string;
+    dimensions?: string[];
+    usingDisplayNames?: boolean;
+    notificationsEmails?: string[];
+}
+export interface ExportScheduleModel extends ScheduleCommonProperties {
+    id: string;
+    author: string;
+    filters: Record<string, string>;
+    tables?: string[];
+    description: string;
+    errorInfo?: Record<string, string>;
+}
+export interface CreateExportScheduleModel extends ScheduleCommonProperties {
+    commonFilters?: string[];
+    searchesFilters?: string[];
+    customEventsFilters?: string[];
+    description?: string;
+    tables?: ExportTablesType[];
+    exportFormat?: CSVFileFormat;
+}
+export {};

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

@@ -1,2 +1,2 @@
-export * from './Exports';
-export * from './ExportsInterfaces';
+export * from './Exports';
+export * from './ExportsInterfaces';

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

@@ -1,71 +1,71 @@
-import Resource from '../../../Resource';
-import { CreatePermissionsFilterModel, CreatePermissionsFilterResponse, CreateReportingFilterModel, CreateReportingFilterResponse, FilterResponse, FilterServiceHealthResponse, FilterServiceStatusResponse, FilterTargetsModel, FilterTargetsResponse, ListFiltersResponse, PermissionsFilterUser, UpdatePermissionsFilterModel, UpdateReportingFilterModel } from './FiltersInterfaces';
-export default class Filters extends Resource {
-    static baseUrl: string;
-    static reportingBaseUrl: string;
-    static permissionsBaseUrl: string;
-    /**
-     * Get all reporting filters
-     */
-    listReportFilters(): Promise<ListFiltersResponse>;
-    /**
-     * Get a reporting filter
-     */
-    getReportFilter(id: string): Promise<FilterResponse>;
-    /**
-     * Create a reporting filter
-     */
-    createReportFilter(filter: CreateReportingFilterModel): Promise<CreateReportingFilterResponse>;
-    /**
-     * Update a reporting filter
-     */
-    updateReportFilter(id: string, filter: UpdateReportingFilterModel): Promise<CreateReportingFilterResponse>;
-    /**
-     * Delete a reporting filter
-     */
-    deleteReportFilter(id: string): Promise<Record<string, unknown>>;
-    /**
-     * Get all permission filters
-     */
-    listPermissionFilters(): Promise<ListFiltersResponse>;
-    /**
-     * Get a permission filter
-     */
-    getPermissionFilter(id: string): Promise<FilterResponse>;
-    /**
-     * Create a permission filter
-     */
-    createPermissionFilter(filter: CreatePermissionsFilterModel): Promise<CreatePermissionsFilterResponse>;
-    /**
-     * Update a permission filter
-     */
-    updatePermissionFilter(id: string, filter: UpdatePermissionsFilterModel): Promise<CreatePermissionsFilterResponse>;
-    /**
-     * Delete a permission filter
-     */
-    deletePermissionFilter(id: string): Promise<Record<string, unknown>>;
-    /**
-     * Get the users of a permission filters
-     */
-    getPermissionFilterUsers(id: string): Promise<PermissionsFilterUser[]>;
-    /**
-     * Set the users of a permission filter
-     */
-    updatePermissionFilterUsers(id: string, users: string[]): Promise<Record<string, unknown>>;
-    /**
-     * Get the targets of a permission filters
-     */
-    getPermissionFilterTargets(id: string): Promise<FilterTargetsResponse[]>;
-    /**
-     * Set the targets of a permission filter
-     */
-    updatePermissionFilterTargets(id: string, targets: FilterTargetsModel): Promise<Record<string, unknown>>;
-    /**
-     * Health check for the filter service
-     */
-    healthcheck(): Promise<FilterServiceHealthResponse>;
-    /**
-     * Get the filter service status
-     */
-    status(): Promise<FilterServiceStatusResponse>;
-}
+import Resource from '../../../Resource';
+import { CreatePermissionsFilterModel, CreatePermissionsFilterResponse, CreateReportingFilterModel, CreateReportingFilterResponse, FilterResponse, FilterServiceHealthResponse, FilterServiceStatusResponse, FilterTargetsModel, FilterTargetsResponse, ListFiltersResponse, PermissionsFilterUser, UpdatePermissionsFilterModel, UpdateReportingFilterModel } from './FiltersInterfaces';
+export default class Filters extends Resource {
+    static baseUrl: string;
+    static reportingBaseUrl: string;
+    static permissionsBaseUrl: string;
+    /**
+     * Get all reporting filters
+     */
+    listReportFilters(): Promise<ListFiltersResponse>;
+    /**
+     * Get a reporting filter
+     */
+    getReportFilter(id: string): Promise<FilterResponse>;
+    /**
+     * Create a reporting filter
+     */
+    createReportFilter(filter: CreateReportingFilterModel): Promise<CreateReportingFilterResponse>;
+    /**
+     * Update a reporting filter
+     */
+    updateReportFilter(id: string, filter: UpdateReportingFilterModel): Promise<CreateReportingFilterResponse>;
+    /**
+     * Delete a reporting filter
+     */
+    deleteReportFilter(id: string): Promise<Record<string, unknown>>;
+    /**
+     * Get all permission filters
+     */
+    listPermissionFilters(): Promise<ListFiltersResponse>;
+    /**
+     * Get a permission filter
+     */
+    getPermissionFilter(id: string): Promise<FilterResponse>;
+    /**
+     * Create a permission filter
+     */
+    createPermissionFilter(filter: CreatePermissionsFilterModel): Promise<CreatePermissionsFilterResponse>;
+    /**
+     * Update a permission filter
+     */
+    updatePermissionFilter(id: string, filter: UpdatePermissionsFilterModel): Promise<CreatePermissionsFilterResponse>;
+    /**
+     * Delete a permission filter
+     */
+    deletePermissionFilter(id: string): Promise<Record<string, unknown>>;
+    /**
+     * Get the users of a permission filters
+     */
+    getPermissionFilterUsers(id: string): Promise<PermissionsFilterUser[]>;
+    /**
+     * Set the users of a permission filter
+     */
+    updatePermissionFilterUsers(id: string, users: string[]): Promise<Record<string, unknown>>;
+    /**
+     * Get the targets of a permission filters
+     */
+    getPermissionFilterTargets(id: string): Promise<FilterTargetsResponse[]>;
+    /**
+     * Set the targets of a permission filter
+     */
+    updatePermissionFilterTargets(id: string, targets: FilterTargetsModel): Promise<Record<string, unknown>>;
+    /**
+     * Health check for the filter service
+     */
+    healthcheck(): Promise<FilterServiceHealthResponse>;
+    /**
+     * Get the filter service status
+     */
+    status(): Promise<FilterServiceStatusResponse>;
+}

package/dist/definitions/resources/UsageAnalytics/Read/Filters/FiltersInterfaces.d.ts

@@ -1,67 +1,67 @@
-import { GroupResponse, UserResponse } from '../Reports';
-export interface FilterModel {
-    /** The display name of the filter. */
-    displayName: string;
-    /** The actual value of the filter. */
-    value: string;
-}
-export interface FilterResponse {
-    /** The filter id. */
-    id: string;
-    /** The filter display name. */
-    displayName: string;
-    /** The filter account. */
-    account: string;
-    /** The filter type. Can be 'permissions' or 'reporting'. */
-    type: string;
-    /** The actual filter. */
-    value: string;
-}
-export declare type CreateReportingFilterModel = FilterModel;
-export declare type CreateReportingFilterResponse = Pick<FilterResponse, 'id'>;
-export declare type UpdateReportingFilterModel = CreateReportingFilterModel;
-export declare type UpdateReportingFilterResponse = CreateReportingFilterResponse;
-export declare type CreatePermissionsFilterModel = FilterModel;
-export declare type CreatePermissionsFilterResponse = Pick<FilterResponse, 'id'>;
-export declare type UpdatePermissionsFilterModel = CreatePermissionsFilterModel;
-export declare type UpdatePermissionsFilterResponse = CreatePermissionsFilterResponse;
-export interface ListFiltersResponse {
-    /** A list of filters */
-    filters: FilterResponse[];
-}
-export interface PermissionsFilterUser {
-    /** The user id. */
-    userId: string;
-    /** The account. */
-    account: string;
-    /** Permissions for the user */
-    permissions: PermissionsFilterUserPermissions[];
-    /** Related reports */
-    reportIds: unknown[];
-}
-export interface PermissionsFilterUserPermissions {
-    /** The permission filter. */
-    permission: string;
-    /** Whether the permission field is the unique ID. */
-    filterId: boolean;
-}
-export interface FilterTargetsModel {
-    /** The ids of the users targeted by the filter. */
-    targetedUsers: string[];
-    /** The ids of the groups targeted by the filter. */
-    targetedGroups: string[];
-}
-export interface FilterTargetsResponse {
-    /** The users targeted by the filter. */
-    targetedUsers: UserResponse[];
-    /** The groups targeted by the filter. */
-    targetedGroups: GroupResponse[];
-}
-export interface FilterServiceHealthResponse {
-    /** The health of the service */
-    status: 'UP' | 'DOWN';
-}
-export interface FilterServiceStatusResponse {
-    /** The status of the service */
-    status: 'online' | 'offline';
-}
+import { GroupResponse, UserResponse } from '../Reports';
+export interface FilterModel {
+    /** The display name of the filter. */
+    displayName: string;
+    /** The actual value of the filter. */
+    value: string;
+}
+export interface FilterResponse {
+    /** The filter id. */
+    id: string;
+    /** The filter display name. */
+    displayName: string;
+    /** The filter account. */
+    account: string;
+    /** The filter type. Can be 'permissions' or 'reporting'. */
+    type: string;
+    /** The actual filter. */
+    value: string;
+}
+export declare type CreateReportingFilterModel = FilterModel;
+export declare type CreateReportingFilterResponse = Pick<FilterResponse, 'id'>;
+export declare type UpdateReportingFilterModel = CreateReportingFilterModel;
+export declare type UpdateReportingFilterResponse = CreateReportingFilterResponse;
+export declare type CreatePermissionsFilterModel = FilterModel;
+export declare type CreatePermissionsFilterResponse = Pick<FilterResponse, 'id'>;
+export declare type UpdatePermissionsFilterModel = CreatePermissionsFilterModel;
+export declare type UpdatePermissionsFilterResponse = CreatePermissionsFilterResponse;
+export interface ListFiltersResponse {
+    /** A list of filters */
+    filters: FilterResponse[];
+}
+export interface PermissionsFilterUser {
+    /** The user id. */
+    userId: string;
+    /** The account. */
+    account: string;
+    /** Permissions for the user */
+    permissions: PermissionsFilterUserPermissions[];
+    /** Related reports */
+    reportIds: unknown[];
+}
+export interface PermissionsFilterUserPermissions {
+    /** The permission filter. */
+    permission: string;
+    /** Whether the permission field is the unique ID. */
+    filterId: boolean;
+}
+export interface FilterTargetsModel {
+    /** The ids of the users targeted by the filter. */
+    targetedUsers: string[];
+    /** The ids of the groups targeted by the filter. */
+    targetedGroups: string[];
+}
+export interface FilterTargetsResponse {
+    /** The users targeted by the filter. */
+    targetedUsers: UserResponse[];
+    /** The groups targeted by the filter. */
+    targetedGroups: GroupResponse[];
+}
+export interface FilterServiceHealthResponse {
+    /** The health of the service */
+    status: 'UP' | 'DOWN';
+}
+export interface FilterServiceStatusResponse {
+    /** The status of the service */
+    status: 'online' | 'offline';
+}

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

@@ -1,2 +1,2 @@
-export * from './Filters';
-export * from './FiltersInterfaces';
+export * from './Filters';
+export * from './FiltersInterfaces';

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

@@ -1,58 +1,58 @@
-import { ReportType } from '../../../Enums';
-import Resource from '../../../Resource';
-import { CreateReportModel, CreateReportResponse, GetReportOptions, GetReportTemplateOptions, ListReportsOptions, ListReportsResponse, ReportAccessRequest, ReportAccessResponse, ReportModel, TemplateResponse, ReportUsersResponse, StatusResponse, TemplateMetadataResponse, UpdateReportModel } from './ReportsInterfaces';
-export default class Reports extends Resource {
-    static baseUrl: string;
-    /**
-     * Get the persisted reports of one or all types
-     */
-    list(options?: ListReportsOptions): Promise<ListReportsResponse>;
-    /**
-     * Get a report
-     */
-    get(id: string, options?: GetReportOptions): Promise<ReportModel>;
-    /**
-     * Create a report
-     */
-    create(report: CreateReportModel): Promise<CreateReportResponse>;
-    /**
-     * Update a report
-     */
-    update(id: string, report: UpdateReportModel): Promise<CreateReportModel>;
-    /**
-     * Delete a report
-     */
-    delete(id: string): Promise<Record<string, unknown>>;
-    /**
-     * Get the users and groups who can view a report
-     */
-    getAccess(reportId: string): Promise<ReportAccessResponse>;
-    /**
-     * Set the users and groups who are allowed to view a report
-     */
-    setAccess(reportId: string, reportAccess: ReportAccessRequest): Promise<Record<string, unknown>>;
-    /**
-     * Get the users who can view a report
-     */
-    getUsers(reportId: string): Promise<ReportUsersResponse>;
-    /**
-     * Set the users who are allowed to view a report
-     */
-    setUsers(reportId: string, userIds: string[]): Promise<Record<string, unknown>>;
-    /**
-     * Health check for the reports service
-     */
-    healthcheck(): Promise<StatusResponse>;
-    /**
-     * Get a report template
-     */
-    getReportTemplate(templateId: string, options?: GetReportTemplateOptions): Promise<TemplateResponse[]>;
-    /**
-     * Get metadata about available report templates
-     */
-    listReportTemplates(type: ReportType, options?: GetReportTemplateOptions): Promise<TemplateMetadataResponse[]>;
-    /**
-     * Get the reports service status
-     */
-    getServiceStatus(): Promise<StatusResponse>;
-}
+import { ReportType } from '../../../Enums';
+import Resource from '../../../Resource';
+import { CreateReportModel, CreateReportResponse, GetReportOptions, GetReportTemplateOptions, ListReportsOptions, ListReportsResponse, ReportAccessRequest, ReportAccessResponse, ReportModel, TemplateResponse, ReportUsersResponse, StatusResponse, TemplateMetadataResponse, UpdateReportModel } from './ReportsInterfaces';
+export default class Reports extends Resource {
+    static baseUrl: string;
+    /**
+     * Get the persisted reports of one or all types
+     */
+    list(options?: ListReportsOptions): Promise<ListReportsResponse>;
+    /**
+     * Get a report
+     */
+    get(id: string, options?: GetReportOptions): Promise<ReportModel>;
+    /**
+     * Create a report
+     */
+    create(report: CreateReportModel): Promise<CreateReportResponse>;
+    /**
+     * Update a report
+     */
+    update(id: string, report: UpdateReportModel): Promise<CreateReportModel>;
+    /**
+     * Delete a report
+     */
+    delete(id: string): Promise<Record<string, unknown>>;
+    /**
+     * Get the users and groups who can view a report
+     */
+    getAccess(reportId: string): Promise<ReportAccessResponse>;
+    /**
+     * Set the users and groups who are allowed to view a report
+     */
+    setAccess(reportId: string, reportAccess: ReportAccessRequest): Promise<Record<string, unknown>>;
+    /**
+     * Get the users who can view a report
+     */
+    getUsers(reportId: string): Promise<ReportUsersResponse>;
+    /**
+     * Set the users who are allowed to view a report
+     */
+    setUsers(reportId: string, userIds: string[]): Promise<Record<string, unknown>>;
+    /**
+     * Health check for the reports service
+     */
+    healthcheck(): Promise<StatusResponse>;
+    /**
+     * Get a report template
+     */
+    getReportTemplate(templateId: string, options?: GetReportTemplateOptions): Promise<TemplateResponse[]>;
+    /**
+     * Get metadata about available report templates
+     */
+    listReportTemplates(type: ReportType, options?: GetReportTemplateOptions): Promise<TemplateMetadataResponse[]>;
+    /**
+     * Get the reports service status
+     */
+    getServiceStatus(): Promise<StatusResponse>;
+}