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

package/dist/definitions/resources/UsageAnalytics/Read/Statistics/StatisticsInterfaces.d.ts

@@ -1,186 +1,186 @@
-export interface ServiceStatus {
-    status: string;
-}
-export interface MetricValue {
-    value: number;
-}
-export interface MetricStats {
-    average: number;
-    total: number;
-    peak: number;
-}
-export interface IncoherentEventsOptions {
-    from: string;
-    to: string;
-    errorCodes?: string[];
-    p?: number;
-    n?: number;
-    asc?: boolean;
-    includeMetadata?: boolean;
-    seen?: boolean;
-    org: string;
-}
-export interface IncoherentEventModel {
-    errorCode: string;
-    datetime: string;
-    event: any;
-}
-export interface IncoherentEventsModel {
-    events: IncoherentEventModel[];
-    uniqueCounts: any;
-    totalNumberOfResults: number;
-}
-export interface MetricsModel {
-    globalDatas: Record<string, MetricValue | MetricStats>;
-    lastUpdated: number;
-    cached: boolean;
-}
-export interface GlobalDataOptions {
-    m: string[];
-    from: string;
-    to: string;
-    tz?: string;
-    d?: string[];
-    f?: string[];
-    i?: string;
-    bindOnLastSearch?: boolean;
-    org: string;
-}
-export interface TrendsModel {
-    combinations: Array<Record<string, any>>;
-    uniqueCounts: Record<string, number>;
-    totalNumberOfResults: number;
-    lastUpdated: number;
-    cached: boolean;
-}
-export interface TrendsOptions {
-    m: string[];
-    from: string;
-    to: string;
-    previousFrom?: string;
-    previousTo?: string;
-    tz?: string;
-    d: string[];
-    f?: string[];
-    fm?: string[];
-    s?: string;
-    p?: number;
-    n?: number;
-    asc?: boolean;
-    includeMetadata?: boolean;
-    format?: string;
-    bindOnLastSearch?: boolean;
-    t: string[];
-    org: string;
-}
-export interface VisitsMetricsOptions {
-    m: string[];
-    from: string;
-    to: string;
-    tz?: string;
-    f?: string[];
-    hideEventFilters?: string[];
-    fn?: string[];
-    org: string;
-}
-export interface VisitMetricStats {
-    sum: number;
-    average: number;
-    min: number;
-    max: number;
-}
-export interface VisitsGraphDataPointsOptions {
-    m: string[];
-    from: string;
-    to: string;
-    tz?: string;
-    f?: string[];
-    hideEventFilters?: string[];
-    fn?: string[];
-    i?: string;
-    org: string;
-}
-export interface DeleteQueryOptions {
-    org: string;
-}
-export interface DataPointModel {
-    dateTime: number;
-    datas: Record<string, number>;
-}
-export interface GraphDataPointsOptions {
-    m: string[];
-    from: string;
-    to: string;
-    tz?: string;
-    f?: string[];
-    i?: string[];
-    bindOnLastSearch?: boolean;
-    org: string;
-}
-export interface GraphDataPointsModel {
-    dataPoints: DataPointModel[];
-    totals: Record<string, number>;
-    stats: Record<string, VisitMetricStats>;
-    lastUpdated: string;
-    cached: boolean;
-}
-export interface CombinedDataOptions {
-    m: string[];
-    from: string;
-    to: string;
-    tz?: string;
-    d: string[];
-    f?: string[];
-    fm?: string[];
-    s?: string;
-    p?: number;
-    n?: number;
-    asc?: boolean;
-    includeMetadata?: boolean;
-    format?: boolean;
-    bindOnLastSearch?: boolean;
-    org: string;
-}
-export interface CombinedDataModel {
-    combinations: Array<Record<string, any>>;
-    uniqueCounts: Record<string, number>;
-    totalNumberOfResults: number;
-    lastUpdated: number;
-    cached: boolean;
-}
-export interface TopQueries {
-    queryText?: string;
-    pageSize?: number;
-    pageNumber?: number;
-    org: string;
-}
-export interface MonitoringHealthModel {
-    status: string;
-}
-export interface VisitsStatisticsOptions {
-    from: string;
-    to: string;
-    tz?: string;
-    d?: string[];
-    f?: string[];
-    hideEventFilters?: string[];
-    fn?: string[];
-    s?: string;
-    p?: number;
-    n?: number;
-    asc?: boolean;
-    includeMetadata?: boolean;
-    org: string;
-}
-export interface VisitStatisticsModel {
-    visitId: string;
-    events: any[];
-    numberOfEvents: number;
-}
-export interface VisitsStatisticsModel {
-    visits: VisitStatisticsModel[];
-    totalNumberOfVisits: number;
-}
-export interface VisitViewOptions {
-    org: string;
-}
+export interface ServiceStatus {
+    status: string;
+}
+export interface MetricValue {
+    value: number;
+}
+export interface MetricStats {
+    average: number;
+    total: number;
+    peak: number;
+}
+export interface IncoherentEventsOptions {
+    from: string;
+    to: string;
+    errorCodes?: string[];
+    p?: number;
+    n?: number;
+    asc?: boolean;
+    includeMetadata?: boolean;
+    seen?: boolean;
+    org: string;
+}
+export interface IncoherentEventModel {
+    errorCode: string;
+    datetime: string;
+    event: any;
+}
+export interface IncoherentEventsModel {
+    events: IncoherentEventModel[];
+    uniqueCounts: any;
+    totalNumberOfResults: number;
+}
+export interface MetricsModel {
+    globalDatas: Record<string, MetricValue | MetricStats>;
+    lastUpdated: number;
+    cached: boolean;
+}
+export interface GlobalDataOptions {
+    m: string[];
+    from: string;
+    to: string;
+    tz?: string;
+    d?: string[];
+    f?: string[];
+    i?: string;
+    bindOnLastSearch?: boolean;
+    org: string;
+}
+export interface TrendsModel {
+    combinations: Array<Record<string, any>>;
+    uniqueCounts: Record<string, number>;
+    totalNumberOfResults: number;
+    lastUpdated: number;
+    cached: boolean;
+}
+export interface TrendsOptions {
+    m: string[];
+    from: string;
+    to: string;
+    previousFrom?: string;
+    previousTo?: string;
+    tz?: string;
+    d: string[];
+    f?: string[];
+    fm?: string[];
+    s?: string;
+    p?: number;
+    n?: number;
+    asc?: boolean;
+    includeMetadata?: boolean;
+    format?: string;
+    bindOnLastSearch?: boolean;
+    t: string[];
+    org: string;
+}
+export interface VisitsMetricsOptions {
+    m: string[];
+    from: string;
+    to: string;
+    tz?: string;
+    f?: string[];
+    hideEventFilters?: string[];
+    fn?: string[];
+    org: string;
+}
+export interface VisitMetricStats {
+    sum: number;
+    average: number;
+    min: number;
+    max: number;
+}
+export interface VisitsGraphDataPointsOptions {
+    m: string[];
+    from: string;
+    to: string;
+    tz?: string;
+    f?: string[];
+    hideEventFilters?: string[];
+    fn?: string[];
+    i?: string;
+    org: string;
+}
+export interface DeleteQueryOptions {
+    org: string;
+}
+export interface DataPointModel {
+    dateTime: number;
+    datas: Record<string, number>;
+}
+export interface GraphDataPointsOptions {
+    m: string[];
+    from: string;
+    to: string;
+    tz?: string;
+    f?: string[];
+    i?: string[];
+    bindOnLastSearch?: boolean;
+    org: string;
+}
+export interface GraphDataPointsModel {
+    dataPoints: DataPointModel[];
+    totals: Record<string, number>;
+    stats: Record<string, VisitMetricStats>;
+    lastUpdated: string;
+    cached: boolean;
+}
+export interface CombinedDataOptions {
+    m: string[];
+    from: string;
+    to: string;
+    tz?: string;
+    d: string[];
+    f?: string[];
+    fm?: string[];
+    s?: string;
+    p?: number;
+    n?: number;
+    asc?: boolean;
+    includeMetadata?: boolean;
+    format?: boolean;
+    bindOnLastSearch?: boolean;
+    org: string;
+}
+export interface CombinedDataModel {
+    combinations: Array<Record<string, any>>;
+    uniqueCounts: Record<string, number>;
+    totalNumberOfResults: number;
+    lastUpdated: number;
+    cached: boolean;
+}
+export interface TopQueries {
+    queryText?: string;
+    pageSize?: number;
+    pageNumber?: number;
+    org: string;
+}
+export interface MonitoringHealthModel {
+    status: string;
+}
+export interface VisitsStatisticsOptions {
+    from: string;
+    to: string;
+    tz?: string;
+    d?: string[];
+    f?: string[];
+    hideEventFilters?: string[];
+    fn?: string[];
+    s?: string;
+    p?: number;
+    n?: number;
+    asc?: boolean;
+    includeMetadata?: boolean;
+    org: string;
+}
+export interface VisitStatisticsModel {
+    visitId: string;
+    events: any[];
+    numberOfEvents: number;
+}
+export interface VisitsStatisticsModel {
+    visits: VisitStatisticsModel[];
+    totalNumberOfVisits: number;
+}
+export interface VisitViewOptions {
+    org: string;
+}

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

