ultracart_rest_api_v2_typescript 4.0.177 → 4.0.178

package/.openapi-generator/FILES

@@ -666,6 +666,7 @@ src/models/ReportDataSetColumn.ts
 src/models/ReportDataSetPage.ts
 src/models/ReportDataSetPageResponse.ts
 src/models/ReportDataSetQuery.ts
+src/models/ReportDataSetQueryOrderByColumn.ts
 src/models/ReportDataSetResponse.ts
 src/models/ReportDataSetRow.ts
 src/models/ReportDataSetSchema.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.177
+## ultracart_rest_api_v2_typescript@4.0.178
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.0.177 --save
+npm install ultracart_rest_api_v2_typescript@4.0.178 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.178 | 09/22/2023 | dwbi - new option to control order-by of result set |
 | 4.0.177 | 09/15/2023 | new item fields for additional barcodes |
 | 4.0.176 | 09/12/2023 | added oids to customer properties |
 | 4.0.175 | 09/06/2023 | esp condition for survey trigger |

package/dist/models/ReportDataSetQuery.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ReportDataSetQueryOrderByColumn } from './ReportDataSetQueryOrderByColumn';
 import { ReportDataSource } from './ReportDataSource';
 import { ReportFilter } from './ReportFilter';
 import { ReportPageVisualizationDimension } from './ReportPageVisualizationDimension';
@@ -67,6 +68,12 @@ export interface ReportDataSetQuery {
      * @memberof ReportDataSetQuery
      */
     metrics?: Array<ReportPageVisualizationMetric>;
+    /**
+     * The columns to order by in the final result.  If not specified the dimensions will be used
+     * @type {Array<ReportDataSetQueryOrderByColumn>}
+     * @memberof ReportDataSetQuery
+     */
+    order_by_columns?: Array<ReportDataSetQueryOrderByColumn>;
     /**
      * Result set page size.  The default value is 200 records.  Max is 10000.
      * @type {number}

package/dist/models/ReportDataSetQuery.js

@@ -15,6 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReportDataSetQueryToJSON = exports.ReportDataSetQueryFromJSONTyped = exports.ReportDataSetQueryFromJSON = exports.ReportDataSetQueryForObjectTypeEnum = void 0;
 var runtime_1 = require("../runtime");
+var ReportDataSetQueryOrderByColumn_1 = require("./ReportDataSetQueryOrderByColumn");
 var ReportDataSource_1 = require("./ReportDataSource");
 var ReportFilter_1 = require("./ReportFilter");
 var ReportPageVisualizationDimension_1 = require("./ReportPageVisualizationDimension");
@@ -44,6 +45,7 @@ function ReportDataSetQueryFromJSONTyped(json, ignoreDiscriminator) {
         'for_object_id': !(0, runtime_1.exists)(json, 'for_object_id') ? undefined : json['for_object_id'],
         'for_object_type': !(0, runtime_1.exists)(json, 'for_object_type') ? undefined : json['for_object_type'],
         'metrics': !(0, runtime_1.exists)(json, 'metrics') ? undefined : (json['metrics'].map(ReportPageVisualizationMetric_1.ReportPageVisualizationMetricFromJSON)),
+        'order_by_columns': !(0, runtime_1.exists)(json, 'order_by_columns') ? undefined : (json['order_by_columns'].map(ReportDataSetQueryOrderByColumn_1.ReportDataSetQueryOrderByColumnFromJSON)),
         'page_size': !(0, runtime_1.exists)(json, 'page_size') ? undefined : json['page_size'],
         'selected_filters': !(0, runtime_1.exists)(json, 'selected_filters') ? undefined : (json['selected_filters'].map(ReportFilter_1.ReportFilterFromJSON)),
         'skip_cache': !(0, runtime_1.exists)(json, 'skip_cache') ? undefined : json['skip_cache'],
@@ -67,6 +69,7 @@ function ReportDataSetQueryToJSON(value) {
         'for_object_id': value.for_object_id,
         'for_object_type': value.for_object_type,
         'metrics': value.metrics === undefined ? undefined : (value.metrics.map(ReportPageVisualizationMetric_1.ReportPageVisualizationMetricToJSON)),
+        'order_by_columns': value.order_by_columns === undefined ? undefined : (value.order_by_columns.map(ReportDataSetQueryOrderByColumn_1.ReportDataSetQueryOrderByColumnToJSON)),
         'page_size': value.page_size,
         'selected_filters': value.selected_filters === undefined ? undefined : (value.selected_filters.map(ReportFilter_1.ReportFilterToJSON)),
         'skip_cache': value.skip_cache,

package/dist/models/ReportDataSetQueryOrderByColumn.d.ts

@@ -0,0 +1,33 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ReportDataSetQueryOrderByColumn
+ */
+export interface ReportDataSetQueryOrderByColumn {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ReportDataSetQueryOrderByColumn
+     */
+    ascending?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportDataSetQueryOrderByColumn
+     */
+    column_name?: string;
+}
+export declare function ReportDataSetQueryOrderByColumnFromJSON(json: any): ReportDataSetQueryOrderByColumn;
+export declare function ReportDataSetQueryOrderByColumnFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportDataSetQueryOrderByColumn;
+export declare function ReportDataSetQueryOrderByColumnToJSON(value?: ReportDataSetQueryOrderByColumn | null): any;

package/dist/models/ReportDataSetQueryOrderByColumn.js

@@ -0,0 +1,44 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportDataSetQueryOrderByColumnToJSON = exports.ReportDataSetQueryOrderByColumnFromJSONTyped = exports.ReportDataSetQueryOrderByColumnFromJSON = void 0;
+var runtime_1 = require("../runtime");
+function ReportDataSetQueryOrderByColumnFromJSON(json) {
+    return ReportDataSetQueryOrderByColumnFromJSONTyped(json, false);
+}
+exports.ReportDataSetQueryOrderByColumnFromJSON = ReportDataSetQueryOrderByColumnFromJSON;
+function ReportDataSetQueryOrderByColumnFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'ascending': !(0, runtime_1.exists)(json, 'ascending') ? undefined : json['ascending'],
+        'column_name': !(0, runtime_1.exists)(json, 'column_name') ? undefined : json['column_name'],
+    };
+}
+exports.ReportDataSetQueryOrderByColumnFromJSONTyped = ReportDataSetQueryOrderByColumnFromJSONTyped;
+function ReportDataSetQueryOrderByColumnToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'ascending': value.ascending,
+        'column_name': value.column_name,
+    };
+}
+exports.ReportDataSetQueryOrderByColumnToJSON = ReportDataSetQueryOrderByColumnToJSON;

