@dhis2/analytics 26.0.8 → 26.0.9

package/build/cjs/api/analytics/AnalyticsRequestPropertiesMixin.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _AnalyticsRequest = _interopRequireDefault(require("./AnalyticsRequest.js"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /* eslint no-console: 0 */
 
 /**
@@ -41,13 +38,14 @@ class extends base {
    */
   withParameters(params) {
     if (params) {
-      this.parameters = { ...this.parameters,
+      this.parameters = {
+        ...this.parameters,
         ...params
       };
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Sets the URL path for the request.
    * It appends the given path to the request's URL.
@@ -60,15 +58,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withPath('aggregate');
    */
-
-
   withPath(path) {
     if (path) {
       this.path = path;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Sets the response format for the request.
    * It appends the file extension to the request's path.
@@ -81,13 +77,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withFormat('xml');
    */
-
-
   withFormat() {
     let format = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'json';
     this.format = format;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the aggregationType query parameter to the request.
    *
@@ -99,21 +94,18 @@ class extends base {
    * const req = new analytics.request()
    *    .withAggregationType('SUM');
    */
-
-
   withAggregationType(value) {
     const aggregationType = value.toUpperCase();
     const aggregationTypes = new Set(['AVERAGE', 'AVERAGE_SUM_ORG_UNIT', 'COUNT', 'LAST', 'LAST_AVERAGE_ORG_UNIT', 'MIN', 'MAX', 'STDDEV', 'SUM', 'VARIANCE']);
-
     if (aggregationTypes.has(aggregationType)) {
       this.parameters.aggregationType = aggregationType;
     } else if (aggregationType !== 'DEFAULT') {
-      console.warn("analytics.request.withAggregationType(): \"".concat(value, "\" not listed as possible value"));
+      console.warn(`analytics.request.withAggregationType(): "${value}" not listed as possible value`);
       this.parameters.aggregationType = value;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the measureCriteria query parameter to the request.
    *
@@ -125,15 +117,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withMeasureCriteria('GE:10;LT:50');
    */
-
-
   withMeasureCriteria(criteria) {
     if (criteria) {
       this.parameters.measureCriteria = criteria;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the preAggregationMeasureCriteria query parameter to the request.
    *
@@ -145,15 +135,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withPreAggregationMeasureCriteria('GE:10;LT:50');
    */
-
-
   withPreAggregationMeasureCriteria(criteria) {
     if (criteria) {
       this.parameters.preAggregationMeasureCriteria = criteria;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the skipMeta query parameter to the request.
    *
@@ -165,13 +153,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withSkipMeta();
    */
-
-
   withSkipMeta() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.skipMeta = flag;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the skipData query parameter to the request.
    *
@@ -183,13 +170,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withSkipData();
    */
-
-
   withSkipData() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.skipData = flag;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the hierarchyMeta query parameter to the request.
    *
@@ -201,13 +187,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withHierarchyMeta();
    */
-
-
   withHierarchyMeta() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.hierarchyMeta = flag;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the ignoreLimit query parameter to the request.
    *
@@ -219,13 +204,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withIgnoreLimit();
    */
-
-
   withIgnoreLimit() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.ignoreLimit = flag;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the tableLayout query parameter to the request.
    *
@@ -237,13 +221,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withTableLayout();
    */
-
-
   withTableLayout() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.tableLayout = flag;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the hideEmptyRows query parameter to the request.
    *
@@ -255,13 +238,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withHideEmptyRows();
    */
-
-
   withHideEmptyRows() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.hideEmptyRows = flag;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the hideEmptyColumns query parameter to the request.
    *
@@ -273,13 +255,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withHideEmptyColumns();
    */
-
-
   withHideEmptyColumns() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.hideEmptyColumns = flag;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the showHierarchy query parameter to the request.
    *
@@ -291,13 +272,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withShowHierarchy();
    */
-
-
   withShowHierarchy() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.showHierarchy = flag;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the includeNumDen query parameter to the request.
    *
@@ -309,13 +289,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withIncludeNumDen();
    */
-
-
   withIncludeNumDen() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.includeNumDen = flag;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the includeMetadataDetails query parameter to the request.
    *
@@ -327,13 +306,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withIncludeMetadataDetails();
    */
-
-
   withIncludeMetadataDetails() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.includeMetadataDetails = flag;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the displayProperty query parameter to the request.
    *
@@ -345,21 +323,18 @@ class extends base {
    * const req = new analytics.request()
    *    .withDisplayProperty('SHORTNAME');
    */
-
-
   withDisplayProperty(value) {
     const displayProperty = value.toUpperCase();
     const displayProperties = new Set(['NAME', 'SHORTNAME']);
-
     if (displayProperties.has(displayProperty)) {
       this.parameters.displayProperty = displayProperty;
     } else {
-      console.warn("analytics.request.withDisplayProperty(): \"".concat(value, "\" not listed as possible value"));
+      console.warn(`analytics.request.withDisplayProperty(): "${value}" not listed as possible value`);
       this.parameters.displayProperty = value;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the displayProperty query parameter to the request.
    *
@@ -371,15 +346,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withDisplayProperty('SHORTNAME');
    */
-
-
   withOutputIdScheme(scheme) {
     if (scheme) {
       this.parameters.outputIdScheme = scheme;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the inputIdScheme query parameter to the request.
    *
@@ -391,15 +364,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withInputIdScheme('CODE');
    */
-
-
   withInputIdScheme(scheme) {
     if (scheme) {
       this.parameters.inputIdScheme = scheme;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the approvalLevel query parameter to the request.
    *
@@ -411,15 +382,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withApprovalLevel('');
    */
-
-
   withApprovalLevel(level) {
     if (level) {
       this.parameters.approvalLevel = level;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the relativePeriodDate query parameter to the request.
    *
@@ -431,15 +400,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withRelativePeriodDate('LAST_12_MONTHS');
    */
-
-
   withRelativePeriodDate(date) {
     if (date) {
       this.parameters.relativePeriodDate = date;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the userOrgUnit query parameter to the request.
    *
@@ -451,15 +418,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withUserOrgUnit('O6uvpzGd5pu');
    */
-
-
   withUserOrgUnit(orgUnit) {
     if (orgUnit) {
       this.parameters.userOrgUnit = orgUnit;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the columns query parameter to the request.
    *
@@ -471,15 +436,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withColumns('dx;ou');
    */
-
-
   withColumns(dimensions) {
     if (dimensions) {
       this.parameters.columns = dimensions;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the rows query parameter to the request.
    *
@@ -491,15 +454,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withRows('pe');
    */
-
-
   withRows(dimensions) {
     if (dimensions) {
       this.parameters.rows = dimensions;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the startDate query parameter to the request.
    *
@@ -511,15 +472,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withStartDate('2017-11-28');
    */
-
-
   withStartDate(date) {
     if (date) {
       this.parameters.startDate = date;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the endDate query parameter to the request.
    *
@@ -531,15 +490,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withEndDate('2017-12-31');
    */
-
-
   withEndDate(date) {
     if (date) {
       this.parameters.endDate = date;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Sets the program for the request.
    * It appends the program id to the request's path.
@@ -552,15 +509,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withProgram('eBAyeGv0exc');
    */
-
-
   withProgram(program) {
     if (program) {
       this.program = program;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the stage query parameter to the request.
    *
@@ -572,15 +527,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withStage('Zj7UnCAulEk');
    */
-
-
   withStage(stage) {
     if (stage) {
       this.parameters.stage = stage;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the eventStatus query parameter to the request.
    *
@@ -592,21 +545,18 @@ class extends base {
    * const req = new analytics.request()
    *    .withEventStatus('COMPLETED');
    */
-
-
   withEventStatus(value) {
     const eventStatus = value.toUpperCase();
     const eventStatuses = new Set(['ACTIVE', 'COMPLETED', 'SCHEDULED', 'OVERDUE', 'SKIPPED']);
-
     if (eventStatuses.has(eventStatus)) {
       this.parameters.eventStatus = eventStatus;
     } else {
-      console.warn("analytics.request.withEventStatus(): \"".concat(value, "\" not listed as possible value"));
+      console.warn(`analytics.request.withEventStatus(): "${value}" not listed as possible value`);
       this.parameters.eventStatus = value;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the programStatus query parameter to the request.
    *
@@ -618,21 +568,18 @@ class extends base {
    * const req = new analytics.request()
    *    .withProgramStatus('COMPLETED');
    */
-
-
   withProgramStatus(value) {
     const programStatus = value.toUpperCase();
     const programStatuses = new Set(['ACTIVE', 'COMPLETED', 'CANCELLED']);
-
     if (programStatuses.has(programStatus)) {
       this.parameters.programStatus = programStatus;
     } else {
-      console.warn("analytics.request.withProgramStatus(): \"".concat(value, "\" not listed as possible value"));
+      console.warn(`analytics.request.withProgramStatus(): "${value}" not listed as possible value`);
       this.parameters.programStatus = value;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the ouMode query parameter to the request.
    *
@@ -644,21 +591,18 @@ class extends base {
    * const req = new analytics.request()
    *    .withOuMode('CHILDREN');
    */
-
-
   withOuMode(value) {
     const ouMode = value.toUpperCase();
     const ouModes = new Set(['DESCENDANTS', 'CHILDREN', 'SELECTED']);
-
     if (ouModes.has(ouMode)) {
       this.parameters.ouMode = ouMode;
     } else {
-      console.warn("analytics.request.withOuMode(): \"".concat(value, "\" not listed as possible value"));
+      console.warn(`analytics.request.withOuMode(): "${value}" not listed as possible value`);
       this.parameters.ouMode = value;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the asc query parameter to the request.
    *
@@ -670,15 +614,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withAsc('EVENTDATE');
    */
-
-
   withAsc(value) {
     if (value) {
       this.parameters.asc = value;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the desc query parameter to the request.
    *
@@ -690,15 +632,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withDesc('OUNAME');
    */
-
-
   withDesc(value) {
     if (value) {
       this.parameters.desc = value;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the coordinatesOnly query parameter to the request.
    *
@@ -710,13 +650,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withCoordinatesOnly();
    */
-
-
   withCoordinatesOnly() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.coordinatesOnly = flag;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the page query parameter to the request.
    *
@@ -728,13 +667,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withPage(2);
    */
-
-
   withPage() {
     let page = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
     this.parameters.page = page;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the pageSize query parameter to the request.
    *
@@ -746,13 +684,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withPageSize(10);
    */
-
-
   withPageSize() {
     let size = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 50;
     this.parameters.pageSize = size;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the value query parameter to the request.
    *
@@ -764,16 +701,14 @@ class extends base {
    * const req = new analytics.request()
    *    .withValue('UXz7xuGCEhU');
    */
-
-
   withValue(value) {
     // must be a data element or attribute of numeric value type
     if (value) {
       this.parameters.value = value;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the sortOrder query parameter to the request.
    *
@@ -785,21 +720,18 @@ class extends base {
    * const req = new analytics.request()
    *    .withSortOrder('DESC');
    */
-
-
   withSortOrder(value) {
     const sortOrder = value.toUpperCase();
     const sortOrders = new Set(['ASC', 'DESC']);
-
     if (sortOrders.has(sortOrder)) {
       this.parameters.sortOrder = sortOrder;
     } else {
-      console.warn("analytics.request.withSortOrder(): \"".concat(value, "\" not listed as possible value"));
+      console.warn(`analytics.request.withSortOrder(): "${value}" not listed as possible value`);
       this.parameters.sortOrder = value;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the limit query parameter to the request.
    *
@@ -811,16 +743,14 @@ class extends base {
    * const req = new analytics.request()
    *    .withLimit('5000');
    */
-
-
   withLimit(value) {
     if (value) {
       const limit = value > 10000 ? 10000 : value;
       this.parameters.limit = limit;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the outputType query parameter to the request.
    *
@@ -832,21 +762,18 @@ class extends base {
    * const req = new analytics.request()
    *    .withOutputType('ENROLLMENT');
    */
-
-
   withOutputType(value) {
     const type = value.toUpperCase();
     const outputTypes = new Set(['EVENT', 'ENROLLMENT', 'TRACKED_ENTITY_INSTANCE']);
-
     if (outputTypes.has(type)) {
       this.parameters.outputType = type;
     } else {
-      console.warn("analytics.request.withOutputType(): \"".concat(value, "\" not listed as possible value"));
+      console.warn(`analytics.request.withOutputType(): "${value}" not listed as possible value`);
       this.parameters.outputType = value;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the collapseDataDimensions query parameter to the request.
    *
@@ -858,13 +785,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withCollapseDataDimensions();
    */
-
-
   withCollapseDataDimensions() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.collapseDataDimensions = flag;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the skipRounding query parameter to the request.
    *
@@ -876,13 +802,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withSkipRounding();
    */
-
-
   withSkipRounding() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.skipRounding = flag;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the aggregateData query parameter to the request.
    *
@@ -894,13 +819,12 @@ class extends base {
    * const req = new analytics.request()
    *    .withAggregateData();
    */
-
-
   withAggregateData() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.aggregateData = flag;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the clusterSize query parameter to the request.
    *
@@ -912,15 +836,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withClusterSize(1000);
    */
-
-
   withClusterSize(size) {
     if (size) {
       this.parameters.clusterSize = size;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the coordinateField query parameter to the request.
    *
@@ -932,14 +854,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withCoordinateField('<attribute-id>');
    */
-
-
   withCoordinateField() {
     let field = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'EVENT';
     // EVENT, <attribute-id>, <dataelement-id>
     this.parameters.coordinateField = field;
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the bbox query parameter to the request.
    *
@@ -951,15 +872,13 @@ class extends base {
    * const req = new analytics.request()
    *    .withBbox('11.1768827285209, 60.141691309755, 11.1694071634997, 60.287796722512');
    */
-
-
   withBbox(bbox) {
     if (bbox) {
       this.parameters.bbox = bbox;
     }
-
     return new _AnalyticsRequest.default(this);
   }
+
   /**
    * Adds the includeClusterPoints query parameter to the request.
    *
@@ -971,15 +890,11 @@ class extends base {
    * const req = new analytics.request()
    *    .withIncludeClusterPoints();
    */
-
-
   withIncludeClusterPoints() {
     let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     this.parameters.includeClusterPoints = flag;
     return new _AnalyticsRequest.default(this);
   }
-
 };
-
 var _default = AnalyticsRequestPropertiesMixin;
 exports.default = _default;