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

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

@@ -1,99 +1,99 @@
-import { ReportType } from '../../../Enums';
-export interface ReportModel {
-    /** The report id */
-    id: string;
-    /** The report account */
-    account: string;
-    /** The display name of the report */
-    displayName: string;
-    /** The type of the report. Must be either 'explorer' or 'dashboard'. */
-    type: ReportType;
-    /** Whether the report should be available to all analytics viewer. */
-    allAnalyticsViewer: boolean;
-    /** The configuration of the report. Must be a json. */
-    configuration: Record<string, unknown>;
-    /** The ids of the persisted filters associated with the report. */
-    filters: string[];
-}
-export declare type CreateReportModel = Omit<ReportModel, 'id' | 'account'>;
-export declare type CreateReportResponse = Pick<ReportModel, 'id'>;
-export interface GetReportOptions {
-    /** Timezone used for calculations. */
-    tz?: string;
-}
-export declare type UpdateReportModel = CreateReportModel;
-export declare type UpdateReportResponse = CreateReportResponse;
-export interface ListReportsOptions {
-    /** The type of the report. Must be either 'explorer' or 'dashboard'. */
-    type?: ReportType;
-    /** Whether to include the detailed configuration of the report in the response. */
-    includeConfig?: boolean;
-}
-export interface ListReportsResponse {
-    /** A collection of report configurations */
-    reports: ReportModel[];
-}
-export declare enum ReportAccessType {
-    Public = "PUBLIC",
-    Private = "PRIVATE"
-}
-export interface ReportAccessResponse {
-    /** The access type of the report. Can be PUBLIC or PRIVATE. */
-    accessType: ReportAccessType;
-    /** The users allowed to access the specified report. */
-    allowedUsers: UserResponse[];
-    /** The groups allowed to access the specified report. */
-    allowedGroups: GroupResponse[];
-}
-export interface ReportAccessRequest {
-    /** Whether the report is public or private. Allowed values are 'PUBLIC', 'PRIVATE'. */
-    accessType: ReportAccessType;
-    /** The ids of the users allowed to access the report. */
-    allowedUsers: string[];
-    /** The ids of the groups allowed to access the report. */
-    allowedGroups: string[];
-}
-export interface ReportUsersResponse {
-    /** The access type of the report. Can be PUBLIC or PRIVATE. */
-    access: ReportAccessType;
-    /** The users allowed to access the specified report. */
-    allowedUsers: UserResponse[];
-}
-interface AccountMetaModel {
-    /** The filters that are applied to the user */
-    filters: string[];
-    /** The reports the user can view. */
-    reports: string[];
-}
-export interface UserResponse extends AccountMetaModel {
-    /** The user id */
-    userId: string;
-    /** The user account */
-    account: string;
-}
-export interface GroupResponse extends AccountMetaModel {
-    /** The group id */
-    groupId: string;
-    /** The group account */
-    account: string;
-}
-export declare type StatusResponse = Record<string, unknown>;
-export interface GetReportTemplateOptions {
-    /** Whether to include metadata about the report template */
-    includeMetadata?: boolean;
-}
-export interface TemplateMetadataResponse {
-    /** The template id. */
-    id: string;
-    /** The template title. */
-    title: string;
-    /** The template description. */
-    description: string;
-    /** The template category. */
-    category: string;
-}
-export interface TemplateResponse extends TemplateMetadataResponse {
-    /** The JSON report configuration of the template. */
-    configuration: Record<string, unknown>;
-}
-export {};
+import { ReportType } from '../../../Enums';
+export interface ReportModel {
+    /** The report id */
+    id: string;
+    /** The report account */
+    account: string;
+    /** The display name of the report */
+    displayName: string;
+    /** The type of the report. Must be either 'explorer' or 'dashboard'. */
+    type: ReportType;
+    /** Whether the report should be available to all analytics viewer. */
+    allAnalyticsViewer: boolean;
+    /** The configuration of the report. Must be a json. */
+    configuration: Record<string, unknown>;
+    /** The ids of the persisted filters associated with the report. */
+    filters: string[];
+}
+export declare type CreateReportModel = Omit<ReportModel, 'id' | 'account'>;
+export declare type CreateReportResponse = Pick<ReportModel, 'id'>;
+export interface GetReportOptions {
+    /** Timezone used for calculations. */
+    tz?: string;
+}
+export declare type UpdateReportModel = CreateReportModel;
+export declare type UpdateReportResponse = CreateReportResponse;
+export interface ListReportsOptions {
+    /** The type of the report. Must be either 'explorer' or 'dashboard'. */
+    type?: ReportType;
+    /** Whether to include the detailed configuration of the report in the response. */
+    includeConfig?: boolean;
+}
+export interface ListReportsResponse {
+    /** A collection of report configurations */
+    reports: ReportModel[];
+}
+export declare enum ReportAccessType {
+    Public = "PUBLIC",
+    Private = "PRIVATE"
+}
+export interface ReportAccessResponse {
+    /** The access type of the report. Can be PUBLIC or PRIVATE. */
+    accessType: ReportAccessType;
+    /** The users allowed to access the specified report. */
+    allowedUsers: UserResponse[];
+    /** The groups allowed to access the specified report. */
+    allowedGroups: GroupResponse[];
+}
+export interface ReportAccessRequest {
+    /** Whether the report is public or private. Allowed values are 'PUBLIC', 'PRIVATE'. */
+    accessType: ReportAccessType;
+    /** The ids of the users allowed to access the report. */
+    allowedUsers: string[];
+    /** The ids of the groups allowed to access the report. */
+    allowedGroups: string[];
+}
+export interface ReportUsersResponse {
+    /** The access type of the report. Can be PUBLIC or PRIVATE. */
+    access: ReportAccessType;
+    /** The users allowed to access the specified report. */
+    allowedUsers: UserResponse[];
+}
+interface AccountMetaModel {
+    /** The filters that are applied to the user */
+    filters: string[];
+    /** The reports the user can view. */
+    reports: string[];
+}
+export interface UserResponse extends AccountMetaModel {
+    /** The user id */
+    userId: string;
+    /** The user account */
+    account: string;
+}
+export interface GroupResponse extends AccountMetaModel {
+    /** The group id */
+    groupId: string;
+    /** The group account */
+    account: string;
+}
+export declare type StatusResponse = Record<string, unknown>;
+export interface GetReportTemplateOptions {
+    /** Whether to include metadata about the report template */
+    includeMetadata?: boolean;
+}
+export interface TemplateMetadataResponse {
+    /** The template id. */
+    id: string;
+    /** The template title. */
+    title: string;
+    /** The template description. */
+    description: string;
+    /** The template category. */
+    category: string;
+}
+export interface TemplateResponse extends TemplateMetadataResponse {
+    /** The JSON report configuration of the template. */
+    configuration: Record<string, unknown>;
+}
+export {};

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