package/dist/models/index.d.ts

@@ -640,6 +640,7 @@ export * from './ReportDataSetColumn';
 export * from './ReportDataSetPage';
 export * from './ReportDataSetPageResponse';
 export * from './ReportDataSetQuery';
+export * from './ReportDataSetQueryOrderByColumn';
 export * from './ReportDataSetResponse';
 export * from './ReportDataSetRow';
 export * from './ReportDataSetSchema';

package/dist/models/index.js

@@ -658,6 +658,7 @@ __exportStar(require("./ReportDataSetColumn"), exports);
 __exportStar(require("./ReportDataSetPage"), exports);
 __exportStar(require("./ReportDataSetPageResponse"), exports);
 __exportStar(require("./ReportDataSetQuery"), exports);
+__exportStar(require("./ReportDataSetQueryOrderByColumn"), exports);
 __exportStar(require("./ReportDataSetResponse"), exports);
 __exportStar(require("./ReportDataSetRow"), exports);
 __exportStar(require("./ReportDataSetSchema"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.0.177",
+  "version": "4.0.178",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/models/ReportDataSetQuery.ts

@@ -13,6 +13,12 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import {
+    ReportDataSetQueryOrderByColumn,
+    ReportDataSetQueryOrderByColumnFromJSON,
+    ReportDataSetQueryOrderByColumnFromJSONTyped,
+    ReportDataSetQueryOrderByColumnToJSON,
+} from './ReportDataSetQueryOrderByColumn';
 import {
     ReportDataSource,
     ReportDataSourceFromJSON,
@@ -92,6 +98,12 @@ export interface ReportDataSetQuery {
      * @memberof ReportDataSetQuery
      */
     metrics?: Array<ReportPageVisualizationMetric>;
+    /**
+     * The columns to order by in the final result.  If not specified the dimensions will be used
+     * @type {Array<ReportDataSetQueryOrderByColumn>}
+     * @memberof ReportDataSetQuery
+     */
+    order_by_columns?: Array<ReportDataSetQueryOrderByColumn>;
     /**
      * Result set page size.  The default value is 200 records.  Max is 10000.
      * @type {number}
@@ -148,6 +160,7 @@ export function ReportDataSetQueryFromJSONTyped(json: any, ignoreDiscriminator:
         'for_object_id': !exists(json, 'for_object_id') ? undefined : json['for_object_id'],
         'for_object_type': !exists(json, 'for_object_type') ? undefined : json['for_object_type'],
         'metrics': !exists(json, 'metrics') ? undefined : ((json['metrics'] as Array<any>).map(ReportPageVisualizationMetricFromJSON)),
+        'order_by_columns': !exists(json, 'order_by_columns') ? undefined : ((json['order_by_columns'] as Array<any>).map(ReportDataSetQueryOrderByColumnFromJSON)),
         'page_size': !exists(json, 'page_size') ? undefined : json['page_size'],
         'selected_filters': !exists(json, 'selected_filters') ? undefined : ((json['selected_filters'] as Array<any>).map(ReportFilterFromJSON)),
         'skip_cache': !exists(json, 'skip_cache') ? undefined : json['skip_cache'],
@@ -172,6 +185,7 @@ export function ReportDataSetQueryToJSON(value?: ReportDataSetQuery | null): any
         'for_object_id': value.for_object_id,
         'for_object_type': value.for_object_type,
         'metrics': value.metrics === undefined ? undefined : ((value.metrics as Array<any>).map(ReportPageVisualizationMetricToJSON)),
+        'order_by_columns': value.order_by_columns === undefined ? undefined : ((value.order_by_columns as Array<any>).map(ReportDataSetQueryOrderByColumnToJSON)),
         'page_size': value.page_size,
         'selected_filters': value.selected_filters === undefined ? undefined : ((value.selected_filters as Array<any>).map(ReportFilterToJSON)),
         'skip_cache': value.skip_cache,

package/src/models/ReportDataSetQueryOrderByColumn.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ReportDataSetQueryOrderByColumn
+ */
+export interface ReportDataSetQueryOrderByColumn {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ReportDataSetQueryOrderByColumn
+     */
+    ascending?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReportDataSetQueryOrderByColumn
+     */
+    column_name?: string;
+}
+
+export function ReportDataSetQueryOrderByColumnFromJSON(json: any): ReportDataSetQueryOrderByColumn {
+    return ReportDataSetQueryOrderByColumnFromJSONTyped(json, false);
+}
+
+export function ReportDataSetQueryOrderByColumnFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportDataSetQueryOrderByColumn {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'ascending': !exists(json, 'ascending') ? undefined : json['ascending'],
+        'column_name': !exists(json, 'column_name') ? undefined : json['column_name'],
+    };
+}
+
+export function ReportDataSetQueryOrderByColumnToJSON(value?: ReportDataSetQueryOrderByColumn | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'ascending': value.ascending,
+        'column_name': value.column_name,
+    };
+}
+

package/src/models/index.ts

@@ -642,6 +642,7 @@ export * from './ReportDataSetColumn';
 export * from './ReportDataSetPage';
 export * from './ReportDataSetPageResponse';
 export * from './ReportDataSetQuery';
+export * from './ReportDataSetQueryOrderByColumn';
 export * from './ReportDataSetResponse';
 export * from './ReportDataSetRow';
 export * from './ReportDataSetSchema';