@@ -1,2 +1,2 @@
-export * from './Statistics';
-export * from './StatisticsInterfaces';
+export * from './Statistics';
+export * from './StatisticsInterfaces';

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

@@ -1,12 +1,12 @@
-import Resource from '../../../Resource';
-import { FilterParams, UsersFiltersModel, ListUsersFiltersParams, ListUsersReportsParams, UsersReportsModel, UserModel, UsersStatusModel } from './UsersInterfaces';
-export default class Users extends Resource {
-    static baseUrl: string;
-    listUserFilters(userId: string, params?: ListUsersFiltersParams): Promise<UsersFiltersModel>;
-    updateUserFilters(userId: string, filters: FilterParams[]): Promise<void>;
-    listUsersReports(userId: string, params?: ListUsersReportsParams): Promise<UsersReportsModel>;
-    updateUsersReports(userId: string, reportsIDs: string[]): Promise<void>;
-    getUsersServiceHealth(): Promise<UsersStatusModel>;
-    getUsersServiceStatus(): Promise<UsersStatusModel>;
-    getUser(userId: string): Promise<UserModel>;
-}
+import Resource from '../../../Resource';
+import { FilterParams, UsersFiltersModel, ListUsersFiltersParams, ListUsersReportsParams, UsersReportsModel, UserModel, UsersStatusModel } from './UsersInterfaces';
+export default class Users extends Resource {
+    static baseUrl: string;
+    listUserFilters(userId: string, params?: ListUsersFiltersParams): Promise<UsersFiltersModel>;
+    updateUserFilters(userId: string, filters: FilterParams[]): Promise<void>;
+    listUsersReports(userId: string, params?: ListUsersReportsParams): Promise<UsersReportsModel>;
+    updateUsersReports(userId: string, reportsIDs: string[]): Promise<void>;
+    getUsersServiceHealth(): Promise<UsersStatusModel>;
+    getUsersServiceStatus(): Promise<UsersStatusModel>;
+    getUser(userId: string): Promise<UserModel>;
+}