@@ -1,2 +1,2 @@
-export * from './Reports';
-export * from './ReportsInterfaces';
+export * from './Reports';
+export * from './ReportsInterfaces';

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

@@ -1,16 +1,16 @@
-import Resource from '../../../Resource';
-import { GetCreditUsageParams, SnowflakeCreditUsageModel, SnowflakeNetworkPolicyModel, SnowflakeReaderAccountEndpointModel, SnowflakeReaderAccountStatusModel, SnowflakeUserModel, SnowflakeUsersModel } from './SnowflakeInterfaces';
-export default class Snowflake extends Resource {
-    static baseUrl: string;
-    listUsers(): Promise<SnowflakeUsersModel>;
-    createUser(model: SnowflakeUserModel): Promise<SnowflakeUserModel>;
-    deleteUser(snowflakeUser: string): Promise<void>;
-    getUser(snowflakeUser: string): Promise<SnowflakeUserModel>;
-    resetPassword(snowflakeUser: string): Promise<void>;
-    getNetworkPolicy(): Promise<SnowflakeNetworkPolicyModel>;
-    updateNetworkPolicy(model: SnowflakeNetworkPolicyModel): Promise<void>;
-    getCreditUsage(params: GetCreditUsageParams): Promise<SnowflakeCreditUsageModel>;
-    getSnowflakeReaderAccount(): Promise<SnowflakeReaderAccountStatusModel>;
-    getSnowflakeReaderAccountEndpoint(): Promise<SnowflakeReaderAccountEndpointModel>;
-    createSnowflakeReaderAccount(): Promise<void>;
-}
+import Resource from '../../../Resource';
+import { GetCreditUsageParams, SnowflakeCreditUsageModel, SnowflakeNetworkPolicyModel, SnowflakeReaderAccountEndpointModel, SnowflakeReaderAccountStatusModel, SnowflakeUserModel, SnowflakeUsersModel } from './SnowflakeInterfaces';
+export default class Snowflake extends Resource {
+    static baseUrl: string;
+    listUsers(): Promise<SnowflakeUsersModel>;
+    createUser(model: SnowflakeUserModel): Promise<SnowflakeUserModel>;
+    deleteUser(snowflakeUser: string): Promise<void>;
+    getUser(snowflakeUser: string): Promise<SnowflakeUserModel>;
+    resetPassword(snowflakeUser: string): Promise<void>;
+    getNetworkPolicy(): Promise<SnowflakeNetworkPolicyModel>;
+    updateNetworkPolicy(model: SnowflakeNetworkPolicyModel): Promise<void>;
+    getCreditUsage(params: GetCreditUsageParams): Promise<SnowflakeCreditUsageModel>;
+    getSnowflakeReaderAccount(): Promise<SnowflakeReaderAccountStatusModel>;
+    getSnowflakeReaderAccountEndpoint(): Promise<SnowflakeReaderAccountEndpointModel>;
+    createSnowflakeReaderAccount(): Promise<void>;
+}

