@coveo/platform-client 0.0.0-cjs-attempt

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';

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

@@ -0,0 +1,73 @@
+import { ReadServiceHealthApi, ReadServiceHealthResponse, ReadServiceStatusResponse } from '../ReadServiceCommon.js';
+import ReadServiceResource from '../ReadServiceResource.js';
+import { CreateExportScheduleModel, EstimateExportParams, EstimateVisitExportParams, ExportDownloadLink, ExportEstimateModel, ExportModel, ExportScheduleModel, GenerateExportParams, GenerateVisitExportParams } from './ExportsInterfaces.js';
+export default class Exports extends ReadServiceResource implements ReadServiceHealthApi {
+    static baseUrl: string;
+    /**
+     * Lists all exports.
+     */
+    list(): Promise<ExportModel[]>;
+    /**
+     * Generate an export.
+     */
+    generate(params: GenerateExportParams): Promise<ExportModel>;
+    /**
+     * Get information on an export.
+     *
+     * @param exportId The export's unique identifier.
+     * @param redirect Whether to return a HTTP redirect to the actual file.
+     */
+    get(exportId: string, redirect?: boolean): Promise<ExportModel>;
+    /**
+     * Get the download link of an export.
+     *
+     * @param exportId The export's unique identifier.
+     */
+    getExportDownloadLink(exportId: string): Promise<ExportDownloadLink>;
+    /**
+     * Delete an export.
+     *
+     * @param exportId The export's unique identifier.
+     */
+    delete(exportId: string): Promise<void>;
+    /**
+     * Estimate the number of rows in an export.
+     */
+    estimateRowsCount(params: EstimateExportParams): Promise<ExportEstimateModel>;
+    /**
+     * Generate a visit export.
+     */
+    generateVisitExport(params: GenerateVisitExportParams): Promise<ExportModel>;
+    /**
+     * Estimate the number of rows in a visit export.
+     */
+    estimateVisitExportRowsCount(params: EstimateVisitExportParams): Promise<ExportEstimateModel>;
+    /**
+     * Get all the export schedules.
+     */
+    listSchedules(): Promise<ExportScheduleModel[]>;
+    /**
+     * Create an export schedule.
+     */
+    createSchedule(model: CreateExportScheduleModel): Promise<ExportScheduleModel>;
+    /**
+     * Get information on an export schedule.
+     *
+     * @param exportScheduleId The export schedule's unique identifier.
+     */
+    getSchedule(exportScheduleId: string): Promise<ExportScheduleModel>;
+    /**
+     * Update an existing export schedule.
+     *
+     * @param exportScheduleId The export schedule's unique identifier.
+     */
+    updateSchedule(exportScheduleId: string, model: CreateExportScheduleModel): Promise<ExportScheduleModel>;
+    /**
+     * Delete an export schedule.
+     *
+     * @param exportScheduleId The export schedule's unique identifier.
+     */
+    deleteSchedule(exportScheduleId: string): Promise<void>;
+    checkHealth(): Promise<ReadServiceHealthResponse>;
+    checkStatus(): Promise<ReadServiceStatusResponse>;
+}

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