package/dist/definitions/resources/UsageAnalytics/Read/Users/UsersInterfaces.d.ts

@@ -1,113 +1,113 @@
-export interface UsersFilterModel {
-    /**
-     * 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: 'permissions' | 'reporting';
-    /**
-     * The actual filter
-     */
-    value: string;
-}
-export interface UsersFiltersModel {
-    /**
-     * The filters that are applied to the user
-     */
-    filters: UsersFilterModel[];
-}
-export interface UsersReportModel {
-    /**
-     * The report id
-     */
-    id: string;
-    /**
-     * The report account
-     */
-    account: string;
-    /**
-     * The report display name
-     */
-    displayName: string;
-    /**
-     * The report type. Can be 'permissions' or 'reporting'
-     */
-    type: 'permissions' | 'reporting';
-    /**
-     * The report configuration in JSON
-     */
-    configuration: Record<string, any>;
-    /**
-     * Whether the report is available to all analytics viewer
-     */
-    allAnalyticsViewer: boolean;
-    /**
-     * List of associated filters
-     */
-    filters: string[];
-}
-export interface UsersReportsModel {
-    /**
-     * The reports the user can view
-     */
-    reports: UsersReportModel[];
-}
-export interface UsersStatusModel {
-    /**
-     * Service's status information
-     */
-    status: string;
-}
-export interface UserModel {
-    /**
-     * The user id
-     */
-    userId: string;
-    /**
-     * The user account
-     */
-    account: string;
-    /**
-     * The filters that are applied to the user
-     */
-    filters: string[];
-    /**
-     * The reports the user can view
-     */
-    reports: string[];
-}
-export interface ListUsersFiltersParams {
-    /**
-     * The org id
-     */
-    org: string;
-    /**
-     * Whether to include th values inherited from a user's groups in the response
-     */
-    includeGroups?: boolean;
-}
-export interface FilterParams {
-    /**
-     * The value of the filter
-     */
-    value: string;
-    /**
-     * The id determining if the filters currently exists in the org's filters
-     */
-    id: boolean;
-}
-export interface ListUsersReportsParams {
-    org?: string;
-    includeConfig?: boolean;
-    includeGroups?: boolean;
-}
+export interface UsersFilterModel {
+    /**
+     * 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: 'permissions' | 'reporting';
+    /**
+     * The actual filter
+     */
+    value: string;
+}
+export interface UsersFiltersModel {
+    /**
+     * The filters that are applied to the user
+     */
+    filters: UsersFilterModel[];
+}
+export interface UsersReportModel {
+    /**
+     * The report id
+     */
+    id: string;
+    /**
+     * The report account
+     */
+    account: string;
+    /**
+     * The report display name
+     */
+    displayName: string;
+    /**
+     * The report type. Can be 'permissions' or 'reporting'
+     */
+    type: 'permissions' | 'reporting';
+    /**
+     * The report configuration in JSON
+     */
+    configuration: Record<string, any>;
+    /**
+     * Whether the report is available to all analytics viewer
+     */
+    allAnalyticsViewer: boolean;
+    /**
+     * List of associated filters
+     */
+    filters: string[];
+}
+export interface UsersReportsModel {
+    /**
+     * The reports the user can view
+     */
+    reports: UsersReportModel[];
+}
+export interface UsersStatusModel {
+    /**
+     * Service's status information
+     */
+    status: string;
+}
+export interface UserModel {
+    /**
+     * The user id
+     */
+    userId: string;
+    /**
+     * The user account
+     */
+    account: string;
+    /**
+     * The filters that are applied to the user
+     */
+    filters: string[];
+    /**
+     * The reports the user can view
+     */
+    reports: string[];
+}
+export interface ListUsersFiltersParams {
+    /**
+     * The org id
+     */
+    org: string;
+    /**
+     * Whether to include th values inherited from a user's groups in the response
+     */
+    includeGroups?: boolean;
+}
+export interface FilterParams {
+    /**
+     * The value of the filter
+     */
+    value: string;
+    /**
+     * The id determining if the filters currently exists in the org's filters
+     */
+    id: boolean;
+}
+export interface ListUsersReportsParams {
+    org?: string;
+    includeConfig?: boolean;
+    includeGroups?: boolean;
+}

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

@@ -1,2 +1,2 @@
-export * from './Users';
-export * from './UsersInterfaces';
+export * from './Users';
+export * from './UsersInterfaces';

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

@@ -1,9 +1,9 @@
-export * from './Administration';
-export * from './DataShare';
-export * from './Dimensions';
-export * from './Exports';
-export * from './Filters';
-export * from './Reports';
-export * from './Snowflake';
-export * from './Statistics';
-export * from './Users';
+export * from './Administration';
+export * from './DataShare';
+export * from './Dimensions';
+export * from './Exports';
+export * from './Filters';
+export * from './Reports';
+export * from './Snowflake';
+export * from './Statistics';
+export * from './Users';