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

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

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

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

@@ -1,99 +0,0 @@
-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 +0,0 @@
-export * from './Reports';
-export * from './ReportsInterfaces';

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

@@ -1,16 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-export * from './Snowflake';
-export * from './SnowflakeInterfaces';

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

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

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

@@ -1,186 +0,0 @@
-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 +0,0 @@
-export * from './Statistics';
-export * from './StatisticsInterfaces';

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

@@ -1,12 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-export * from './Users';
-export * from './UsersInterfaces';

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

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

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

@@ -1,23 +0,0 @@
-import API from '../../APICore';
-import Resource from '../Resource';
-import Administration from './Read/Administration/Administration';
-import DataShare from './Read/DataShare/DataShare';
-import Dimensions from './Read/Dimensions/Dimensions';
-import Exports from './Read/Exports/Exports';
-import Filters from './Read/Filters/Filters';
-import Reports from './Read/Reports/Reports';
-import Snowflake from './Read/Snowflake/Snowflake';
-import Statistics from './Read/Statistics/Statistics';
-export default class UsageAnalytics extends Resource {
-    protected api: API;
-    protected serverlessApi: API;
-    statistics: Statistics;
-    dimensions: Dimensions;
-    exports: Exports;
-    administration: Administration;
-    snowflake: Snowflake;
-    reports: Reports;
-    filters: Filters;
-    dataShare: DataShare;
-    constructor(api: API, serverlessApi: API);
-}

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

@@ -1,2 +0,0 @@
-export * from './Read';
-export * from './UsageAnalytics';

package/dist/definitions/resources/Users/User.d.ts

@@ -1,9 +0,0 @@
-import { RealmModel } from '../Groups';
-import Resource from '../Resource';
-import { UserModel } from './UserInterfaces';
-export default class User extends Resource {
-    static baseUrl: string;
-    get(username?: string): Promise<UserModel>;
-    update(user: Partial<UserModel>): Promise<Record<string, unknown>>;
-    listRealms(username: string): Promise<RealmModel[]>;
-}

package/dist/definitions/resources/Users/UserInterfaces.d.ts

@@ -1,29 +0,0 @@
-import { AuthProvider } from '../Enums';
-import { RealmModel } from '../Groups';
-export interface UserModel {
-    additionalInformation: Record<string, any>;
-    country: string;
-    credentialsExpired: boolean;
-    displayName: string;
-    email: string;
-    emailAliases: string[];
-    emailConfirmed: boolean;
-    enabled: boolean;
-    expired: boolean;
-    firstName: string;
-    lastLogin: number;
-    lastName: string;
-    locked: boolean;
-    name: string;
-    provider: AuthProvider;
-    providerUserId: string;
-    providerUsername: string;
-    realms: UserRealmModel[];
-    samlIdentityProviderId: string;
-    socialUser: boolean;
-    username: string;
-}
-export interface UserRealmModel {
-    member: boolean;
-    realm: RealmModel;
-}

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

@@ -1,2 +0,0 @@
-export * from './User';
-export * from './UserInterfaces';