@@ -0,0 +1,106 @@
+import { CSVFileFormat, DayOfWeek, ExportScheduleFrequency, ExportStatus, ExportTablesType } from '../../../Enums.js';
+import { EventDimensionsExcludeFilterParamParts, EventDimensionsFilterParamParts, EventDimensionsHideEventsFilterParamParts, TimeRangeParamParts } from '../CommonParamParts.js';
+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;
+}
+export interface EstimateExportParams extends TimeRangeParamParts, EventDimensionsFilterParamParts {
+    /**
+     * The tables that will be included.
+     * If not provided, all tables will be included.
+     */
+    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 TimeRangeParamParts, EventDimensionsFilterParamParts, EventDimensionsExcludeFilterParamParts, EventDimensionsHideEventsFilterParamParts {
+}
+export interface GenerateExportParams extends EstimateExportParams {
+    /**
+     * Can only contain US-ASCII characters. If not provided, it will be set to the export's id.
+     */
+    filename?: string;
+    /**
+     * Export's description.
+     */
+    d?: string;
+    /**
+     * The dimensions that will be exported. If not provided, all dimensions will be exported.
+     */
+    dimensions?: string[];
+    /**
+     * The format of the generated CSV files.
+     */
+    format?: CSVFileFormat;
+    /**
+     * Whether to use the display names in the export's header. If false, the api names will be used.
+     */
+    useDisplayNames?: boolean;
+}
+export interface GenerateVisitExportParams extends GenerateExportParams {
+    /**
+     * Whether to order the rows by datetime in the export.
+     * If the number of rows exported is too large, this parameter will be ignored and data will be unsorted.
+     */
+    ordered?: boolean;
+}
+interface ExportScheduleModelCommonProperties {
+    frequency: ExportScheduleFrequency;
+    dayOfWeek?: DayOfWeek;
+    timezone: string;
+    dimensions?: string[];
+    usingDisplayNames?: boolean;
+    notificationsEmails?: string[];
+}
+export interface ExportScheduleModel extends ExportScheduleModelCommonProperties {
+    id: string;
+    author: string;
+    filters: Record<string, string>;
+    tables?: string[];
+    description: string;
+    errorInfo?: Record<string, string>;
+}
+export interface CreateExportScheduleModel extends ExportScheduleModelCommonProperties {
+    commonFilters?: string[];
+    searchesFilters?: string[];
+    customEventsFilters?: string[];
+    description?: string;
+    tables?: ExportTablesType[];
+    exportFormat?: CSVFileFormat;
+}
+export {};

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

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

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

@@ -0,0 +1,84 @@
+import { ReadServiceHealthResponse, ReadServiceHealthApi, ReadServiceStatusResponse } from '../ReadServiceCommon.js';
+import ReadServiceResource from '../ReadServiceResource.js';
+import { CreatePermissionsFilterModel, CreatePermissionsFilterResponse, CreateReportingFilterModel, CreateReportingFilterResponse, FilterResponse, FilterTargetsModel, FilterTargetsResponse, ListFiltersResponse, PermissionsFilterUser, UpdatePermissionsFilterModel, UpdateReportingFilterModel } from './FiltersInterfaces.js';
+export default class Filters extends ReadServiceResource implements ReadServiceHealthApi {
+    static baseUrl: string;
+    static reportingBaseUrl: string;
+    static permissionsBaseUrl: string;
+    /**
+     * Get all reporting filters.
+     */
+    listReportFilters(): Promise<ListFiltersResponse>;
+    /**
+     * Get a reporting filter.
+     *
+     * @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
+     */
+    getReportFilter(filterId: string): Promise<FilterResponse>;
+    /**
+     * Create a reporting filter.
+     */
+    createReportFilter(filter: CreateReportingFilterModel): Promise<CreateReportingFilterResponse>;
+    /**
+     * Update a reporting filter
+     *
+     * @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
+     */
+    updateReportFilter(filterId: string, filter: UpdateReportingFilterModel): Promise<CreateReportingFilterResponse>;
+    /**
+     * Delete a reporting filter
+     *
+     * @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
+     */
+    deleteReportFilter(filterId: string): Promise<Record<string, unknown>>;
+    /**
+     * Get all permission filters.
+     */
+    listPermissionFilters(): Promise<ListFiltersResponse>;
+    /**
+     * Get a permission filter.
+     */
+    getPermissionFilter(filterId: string): Promise<FilterResponse>;
+    /**
+     * Create a permission filter.
+     */
+    createPermissionFilter(filter: CreatePermissionsFilterModel): Promise<CreatePermissionsFilterResponse>;
+    /**
+     * Update a permission filter.
+     *
+     * @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
+     */
+    updatePermissionFilter(filterId: string, filter: UpdatePermissionsFilterModel): Promise<CreatePermissionsFilterResponse>;
+    /**
+     * Delete a permission filter.
+     *
+     * @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
+     */
+    deletePermissionFilter(filterId: string): Promise<Record<string, unknown>>;
+    /**
+     * Get the users of a permission filters.
+     *
+     * @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
+     */
+    getPermissionFilterUsers(filterId: string): Promise<PermissionsFilterUser[]>;
+    /**
+     * Set the users of a permission filter.
+     *
+     * @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
+     */
+    updatePermissionFilterUsers(filterId: string, users: string[]): Promise<Record<string, unknown>>;
+    /**
+     * Get the targets of a permission filters.
+     *
+     * @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
+     */
+    getPermissionFilterTargets(filterId: string): Promise<FilterTargetsResponse[]>;
+    /**
+     * Set the targets of a permission filter.
+     *
+     * @param filterId The unique identifier of a filter. This id is generated by the server when creating a filter.
+     */
+    updatePermissionFilterTargets(filterId: string, targets: FilterTargetsModel): Promise<Record<string, unknown>>;
+    checkHealth(): Promise<ReadServiceHealthResponse>;
+    checkStatus(): Promise<ReadServiceStatusResponse>;
+}

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

@@ -0,0 +1,59 @@
+import { GroupResponse, UserResponse } from '../Reports/index.js';
+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 type CreateReportingFilterModel = FilterModel;
+export type CreateReportingFilterResponse = Pick<FilterResponse, 'id'>;
+export type UpdateReportingFilterModel = CreateReportingFilterModel;
+export type UpdateReportingFilterResponse = CreateReportingFilterResponse;
+export type CreatePermissionsFilterModel = FilterModel;
+export type CreatePermissionsFilterResponse = Pick<FilterResponse, 'id'>;
+export type UpdatePermissionsFilterModel = CreatePermissionsFilterModel;
+export 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[];
+}

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

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

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