package/dist/definitions/resources/UsageAnalytics/Read/Snowflake/SnowflakeInterfaces.d.ts

@@ -1,49 +1,49 @@
-import { SnowflakeReaderAccountStatus } from '../../../Enums';
-export interface SnowflakeUsersModel {
-    snowflakeUsers: SnowflakeUserModel[];
-}
-export interface SnowflakeUserModel {
-    /**
-     * The username of the user
-     */
-    username: string;
-    /**
-     * The email of the user
-     */
-    email: string;
-    /**
-     * The number of days that the user has access to the reader account, ranging from 0 (indefinitely) to 90 days)
-     */
-    daysToExpiry?: number;
-}
-export interface SnowflakeNetworkPolicyModel {
-    allowedIpAddresses: string[];
-    blockedIpAddresses: string[];
-}
-export interface GetCreditUsageParams {
-    /**
-     * The beginning date of the date range.
-     * ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
-     */
-    from: string;
-    /**
-     * The end date of the date range.
-     * ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
-     */
-    to: string;
-}
-export interface SnowflakeCreditUsageModel {
-    creditsUsed: number;
-}
-export interface SnowflakeReaderAccountStatusModel {
-    /**
-     * The status of the create reader account request
-     */
-    snowflakeReaderAccountStatus: SnowflakeReaderAccountStatus;
-}
-export interface SnowflakeReaderAccountEndpointModel {
-    /**
-     * The endpoint of the reader account
-     */
-    endpoint: string;
-}
+import { SnowflakeReaderAccountStatus } from '../../../Enums';
+export interface SnowflakeUsersModel {
+    snowflakeUsers: SnowflakeUserModel[];
+}
+export interface SnowflakeUserModel {
+    /**
+     * The username of the user
+     */
+    username: string;
+    /**
+     * The email of the user
+     */
+    email: string;
+    /**
+     * The number of days that the user has access to the reader account, ranging from 0 (indefinitely) to 90 days)
+     */
+    daysToExpiry?: number;
+}
+export interface SnowflakeNetworkPolicyModel {
+    allowedIpAddresses: string[];
+    blockedIpAddresses: string[];
+}
+export interface GetCreditUsageParams {
+    /**
+     * The beginning date of the date range.
+     * ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
+     */
+    from: string;
+    /**
+     * The end date of the date range.
+     * ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
+     */
+    to: string;
+}
+export interface SnowflakeCreditUsageModel {
+    creditsUsed: number;
+}
+export interface SnowflakeReaderAccountStatusModel {
+    /**
+     * The status of the create reader account request
+     */
+    snowflakeReaderAccountStatus: SnowflakeReaderAccountStatus;
+}
+export interface SnowflakeReaderAccountEndpointModel {
+    /**
+     * The endpoint of the reader account
+     */
+    endpoint: string;
+}

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

