@coveo/platform-client 37.9.0 → 37.11.0

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

@@ -1,20 +1,78 @@
-import Resource from '../../../Resource';
+import ReadServiceResource from '../ReadServiceResource';
 import { CreateExportScheduleModel, EstimateExportParams, EstimateVisitExportParams, ExportDownloadLink, ExportEstimateModel, ExportModel, ExportScheduleModel, GenerateExportParams, GenerateVisitExportParams } from './ExportsInterfaces';
-export default class Exports extends Resource {
+export default class Exports extends ReadServiceResource {
     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>;
+    /**
+     * Get the exports service status.
+     */
     getStatus(): Promise<Record<string, string>>;
+    /**
+     * Health check for the exports service.
+     */
     checkHealth(): Promise<Record<string, string>>;
+    /**
+     * 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>;
 }

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

@@ -1,4 +1,5 @@
 import { CSVFileFormat, DayOfWeek, ExportScheduleFrequency, ExportStatus, ExportTablesType } from '../../../Enums';
+import { EventDimensionsExcludeFilterParamParts, EventDimensionsFilterParamParts, EventDimensionsHideEventsFilterParamParts, TimeRangeParamParts } from '../CommonParamParts';
 export interface ExportModel {
     id: string;
     author: string;
@@ -22,24 +23,19 @@ export interface ExportEstimateModel {
 }
 export interface ExportDownloadLink {
     /**
-     * The export's unique identifier
+     * The export's unique identifier.
      */
     id: string;
     /**
-     * The export download link. Only appears when export is ready
+     * The export download link. Only appears when export is ready.
      */
     downloadLink?: string;
 }
-interface EstimateExportCommonParams {
-    from: string;
-    to: string;
+export interface EstimateExportParams extends TimeRangeParamParts, EventDimensionsFilterParamParts {
     /**
-     * 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.
+     * The tables that will be included.
+     * If not provided, all tables will be included.
      */
-    f?: string[];
-}
-export interface EstimateExportParams extends EstimateExportCommonParams {
     tables?: ExportTablesType[];
     /**
      * The filter that will be applied to the click and search events dimensions.
@@ -52,29 +48,38 @@ export interface EstimateExportParams extends EstimateExportCommonParams {
      */
     fc?: string[];
 }
-export interface EstimateVisitExportParams extends EstimateExportCommonParams {
-    hideEventFilters?: string[];
+export interface EstimateVisitExportParams extends TimeRangeParamParts, EventDimensionsFilterParamParts, EventDimensionsExcludeFilterParamParts, EventDimensionsHideEventsFilterParamParts {
+}
+export interface GenerateExportParams extends EstimateExportParams {
     /**
-     * The filter that will be applied to dimensions to exclude events from the results.
-     * Multiple filter parameters are joined with the AND operator.
+     * Can only contain US-ASCII characters. If not provided, it will be set to the export's id.
      */
-    fn?: string[];
-}
-interface GenerateExportCommonParams {
     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 type GenerateExportParams = EstimateExportParams & GenerateExportCommonParams;
-export type GenerateVisitExportParams = EstimateVisitExportParams & GenerateExportCommonParams & {
+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 ScheduleCommonProperties {
+}
+interface ExportScheduleModelCommonProperties {
     frequency: ExportScheduleFrequency;
     dayOfWeek?: DayOfWeek;
     timezone: string;
@@ -82,7 +87,7 @@ interface ScheduleCommonProperties {
     usingDisplayNames?: boolean;
     notificationsEmails?: string[];
 }
-export interface ExportScheduleModel extends ScheduleCommonProperties {
+export interface ExportScheduleModel extends ExportScheduleModelCommonProperties {
     id: string;
     author: string;
     filters: Record<string, string>;
@@ -90,7 +95,7 @@ export interface ExportScheduleModel extends ScheduleCommonProperties {
     description: string;
     errorInfo?: Record<string, string>;
 }
-export interface CreateExportScheduleModel extends ScheduleCommonProperties {
+export interface CreateExportScheduleModel extends ExportScheduleModelCommonProperties {
     commonFilters?: string[];
     searchesFilters?: string[];
     customEventsFilters?: string[];

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

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

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

@@ -0,0 +1,16 @@
+import Resource from '../../Resource';
+/**
+ * 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/definitions/resources/UsageAnalytics/Read/Reports/Reports.d.ts

@@ -1,42 +1,56 @@
 import { ReportType } from '../../../Enums';
-import Resource from '../../../Resource';
+import ReadServiceResource from '../ReadServiceResource';
 import { CreateReportModel, CreateReportResponse, GetReportOptions, GetReportTemplateOptions, ListReportsOptions, ListReportsResponse, ReportAccessRequest, ReportAccessResponse, ReportModel, TemplateResponse, ReportUsersResponse, StatusResponse, TemplateMetadataResponse, UpdateReportModel } from './ReportsInterfaces';
-export default class Reports extends Resource {
+export default class Reports extends ReadServiceResource {
     static baseUrl: string;
     /**
-     * Get the persisted reports of one or all types
+     * Get the persisted reports of one or all types.
      */
     list(options?: ListReportsOptions): Promise<ListReportsResponse>;
     /**
-     * Get a report
+     * Get a report.
+     *
+     * @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
      */
-    get(id: string, options?: GetReportOptions): Promise<ReportModel>;
+    get(reportId: string, options?: GetReportOptions): Promise<ReportModel>;
     /**
-     * Create a report
+     * Create a report.
      */
     create(report: CreateReportModel): Promise<CreateReportResponse>;
     /**
-     * Update a report
+     * Update a report.
+     *
+     * @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
      */
-    update(id: string, report: UpdateReportModel): Promise<CreateReportModel>;
+    update(reportId: string, report: UpdateReportModel): Promise<CreateReportModel>;
     /**
-     * Delete a report
+     * Delete a report.
+     *
+     * @param reportId The unique identifier of a report. This id is generated by the server when creating a report.
      */
-    delete(id: string): Promise<Record<string, unknown>>;
+    delete(reportId: string): Promise<Record<string, unknown>>;
     /**
-     * Get the users and groups who can view a report
+     * 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
+     * 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
+     * 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
+     * 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>>;
     /**
@@ -44,15 +58,19 @@ export default class Reports extends Resource {
      */
     healthcheck(): Promise<StatusResponse>;
     /**
-     * Get a report template
+     * 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
+     * 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[]>;
     /**
-     * Get the reports service status
+     * Get the reports service status.
      */
     getServiceStatus(): Promise<StatusResponse>;
 }

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

@@ -1,10 +1,11 @@
 import { ReportType } from '../../../Enums';
+import { TimeZoneParamParts } from '../CommonParamParts';
 export interface ReportModel {
-    /** The report id */
+    /** The report id. */
     id: string;
-    /** The report account */
+    /** The report account. */
     account: string;
-    /** The display name of the report */
+    /** The display name of the report. */
     displayName: string;
     /** The type of the report. Must be either 'explorer' or 'dashboard'. */
     type: ReportType;
@@ -17,9 +18,7 @@ export interface ReportModel {
 }
 export type CreateReportModel = Omit<ReportModel, 'id' | 'account'>;
 export type CreateReportResponse = Pick<ReportModel, 'id'>;
-export interface GetReportOptions {
-    /** Timezone used for calculations. */
-    tz?: string;
+export interface GetReportOptions extends TimeZoneParamParts {
 }
 export type UpdateReportModel = CreateReportModel;
 export type UpdateReportResponse = CreateReportResponse;
@@ -30,7 +29,7 @@ export interface ListReportsOptions {
     includeConfig?: boolean;
 }
 export interface ListReportsResponse {
-    /** A collection of report configurations */
+    /** A collection of report configurations. */
     reports: ReportModel[];
 }
 export declare enum ReportAccessType {
@@ -38,7 +37,7 @@ export declare enum ReportAccessType {
     Private = "PRIVATE"
 }
 export interface ReportAccessResponse {
-    /** The access type of the report. Can be PUBLIC or PRIVATE. */
+    /** The access type of the report. Can be 'PUBLIC' or 'PRIVATE'. */
     accessType: ReportAccessType;
     /** The users allowed to access the specified report. */
     allowedUsers: UserResponse[];
@@ -60,26 +59,26 @@ export interface ReportUsersResponse {
     allowedUsers: UserResponse[];
 }
 interface AccountMetaModel {
-    /** The filters that are applied to the user */
+    /** 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 */
+    /** The user id. */
     userId: string;
-    /** The user account */
+    /** The user account. */
     account: string;
 }
 export interface GroupResponse extends AccountMetaModel {
-    /** The group id */
+    /** The group id. */
     groupId: string;
-    /** The group account */
+    /** The group account. */
     account: string;
 }
 export type StatusResponse = Record<string, unknown>;
 export interface GetReportTemplateOptions {
-    /** Whether to include metadata about the report template */
+    /** Whether to include metadata about the report template. */
     includeMetadata?: boolean;
 }
 export interface TemplateMetadataResponse {

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

@@ -1,16 +1,55 @@
-import Resource from '../../../Resource';
+import ReadServiceResource from '../ReadServiceResource';
 import { GetCreditUsageParams, SnowflakeCreditUsageModel, SnowflakeNetworkPolicyModel, SnowflakeReaderAccountEndpointModel, SnowflakeReaderAccountStatusModel, SnowflakeUserModel, SnowflakeUsersModel } from './SnowflakeInterfaces';
-export default class Snowflake extends Resource {
+export default class Snowflake extends ReadServiceResource {
     static baseUrl: string;
+    /**
+     * Get the details for all users from a Snowflake reader account.
+     */
     listUsers(): Promise<SnowflakeUsersModel>;
+    /**
+     * Create a new user within a Snowflake reader account.
+     */
     createUser(model: SnowflakeUserModel): Promise<SnowflakeUserModel>;
+    /**
+     * Delete a user from a Snowflake reader account.
+     *
+     * @param snowflakeUser The login name for the Snowflake user.
+     */
     deleteUser(snowflakeUser: string): Promise<void>;
+    /**
+     * Get the details for a specific user from a Snowflake reader account.
+     *
+     * @param snowflakeUser The login name for the Snowflake user.
+     */
     getUser(snowflakeUser: string): Promise<SnowflakeUserModel>;
+    /**
+     * Reset a user's password in a Snowflake reader account.
+     *
+     * @param snowflakeUser The login name for the Snowflake user.
+     */
     resetPassword(snowflakeUser: string): Promise<void>;
+    /**
+     * Get the details of the active network policy for a Snowflake reader account.
+     */
     getNetworkPolicy(): Promise<SnowflakeNetworkPolicyModel>;
+    /**
+     * Set the details of the active network policy for a Snowflake reader account.
+     */
     updateNetworkPolicy(model: SnowflakeNetworkPolicyModel): Promise<void>;
+    /**
+     * Get the amount of compute credits used by a Snowflake reader account within a date range.
+     */
     getCreditUsage(params: GetCreditUsageParams): Promise<SnowflakeCreditUsageModel>;
+    /**
+     * Retrieve Snowflake reader account state.
+     */
     getSnowflakeReaderAccount(): Promise<SnowflakeReaderAccountStatusModel>;
+    /**
+     * Retrieve Snowflake reader account endpoint.
+     */
     getSnowflakeReaderAccountEndpoint(): Promise<SnowflakeReaderAccountEndpointModel>;
+    /**
+     * Create a reader account.
+     */
     createSnowflakeReaderAccount(): Promise<void>;
 }

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

@@ -1,18 +1,20 @@
 import { SnowflakeReaderAccountStatus } from '../../../Enums';
+import { TimeRangeParamParts } from '../CommonParamParts';
 export interface SnowflakeUsersModel {
     snowflakeUsers: SnowflakeUserModel[];
 }
 export interface SnowflakeUserModel {
     /**
-     * The username of the user
+     * The username of the user.
      */
     username: string;
     /**
-     * The email of the user
+     * 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)
+     * The number of days that the user has access to the reader account.
+     * Ranging from 0 (indefinitely) to 90 days.
      */
     daysToExpiry?: number;
 }
@@ -20,30 +22,20 @@ 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 GetCreditUsageParams extends TimeRangeParamParts {
 }
 export interface SnowflakeCreditUsageModel {
     creditsUsed: number;
 }
 export interface SnowflakeReaderAccountStatusModel {
     /**
-     * The status of the create reader account request
+     * The status of the create reader account request.
      */
     snowflakeReaderAccountStatus: SnowflakeReaderAccountStatus;
 }
 export interface SnowflakeReaderAccountEndpointModel {
     /**
-     * The endpoint of the reader account
+     * The endpoint of the reader account.
      */
     endpoint: string;
 }