@@ -0,0 +1,44 @@
+/**
+ * Represents the health of the service.
+ */
+export declare enum ReadServiceHealthEnum {
+    UP = "up",
+    UNAVAILABLE = "unavailable",
+    DEGRADED = "degraded"
+}
+export interface ReadServiceHealthResponse {
+    /** The health status of the service. */
+    status: ReadServiceHealthEnum;
+}
+/**
+ * Represents the status of the service.
+ */
+export declare enum ReadServiceStatusEnum {
+    ONLINE = "online",
+    UNAVAILABLE = "unavailable",
+    DEGRADED = "degraded"
+}
+export interface ReadServiceStatusResponse {
+    /** The status of the service. */
+    status: ReadServiceStatusEnum;
+}
+export interface ReadServiceHealthApi {
+    /**
+     * Health check for the service.
+     */
+    checkHealth(): Promise<ReadServiceHealthResponse>;
+    /**
+     * Get the service status.
+     */
+    checkStatus(): Promise<ReadServiceStatusResponse>;
+}
+/**
+ * Supported intervals for calls returning metrics over time.
+ */
+export declare enum MetricsInterval {
+    MINUTE = "MINUTE",
+    HOUR = "HOUR",
+    DAY = "DAY",
+    WEEK = "WEEK",
+    MONTH = "MONTH"
+}

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

@@ -0,0 +1,16 @@
+import Resource from '../../Resource.js';
+/**
+ * Extends Resource with a `buildPathWithOrg` method, that will fill in the optional `org` query parameter by default.
+ * It still allows "overriding" the org by specifying it explicitly in the parameters.
+ */
+export default class ReadServiceResource extends Resource {
+    /**
+     * Build the request path, handling the optional `org` query parameter.
+     *
+     * @param route The path part of the request.
+     * @param queryParams Optional query parameters object.
+     * If this object contains an `org` property, it will override the value from the configuration.
+     * @returns The request path including formatted query parameters.
+     */
+    protected buildPathWithOrg(route: string, queryParams?: any): string;
+}

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

@@ -0,0 +1,71 @@
+import { ReportType } from '../../../Enums.js';
+import { ReadServiceHealthApi, ReadServiceHealthResponse, ReadServiceStatusResponse } from '../ReadServiceCommon.js';
+import ReadServiceResource from '../ReadServiceResource.js';
+import { CreateReportModel, CreateReportResponse, GetReportOptions, GetReportTemplateOptions, ListReportsOptions, ListReportsResponse, ReportAccessRequest, ReportAccessResponse, ReportModel, TemplateResponse, ReportUsersResponse, TemplateMetadataResponse, UpdateReportModel } from './ReportsInterfaces.js';
+export default class Reports extends ReadServiceResource implements ReadServiceHealthApi {
+    static baseUrl: string;
+    /**
+     * Get the persisted reports of one or all types.
+     */
+    list(options?: ListReportsOptions): Promise<ListReportsResponse>;
+    /**
+     * Get a report.
+     *
+     * @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
+     */
+    get(reportId: string, options?: GetReportOptions): Promise<ReportModel>;
+    /**
+     * Create a report.
+     */
+    create(report: CreateReportModel): Promise<CreateReportResponse>;
+    /**
+     * Update a report.
+     *
+     * @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
+     */
+    update(reportId: string, report: UpdateReportModel): Promise<CreateReportModel>;
+    /**
+     * Delete a report.
+     *
+     * @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
+     */
+    delete(reportId: string): Promise<Record<string, unknown>>;
+    /**
+     * Get the users and groups who can view a report.
+     *
+     * @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
+     */
+    getAccess(reportId: string): Promise<ReportAccessResponse>;
+    /**
+     * Set the users and groups who are allowed to view a report.
+     *
+     * @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
+     */
+    setAccess(reportId: string, reportAccess: ReportAccessRequest): Promise<Record<string, unknown>>;
+    /**
+     * Get the users who can view a report.
+     *
+     * @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
+     */
+    getUsers(reportId: string): Promise<ReportUsersResponse>;
+    /**
+     * Set the users who are allowed to view a report.
+     *
+     * @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
+     */
+    setUsers(reportId: string, userIds: string[]): Promise<Record<string, unknown>>;
+    /**
+     * Get a report template.
+     *
+     * @param templateId The unique identifier of a template.
+     */
+    getReportTemplate(templateId: string, options?: GetReportTemplateOptions): Promise<TemplateResponse[]>;
+    /**
+     * Get metadata about available report templates.
+     *
+     * @param type The type of the report. Must be either 'explorer' or 'dashboard'.
+     */
+    listReportTemplates(type: ReportType, options?: GetReportTemplateOptions): Promise<TemplateMetadataResponse[]>;
+    checkHealth(): Promise<ReadServiceHealthResponse>;
+    checkStatus(): Promise<ReadServiceStatusResponse>;
+}

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

@@ -0,0 +1,97 @@
+import { ReportType } from '../../../Enums.js';
+import { TimeZoneParamParts } from '../CommonParamParts.js';
+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 type CreateReportModel = Omit<ReportModel, 'id' | 'account'>;
+export type CreateReportResponse = Pick<ReportModel, 'id'>;
+export interface GetReportOptions extends TimeZoneParamParts {
+}
+export type UpdateReportModel = CreateReportModel;
+export 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 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 {};