@ricado/api-client 2.3.13 → 2.3.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -37,11 +37,18 @@ var ProductionDataExportController = /*#__PURE__*/function () {
37
37
  *
38
38
  * @static
39
39
  * @public
40
+ * @param {Date} dateBegin The Beginning Date of the Production Data Export
41
+ * @param {Date} dateEnd The End Date of the Production Data Export
42
+ * @param {ProductionDataExportController.JsonExportQueryParameters} [queryParameters] The Optional Query Parameters
40
43
  * @return {Promise<ProductionDataExportController.ProductionData>}
41
44
  */
42
- function jsonExport() {
45
+ function jsonExport(dateBegin, dateEnd) {
46
+ var queryParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
43
47
  return new Promise(function (resolve, reject) {
44
- _RequestHelper.default.getRequest("/packhouse/production-data-export").then(function (result) {
48
+ _RequestHelper.default.getRequest("/packhouse/production-data-export", Object.assign(queryParameters, {
49
+ dateBegin: dateBegin,
50
+ dateEnd: dateEnd
51
+ })).then(function (result) {
45
52
  var resolveValue = function () {
46
53
  var resultObject = {};
47
54
 
@@ -3788,6 +3795,15 @@ var ProductionDataExportController = /*#__PURE__*/function () {
3788
3795
  }();
3789
3796
 
3790
3797
  var _default = ProductionDataExportController;
3798
+ /**
3799
+ * The Optional Query Parameters for the jsonExport Function
3800
+ *
3801
+ * @typedef {Object} ProductionDataExportController.JsonExportQueryParameters
3802
+ * @property {number[]} [siteIds] A List of Site IDs to Filter by
3803
+ * @property {string[]} [packingLineIds] A List of Packing Line IDs to Filter by
3804
+ * @memberof Controllers.Packhouse
3805
+ */
3806
+
3791
3807
  /**
3792
3808
  * A **PackrunData** Type
3793
3809
  *
@@ -5,5 +5,5 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports.version = void 0;
7
7
  // Generated by genversion.
8
- var version = '2.3.13';
8
+ var version = '2.3.14';
9
9
  exports.version = version;
package/lib/index.d.ts CHANGED
@@ -3145,9 +3145,12 @@ declare module '@ricado/api-client/Controllers/Packhouse/ProductionDataExportCon
3145
3145
  *
3146
3146
  * @static
3147
3147
  * @public
3148
+ * @param {Date} dateBegin The Beginning Date of the Production Data Export
3149
+ * @param {Date} dateEnd The End Date of the Production Data Export
3150
+ * @param {ProductionDataExportController.JsonExportQueryParameters} [queryParameters] The Optional Query Parameters
3148
3151
  * @return {Promise<ProductionDataExportController.ProductionData>}
3149
3152
  */
3150
- static jsonExport(): Promise<ProductionDataExportController.ProductionData>;
3153
+ static jsonExport(dateBegin: Date, dateEnd: Date, queryParameters?: ProductionDataExportController.JsonExportQueryParameters | undefined): Promise<ProductionDataExportController.ProductionData>;
3151
3154
  /**
3152
3155
  * Retrieve Production Data as an Excel Spreadsheet [GET /packhouse/production-data-export/excel]
3153
3156
  *
@@ -3170,6 +3173,19 @@ declare module '@ricado/api-client/Controllers/Packhouse/ProductionDataExportCon
3170
3173
  static csvExport(): Promise<boolean>;
3171
3174
  }
3172
3175
  namespace ProductionDataExportController {
3176
+ /**
3177
+ * The Optional Query Parameters for the jsonExport Function
3178
+ */
3179
+ export type JsonExportQueryParameters = {
3180
+ /**
3181
+ * A List of Site IDs to Filter by
3182
+ */
3183
+ siteIds?: number[];
3184
+ /**
3185
+ * A List of Packing Line IDs to Filter by
3186
+ */
3187
+ packingLineIds?: string[];
3188
+ };
3173
3189
  /**
3174
3190
  * A **PackrunData** Type
3175
3191
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ricado/api-client",
3
- "version": "2.3.13",
3
+ "version": "2.3.14",
4
4
  "description": "RICADO Gen 4 API Client Library for NodeJS and Browsers",
5
5
  "author": {
6
6
  "name": "Ash Neilson"
@@ -20,12 +20,15 @@ class ProductionDataExportController
20
20
  *
21
21
  * @static
22
22
  * @public
23
+ * @param {Date} dateBegin The Beginning Date of the Production Data Export
24
+ * @param {Date} dateEnd The End Date of the Production Data Export
25
+ * @param {ProductionDataExportController.JsonExportQueryParameters} [queryParameters] The Optional Query Parameters
23
26
  * @return {Promise<ProductionDataExportController.ProductionData>}
24
27
  */
25
- static jsonExport()
28
+ static jsonExport(dateBegin, dateEnd, queryParameters = {})
26
29
  {
27
30
  return new Promise((resolve, reject) => {
28
- RequestHelper.getRequest(`/packhouse/production-data-export`)
31
+ RequestHelper.getRequest(`/packhouse/production-data-export`, Object.assign(queryParameters, {dateBegin, dateEnd}))
29
32
  .then((result) => {
30
33
  let resolveValue = (function(){
31
34
  let resultObject = {};
@@ -4931,6 +4934,15 @@ class ProductionDataExportController
4931
4934
 
4932
4935
  export default ProductionDataExportController;
4933
4936
 
4937
+ /**
4938
+ * The Optional Query Parameters for the jsonExport Function
4939
+ *
4940
+ * @typedef {Object} ProductionDataExportController.JsonExportQueryParameters
4941
+ * @property {number[]} [siteIds] A List of Site IDs to Filter by
4942
+ * @property {string[]} [packingLineIds] A List of Packing Line IDs to Filter by
4943
+ * @memberof Controllers.Packhouse
4944
+ */
4945
+
4934
4946
  /**
4935
4947
  * A **PackrunData** Type
4936
4948
  *
@@ -1,2 +1,2 @@
1
1
  // Generated by genversion.
2
- export const version = '2.3.13';
2
+ export const version = '2.3.14';