@@ -1,2 +1,2 @@
-export * from './Snowflake';
-export * from './SnowflakeInterfaces';
+export * from './Snowflake';
+export * from './SnowflakeInterfaces';

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

@@ -1,18 +1,18 @@
-import Resource from '../../../Resource';
-import { CombinedDataModel, CombinedDataOptions, DeleteQueryOptions, GlobalDataOptions, GraphDataPointsModel, GraphDataPointsOptions, IncoherentEventsModel, IncoherentEventsOptions, MetricsModel, MonitoringHealthModel, ServiceStatus, TrendsModel, TrendsOptions, VisitsGraphDataPointsOptions, VisitsMetricsOptions, VisitsStatisticsModel, VisitsStatisticsOptions, VisitViewOptions } from './StatisticsInterfaces';
-export default class Statistics extends Resource {
-    static baseUrl: string;
-    status(): Promise<ServiceStatus>;
-    listIncoherentEvents(options: IncoherentEventsOptions): Promise<IncoherentEventsModel>;
-    listGraphDataPoints(options: GraphDataPointsOptions): Promise<GraphDataPointsModel>;
-    listGlobalData(options: GlobalDataOptions): Promise<MetricsModel>;
-    listTrends(options: TrendsOptions): Promise<TrendsModel>;
-    listVisitsMetrics(options: VisitsMetricsOptions): Promise<MetricsModel>;
-    listVisitsGraphDataPoints(options: VisitsGraphDataPointsOptions): Promise<GraphDataPointsModel>;
-    delete(queryId: string, options: DeleteQueryOptions): Promise<Record<string, unknown>>;
-    listCombinedData(options: CombinedDataOptions): Promise<CombinedDataModel>;
-    listTopQueries(): Promise<string[]>;
-    getMonitoringHealth(): Promise<MonitoringHealthModel>;
-    listVisits(options: VisitsStatisticsOptions): Promise<VisitsStatisticsModel>;
-    updateVisitView(orgId: VisitViewOptions): Promise<Record<string, unknown>>;
-}
+import Resource from '../../../Resource';
+import { CombinedDataModel, CombinedDataOptions, DeleteQueryOptions, GlobalDataOptions, GraphDataPointsModel, GraphDataPointsOptions, IncoherentEventsModel, IncoherentEventsOptions, MetricsModel, MonitoringHealthModel, ServiceStatus, TrendsModel, TrendsOptions, VisitsGraphDataPointsOptions, VisitsMetricsOptions, VisitsStatisticsModel, VisitsStatisticsOptions, VisitViewOptions } from './StatisticsInterfaces';
+export default class Statistics extends Resource {
+    static baseUrl: string;
+    status(): Promise<ServiceStatus>;
+    listIncoherentEvents(options: IncoherentEventsOptions): Promise<IncoherentEventsModel>;
+    listGraphDataPoints(options: GraphDataPointsOptions): Promise<GraphDataPointsModel>;
+    listGlobalData(options: GlobalDataOptions): Promise<MetricsModel>;
+    listTrends(options: TrendsOptions): Promise<TrendsModel>;
+    listVisitsMetrics(options: VisitsMetricsOptions): Promise<MetricsModel>;
+    listVisitsGraphDataPoints(options: VisitsGraphDataPointsOptions): Promise<GraphDataPointsModel>;
+    delete(queryId: string, options: DeleteQueryOptions): Promise<Record<string, unknown>>;
+    listCombinedData(options: CombinedDataOptions): Promise<CombinedDataModel>;
+    listTopQueries(): Promise<string[]>;
+    getMonitoringHealth(): Promise<MonitoringHealthModel>;
+    listVisits(options: VisitsStatisticsOptions): Promise<VisitsStatisticsModel>;
+    updateVisitView(orgId: VisitViewOptions): Promise<Record<string, unknown>>;
+}