feat: add exports with a request body [UA-8951] (#859)

* feat: add exports with a request body [UA-8951]

* fix: add missing annotations, async/await in exports tests [UA-8951]

* fix: elaborated on annotations, added descriptions from Swagger, cleaned up interfaces [UA-8951]

* fix: address comments [UA-8951]

src/resources/Enums.ts

@@ -1066,7 +1066,7 @@ export enum ExportStatus {
     expired = 'EXPIRED',
 }
 
-export enum ExportTablesType {
+export enum ExportTables {
     searches = 'SEARCHES',
     clicks = 'CLICKS',
     customEvents = 'CUSTOM_EVENTS',

src/resources/UsageAnalytics/Read/Exports/Exports.ts

@@ -9,7 +9,9 @@ import {
     ExportModel,
     ExportScheduleModel,
     GenerateExportParams,
+    GenerateExportWithBodyParams,
     GenerateVisitExportParams,
+    GenerateVisitExportWithBodyParams,
     RowLimitModel,
 } from './ExportsInterfaces.js';
 
@@ -25,11 +27,22 @@ export default class Exports extends ReadServiceResource implements ReadServiceH
 
     /**
      * Generate an export.
+     *
+     * @param params The parameters to generate the export with.
      */
     generate(params: GenerateExportParams) {
         return this.api.post<ExportModel>(this.buildPathWithOrg(Exports.baseUrl, params));
     }
 
+    /**
+     * Generate an export with the parameters in the request body.
+     *
+     * @param params The parameters to generate the export with, passed in the request body.
+     */
+    generateExportWithBody(params: GenerateExportWithBodyParams, args?: RequestInit) {
+        return this.api.post<ExportModel>(this.buildPathWithOrg(`${Exports.baseUrl}/create`), params, args);
+    }
+
     /**
      * Get information on an export.
      *
@@ -60,20 +73,35 @@ export default class Exports extends ReadServiceResource implements ReadServiceH
 
     /**
      * Estimate the number of rows in an export.
+     *
+     * @param params The date range and other parameters for the export.
      */
     estimateRowsCount(params: EstimateExportParams) {
         return this.api.get<ExportEstimateModel>(this.buildPathWithOrg(`${Exports.baseUrl}/estimate`, params));
     }
 
     /**
      * Generate a visit export.
+     *
+     * @param params The parameters to generate the visit export with.
      */
     generateVisitExport(params: GenerateVisitExportParams) {
         return this.api.post<ExportModel>(this.buildPathWithOrg(`${Exports.baseUrl}/visits`, params));
     }
 
+    /**
+     * Generate a visit export with the parameters in the request body.
+     *
+     * @param params The parameters to generate the visit export with, passed in the request body.
+     */
+    generateVisitExportWithBody(params: GenerateVisitExportWithBodyParams, args?: RequestInit) {
+        return this.api.post<ExportModel>(this.buildPathWithOrg(`${Exports.baseUrl}/visits/create`), params, args);
+    }
+
     /**
      * Estimate the number of rows in a visit export.
+     *
+     * @param params The parameters of the visit export to estimate.
      */
     estimateVisitExportRowsCount(params: EstimateVisitExportParams) {
         return this.api.get<ExportEstimateModel>(this.buildPathWithOrg(`${Exports.baseUrl}/visits/estimate`, params));
@@ -88,6 +116,8 @@ export default class Exports extends ReadServiceResource implements ReadServiceH
 
     /**
      * Create an export schedule.
+     *
+     * @param model The export schedule to create.
      */
     createSchedule(model: CreateExportScheduleModel) {
         return this.api.post<ExportScheduleModel>(this.buildPathWithOrg(`${Exports.baseUrl}/schedules`), model);

src/resources/UsageAnalytics/Read/Exports/ExportsInterfaces.ts

@@ -1,4 +1,4 @@
-import {CSVFileFormat, DayOfWeek, ExportScheduleFrequency, ExportStatus, ExportTablesType} from '../../../Enums.js';
+import {CSVFileFormat, DayOfWeek, ExportScheduleFrequency, ExportStatus, ExportTables} from '../../../Enums.js';
 import {
     EventDimensionsExcludeFilterParamParts,
     EventDimensionsFilterParamParts,
@@ -45,7 +45,7 @@ export interface EstimateExportParams extends TimeRangeParamParts, EventDimensio
      * The tables that will be included.
      * If not provided, all tables will be included.
      */
-    tables?: ExportTablesType[];
+    tables?: ExportTables[];
     /**
      * The filter that will be applied to the click and search events dimensions.
      * Multiple filter parameters are joined with the AND operator.
@@ -87,10 +87,89 @@ export interface GenerateExportParams extends EstimateExportParams {
     useDisplayNames?: boolean;
 }
 
+interface BaseGenerateExportWithBodyParams {
+    /**
+     * The beginning of the date range, in ISO8601 format (`YYYY-MM-DDThh:mm:ss.sssZ`).
+     */
+    from: string;
+    /**
+     * The end of the date range, in ISO8601 format (`YYYY-MM-DDThh:mm:ss.sssZ`).
+     */
+    to: string;
+    /**
+     * The file name to use for the export. Can only contain US-ASCII characters. By default, the export ID is used.
+     */
+    filename?: string;
+    /**
+     * An optional description for the export.
+     */
+    description?: string;
+    /**
+     * The dimensions to export. By default, all dimensions are exported.
+     */
+    dimensions?: string[];
+    /**
+     * The format of the generated CSV files. Defaults to `Excel`.
+     */
+    exportFormat?: CSVFileFormat;
+    /**
+     * Whether to use the display names in the export's header. Defaults to `false`, meaning that the API names are used by default.
+     */
+    useDisplayNames?: boolean;
+}
+
+export interface GenerateExportWithBodyParams extends BaseGenerateExportWithBodyParams {
+    /**
+     * The filters to apply to dimensions shared by all types of events.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    commonFilters?: string[];
+    /**
+     * The filters to apply to the dimensions of click and search events only.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    searchesFilters?: string[];
+    /**
+     * The filters to apply to the dimensions of custom events only.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    customEventsFilters?: string[];
+    /**
+     * The tables to export. By default, all tables are exported.
+     */
+    tables?: ExportTables[];
+}
+
+export interface GenerateVisitExportWithBodyParams extends BaseGenerateExportWithBodyParams {
+    /**
+     * The filter that will be applied to the events dimensions.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    inclusionFilters?: string[];
+    /**
+     * Each specified filter is inverted in order to hide events.
+     * Multiple filter parameters are joined with the AND operator.
+     */
+    hideEventFilters?: string[];
+    /**
+     * The filter that will be applied to dimensions to exclude events from the results.
+     * Multiple filter parameters are joined with the AND operator.
+     * The exclusion filter has precedence over the inclusion filter.
+     */
+    exclusionFilters?: string[];
+    /**
+     * Whether to order the rows by datetime in the export.
+     * If there are a large number of rows to export, this parameter will be ignored and the data will be unsorted.
+     * Defaults to `true`.
+     */
+    ordered?: 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.
+     * If there are a large number of rows to export, this parameter will be ignored and the data will be unsorted.
+     * Defaults to `true`.
      */
     ordered?: boolean;
 }
@@ -118,7 +197,7 @@ export interface CreateExportScheduleModel extends ExportScheduleModelCommonProp
     searchesFilters?: string[];
     customEventsFilters?: string[];
     description?: string;
-    tables?: ExportTablesType[];
+    tables?: ExportTables[];
     exportFormat?: CSVFileFormat;
 }