@ricado/api-client 2.3.2 → 2.3.5

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.
@@ -1920,6 +1920,8 @@ var _default = PackrunController;
1920
1920
  * @property {string} [growerName] The Grower Name for this Packrun
1921
1921
  * @property {string} [growerCode] The Grower Code for this Packrun
1922
1922
  * @property {string} [maturityArea] The Maturity Area for this Packrun
1923
+ * @property {?Date} [startTimestamp] When this Packrun was Started
1924
+ * @property {?Date} [finishTimestamp] When this Packrun was Finished
1923
1925
  * @property {string} [varietyId] The Variety for this Packrun
1924
1926
  * @property {?string} [growingMethodId] The Growing Method for this Packrun
1925
1927
  * @property {?number} [freshPackGraderId] The FreshPack Grader ID associated with this Packrun
@@ -852,6 +852,8 @@ var _default = ShiftController;
852
852
  * @property {?Date} [finishTimestamp] When this Shift was Finished
853
853
  * @property {?Date} [publishTimestamp] When this Shift was Published
854
854
  * @property {?number} [satisfactionRating] An Optional Rating between 1 and 10 on how Satisfied the Line Manager was with this Shift
855
+ * @property {?string} [keyCelebration] An Optional Key Celebration the Line Manager and Team experienced during this Shift
856
+ * @property {?string} [keyChallenge] An Optional Key Challenge the Line Manager and Team experienced during this Shift
855
857
  * @property {Array<ShiftController.ShiftHandoverNote>} [handoverNotes] *DEPRECATED* An Optional Array of Handover Notes for this Shift
856
858
  * @property {Array<ShiftController.ShiftAreaNote>} [areaNotes] An Optional Array of Notes for this Shift
857
859
  * @property {ShiftController.ShiftSchedule} schedule The Schedule for this Shift
@@ -874,6 +876,8 @@ var _default = ShiftController;
874
876
  * @property {?Date} [finishTimestamp] When this Shift was Finished
875
877
  * @property {?Date} [publishTimestamp] When this Shift was Published
876
878
  * @property {?number} [satisfactionRating] An Optional Rating between 1 and 10 on how Satisfied the Line Manager was with this Shift
879
+ * @property {?string} [keyCelebration] An Optional Key Celebration the Line Manager and Team experienced during this Shift
880
+ * @property {?string} [keyChallenge] An Optional Key Challenge the Line Manager and Team experienced during this Shift
877
881
  * @property {Array<ShiftController.ShiftHandoverNote>} [handoverNotes] *DEPRECATED* An Optional Array of Handover Notes for this Shift
878
882
  * @property {Array<ShiftController.ShiftAreaNote>} [areaNotes] An Optional Array of Notes for this Shift
879
883
  * @property {ShiftController.ShiftSchedule} [schedule] The Schedule for this Shift
@@ -824,7 +824,7 @@ var _default = ShiftQualitySummaryController;
824
824
  * @typedef {Object} ShiftQualitySummaryController.GetAllQueryParameters
825
825
  * @property {string} [packingLineId] The Packing Line ID this Quality Summary is associated with
826
826
  * @property {string} [shiftId] The Shift ID this Quality Summary is asssociated with
827
- * @property {?string} [qualityManagerUserId] The User ID of the Quality Manager for this Summary
827
+ * @property {string} [qualityManagerUserId] The User ID of the Quality Manager for this Summary
828
828
  * @property {string} [qualityManagerName] The Name of the Quality Manager for this Summary
829
829
  * @property {Date} [createdTimestampBegin] Filter by the Timestamp when Quality Summaries were Created. Results Greater than or Equal to Timestamp
830
830
  * @property {Date} [createdTimestampEnd] Filter by the Timestamp when Quality Summaries were Created. Results Less than or Equal to Timestamp
@@ -841,7 +841,7 @@ var _default = ShiftQualitySummaryController;
841
841
  * @property {string} [shiftId] The Shift ID this Quality Summary is asssociated with
842
842
  * @property {Date} [createdTimestamp] When this Quality Summary was Created
843
843
  * @property {?Date} [publishTimestamp] When this Quality Summary was Published
844
- * @property {?string} [qualityManagerUserId] The User ID of the Quality Manager for this Summary
844
+ * @property {string} qualityManagerUserId The User ID of the Quality Manager for this Summary
845
845
  * @property {string} qualityManagerName The Name of the Quality Manager for this Summary
846
846
  * @property {Array<ShiftQualitySummaryController.AccuracyResult>} [accuracyResults] An Array of Accuracy Results for this Summary
847
847
  * @property {Array<ShiftQualitySummaryController.AuditResult>} [auditResults] An Array of Audit Results for this Summary
@@ -857,7 +857,7 @@ var _default = ShiftQualitySummaryController;
857
857
  * @property {string} [packingLineId] The Packing Line ID this Quality Summary is associated with
858
858
  * @property {Date} [createdTimestamp] When this Quality Summary was Created
859
859
  * @property {?Date} [publishTimestamp] When this Quality Summary was Published
860
- * @property {?string} [qualityManagerUserId] The User ID of the Quality Manager for this Summary
860
+ * @property {string} [qualityManagerUserId] The User ID of the Quality Manager for this Summary
861
861
  * @property {string} [qualityManagerName] The Name of the Quality Manager for this Summary
862
862
  * @property {Array<ShiftQualitySummaryController.AccuracyResult>} [accuracyResults] An Array of Accuracy Results for this Summary
863
863
  * @property {Array<ShiftQualitySummaryController.AuditResult>} [auditResults] An Array of Audit Results for this Summary
@@ -824,6 +824,7 @@ var _default = ShiftTaskController;
824
824
  * @typedef {Object} ShiftTaskController.GetAllQueryParameters
825
825
  * @property {string} [packingLineId] The Packing Line ID this Task is associated with
826
826
  * @property {string} [shiftId] The Shift ID this Task is asssociated with
827
+ * @property {?Date} [completedTimestamp] When this Task was Completed
827
828
  * @property {?string} [authorUserId] The User ID of the Author for this Task
828
829
  * @property {string} [authorName] The Name of the Author for this Task
829
830
  * @property {string} [type] The Task Type
@@ -159,6 +159,22 @@ var ShiftModel = /*#__PURE__*/function (_BaseModel) {
159
159
  */
160
160
 
161
161
  _this.satisfactionRating = null;
162
+ /**
163
+ * An Optional Key Celebration the Line Manager and Team experienced during this Shift
164
+ *
165
+ * @type {?string}
166
+ * @public
167
+ */
168
+
169
+ _this.keyCelebration = null;
170
+ /**
171
+ * An Optional Key Challenge the Line Manager and Team experienced during this Shift
172
+ *
173
+ * @type {?string}
174
+ * @public
175
+ */
176
+
177
+ _this.keyChallenge = null;
162
178
  /**
163
179
  * *DEPRECATED* An Optional Array of Handover Notes for this Shift
164
180
  *
@@ -419,6 +435,34 @@ var ShiftModel = /*#__PURE__*/function (_BaseModel) {
419
435
  }();
420
436
  }
421
437
 
438
+ if ('keyCelebration' in jsonObject) {
439
+ model.keyCelebration = function () {
440
+ if (jsonObject['keyCelebration'] === null) {
441
+ return null;
442
+ }
443
+
444
+ if (typeof jsonObject['keyCelebration'] !== 'string') {
445
+ return String(jsonObject['keyCelebration']);
446
+ }
447
+
448
+ return jsonObject['keyCelebration'];
449
+ }();
450
+ }
451
+
452
+ if ('keyChallenge' in jsonObject) {
453
+ model.keyChallenge = function () {
454
+ if (jsonObject['keyChallenge'] === null) {
455
+ return null;
456
+ }
457
+
458
+ if (typeof jsonObject['keyChallenge'] !== 'string') {
459
+ return String(jsonObject['keyChallenge']);
460
+ }
461
+
462
+ return jsonObject['keyChallenge'];
463
+ }();
464
+ }
465
+
422
466
  if ('handoverNotes' in jsonObject) {
423
467
  model.handoverNotes = function () {
424
468
  if (Array.isArray(jsonObject['handoverNotes']) !== true) {
@@ -98,11 +98,11 @@ var ShiftQualitySummaryModel = /*#__PURE__*/function (_BaseModel) {
98
98
  /**
99
99
  * The User ID of the Quality Manager for this Summary
100
100
  *
101
- * @type {?string}
101
+ * @type {string}
102
102
  * @public
103
103
  */
104
104
 
105
- _this.qualityManagerUserId = null;
105
+ _this.qualityManagerUserId = "";
106
106
  /**
107
107
  * The Name of the Quality Manager for this Summary
108
108
  *
@@ -262,10 +262,6 @@ var ShiftQualitySummaryModel = /*#__PURE__*/function (_BaseModel) {
262
262
 
263
263
  if ('qualityManagerUserId' in jsonObject) {
264
264
  model.qualityManagerUserId = function () {
265
- if (jsonObject['qualityManagerUserId'] === null) {
266
- return null;
267
- }
268
-
269
265
  if (typeof jsonObject['qualityManagerUserId'] !== 'string') {
270
266
  return String(jsonObject['qualityManagerUserId']);
271
267
  }
@@ -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.2';
8
+ var version = '2.3.5';
9
9
  exports.version = version;
package/lib/index.d.ts CHANGED
@@ -8969,6 +8969,14 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackrunController'
8969
8969
  * The Maturity Area for this Packrun
8970
8970
  */
8971
8971
  maturityArea?: string;
8972
+ /**
8973
+ * When this Packrun was Started
8974
+ */
8975
+ startTimestamp?: Date | null;
8976
+ /**
8977
+ * When this Packrun was Finished
8978
+ */
8979
+ finishTimestamp?: Date | null;
8972
8980
  /**
8973
8981
  * The Variety for this Packrun
8974
8982
  */
@@ -10519,6 +10527,14 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftController' {
10519
10527
  * An Optional Rating between 1 and 10 on how Satisfied the Line Manager was with this Shift
10520
10528
  */
10521
10529
  satisfactionRating?: number | null;
10530
+ /**
10531
+ * An Optional Key Celebration the Line Manager and Team experienced during this Shift
10532
+ */
10533
+ keyCelebration?: string | null;
10534
+ /**
10535
+ * An Optional Key Challenge the Line Manager and Team experienced during this Shift
10536
+ */
10537
+ keyChallenge?: string | null;
10522
10538
  /**
10523
10539
  * DEPRECATED* An Optional Array of Handover Notes for this Shift
10524
10540
  */
@@ -10584,6 +10600,14 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftController' {
10584
10600
  * An Optional Rating between 1 and 10 on how Satisfied the Line Manager was with this Shift
10585
10601
  */
10586
10602
  satisfactionRating?: number | null;
10603
+ /**
10604
+ * An Optional Key Celebration the Line Manager and Team experienced during this Shift
10605
+ */
10606
+ keyCelebration?: string | null;
10607
+ /**
10608
+ * An Optional Key Challenge the Line Manager and Team experienced during this Shift
10609
+ */
10610
+ keyChallenge?: string | null;
10587
10611
  /**
10588
10612
  * DEPRECATED* An Optional Array of Handover Notes for this Shift
10589
10613
  */
@@ -11662,7 +11686,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftQualitySummar
11662
11686
  /**
11663
11687
  * The User ID of the Quality Manager for this Summary
11664
11688
  */
11665
- qualityManagerUserId?: string | null;
11689
+ qualityManagerUserId?: string;
11666
11690
  /**
11667
11691
  * The Name of the Quality Manager for this Summary
11668
11692
  */
@@ -11707,7 +11731,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftQualitySummar
11707
11731
  /**
11708
11732
  * The User ID of the Quality Manager for this Summary
11709
11733
  */
11710
- qualityManagerUserId?: string | null;
11734
+ qualityManagerUserId: string;
11711
11735
  /**
11712
11736
  * The Name of the Quality Manager for this Summary
11713
11737
  */
@@ -11748,7 +11772,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftQualitySummar
11748
11772
  /**
11749
11773
  * The User ID of the Quality Manager for this Summary
11750
11774
  */
11751
- qualityManagerUserId?: string | null;
11775
+ qualityManagerUserId?: string;
11752
11776
  /**
11753
11777
  * The Name of the Quality Manager for this Summary
11754
11778
  */
@@ -12030,6 +12054,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftTaskControlle
12030
12054
  * The Shift ID this Task is asssociated with
12031
12055
  */
12032
12056
  shiftId?: string;
12057
+ /**
12058
+ * When this Task was Completed
12059
+ */
12060
+ completedTimestamp?: Date | null;
12033
12061
  /**
12034
12062
  * The User ID of the Author for this Task
12035
12063
  */
@@ -15391,6 +15419,20 @@ declare module '@ricado/api-client/Models/Packhouse/Site/ShiftModel' {
15391
15419
  * @public
15392
15420
  */
15393
15421
  satisfactionRating: number | null;
15422
+ /**
15423
+ * An Optional Key Celebration the Line Manager and Team experienced during this Shift
15424
+ *
15425
+ * @type {?string}
15426
+ * @public
15427
+ */
15428
+ keyCelebration: string | null;
15429
+ /**
15430
+ * An Optional Key Challenge the Line Manager and Team experienced during this Shift
15431
+ *
15432
+ * @type {?string}
15433
+ * @public
15434
+ */
15435
+ keyChallenge: string | null;
15394
15436
  /**
15395
15437
  * *DEPRECATED* An Optional Array of Handover Notes for this Shift
15396
15438
  *
@@ -15525,10 +15567,10 @@ declare module '@ricado/api-client/Models/Packhouse/Site/ShiftQualitySummaryMode
15525
15567
  /**
15526
15568
  * The User ID of the Quality Manager for this Summary
15527
15569
  *
15528
- * @type {?string}
15570
+ * @type {string}
15529
15571
  * @public
15530
15572
  */
15531
- qualityManagerUserId: string | null;
15573
+ qualityManagerUserId: string;
15532
15574
  /**
15533
15575
  * The Name of the Quality Manager for this Summary
15534
15576
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ricado/api-client",
3
- "version": "2.3.2",
3
+ "version": "2.3.5",
4
4
  "description": "RICADO Gen 4 API Client Library for NodeJS and Browsers",
5
5
  "author": {
6
6
  "name": "Ash Neilson"
@@ -2380,6 +2380,8 @@ export default PackrunController;
2380
2380
  * @property {string} [growerName] The Grower Name for this Packrun
2381
2381
  * @property {string} [growerCode] The Grower Code for this Packrun
2382
2382
  * @property {string} [maturityArea] The Maturity Area for this Packrun
2383
+ * @property {?Date} [startTimestamp] When this Packrun was Started
2384
+ * @property {?Date} [finishTimestamp] When this Packrun was Finished
2383
2385
  * @property {string} [varietyId] The Variety for this Packrun
2384
2386
  * @property {?string} [growingMethodId] The Growing Method for this Packrun
2385
2387
  * @property {?number} [freshPackGraderId] The FreshPack Grader ID associated with this Packrun
@@ -985,6 +985,8 @@ export default ShiftController;
985
985
  * @property {?Date} [finishTimestamp] When this Shift was Finished
986
986
  * @property {?Date} [publishTimestamp] When this Shift was Published
987
987
  * @property {?number} [satisfactionRating] An Optional Rating between 1 and 10 on how Satisfied the Line Manager was with this Shift
988
+ * @property {?string} [keyCelebration] An Optional Key Celebration the Line Manager and Team experienced during this Shift
989
+ * @property {?string} [keyChallenge] An Optional Key Challenge the Line Manager and Team experienced during this Shift
988
990
  * @property {Array<ShiftController.ShiftHandoverNote>} [handoverNotes] *DEPRECATED* An Optional Array of Handover Notes for this Shift
989
991
  * @property {Array<ShiftController.ShiftAreaNote>} [areaNotes] An Optional Array of Notes for this Shift
990
992
  * @property {ShiftController.ShiftSchedule} schedule The Schedule for this Shift
@@ -1007,6 +1009,8 @@ export default ShiftController;
1007
1009
  * @property {?Date} [finishTimestamp] When this Shift was Finished
1008
1010
  * @property {?Date} [publishTimestamp] When this Shift was Published
1009
1011
  * @property {?number} [satisfactionRating] An Optional Rating between 1 and 10 on how Satisfied the Line Manager was with this Shift
1012
+ * @property {?string} [keyCelebration] An Optional Key Celebration the Line Manager and Team experienced during this Shift
1013
+ * @property {?string} [keyChallenge] An Optional Key Challenge the Line Manager and Team experienced during this Shift
1010
1014
  * @property {Array<ShiftController.ShiftHandoverNote>} [handoverNotes] *DEPRECATED* An Optional Array of Handover Notes for this Shift
1011
1015
  * @property {Array<ShiftController.ShiftAreaNote>} [areaNotes] An Optional Array of Notes for this Shift
1012
1016
  * @property {ShiftController.ShiftSchedule} [schedule] The Schedule for this Shift
@@ -957,7 +957,7 @@ export default ShiftQualitySummaryController;
957
957
  * @typedef {Object} ShiftQualitySummaryController.GetAllQueryParameters
958
958
  * @property {string} [packingLineId] The Packing Line ID this Quality Summary is associated with
959
959
  * @property {string} [shiftId] The Shift ID this Quality Summary is asssociated with
960
- * @property {?string} [qualityManagerUserId] The User ID of the Quality Manager for this Summary
960
+ * @property {string} [qualityManagerUserId] The User ID of the Quality Manager for this Summary
961
961
  * @property {string} [qualityManagerName] The Name of the Quality Manager for this Summary
962
962
  * @property {Date} [createdTimestampBegin] Filter by the Timestamp when Quality Summaries were Created. Results Greater than or Equal to Timestamp
963
963
  * @property {Date} [createdTimestampEnd] Filter by the Timestamp when Quality Summaries were Created. Results Less than or Equal to Timestamp
@@ -974,7 +974,7 @@ export default ShiftQualitySummaryController;
974
974
  * @property {string} [shiftId] The Shift ID this Quality Summary is asssociated with
975
975
  * @property {Date} [createdTimestamp] When this Quality Summary was Created
976
976
  * @property {?Date} [publishTimestamp] When this Quality Summary was Published
977
- * @property {?string} [qualityManagerUserId] The User ID of the Quality Manager for this Summary
977
+ * @property {string} qualityManagerUserId The User ID of the Quality Manager for this Summary
978
978
  * @property {string} qualityManagerName The Name of the Quality Manager for this Summary
979
979
  * @property {Array<ShiftQualitySummaryController.AccuracyResult>} [accuracyResults] An Array of Accuracy Results for this Summary
980
980
  * @property {Array<ShiftQualitySummaryController.AuditResult>} [auditResults] An Array of Audit Results for this Summary
@@ -990,7 +990,7 @@ export default ShiftQualitySummaryController;
990
990
  * @property {string} [packingLineId] The Packing Line ID this Quality Summary is associated with
991
991
  * @property {Date} [createdTimestamp] When this Quality Summary was Created
992
992
  * @property {?Date} [publishTimestamp] When this Quality Summary was Published
993
- * @property {?string} [qualityManagerUserId] The User ID of the Quality Manager for this Summary
993
+ * @property {string} [qualityManagerUserId] The User ID of the Quality Manager for this Summary
994
994
  * @property {string} [qualityManagerName] The Name of the Quality Manager for this Summary
995
995
  * @property {Array<ShiftQualitySummaryController.AccuracyResult>} [accuracyResults] An Array of Accuracy Results for this Summary
996
996
  * @property {Array<ShiftQualitySummaryController.AuditResult>} [auditResults] An Array of Audit Results for this Summary
@@ -957,6 +957,7 @@ export default ShiftTaskController;
957
957
  * @typedef {Object} ShiftTaskController.GetAllQueryParameters
958
958
  * @property {string} [packingLineId] The Packing Line ID this Task is associated with
959
959
  * @property {string} [shiftId] The Shift ID this Task is asssociated with
960
+ * @property {?Date} [completedTimestamp] When this Task was Completed
960
961
  * @property {?string} [authorUserId] The User ID of the Author for this Task
961
962
  * @property {string} [authorName] The Name of the Author for this Task
962
963
  * @property {string} [type] The Task Type
@@ -129,6 +129,22 @@ class ShiftModel extends BaseModel
129
129
  */
130
130
  this.satisfactionRating = null;
131
131
 
132
+ /**
133
+ * An Optional Key Celebration the Line Manager and Team experienced during this Shift
134
+ *
135
+ * @type {?string}
136
+ * @public
137
+ */
138
+ this.keyCelebration = null;
139
+
140
+ /**
141
+ * An Optional Key Challenge the Line Manager and Team experienced during this Shift
142
+ *
143
+ * @type {?string}
144
+ * @public
145
+ */
146
+ this.keyChallenge = null;
147
+
132
148
  /**
133
149
  * *DEPRECATED* An Optional Array of Handover Notes for this Shift
134
150
  *
@@ -426,6 +442,40 @@ class ShiftModel extends BaseModel
426
442
  }());
427
443
  }
428
444
 
445
+ if('keyCelebration' in jsonObject)
446
+ {
447
+ model.keyCelebration = (function(){
448
+ if(jsonObject['keyCelebration'] === null)
449
+ {
450
+ return null;
451
+ }
452
+
453
+ if(typeof jsonObject['keyCelebration'] !== 'string')
454
+ {
455
+ return String(jsonObject['keyCelebration']);
456
+ }
457
+
458
+ return jsonObject['keyCelebration'];
459
+ }());
460
+ }
461
+
462
+ if('keyChallenge' in jsonObject)
463
+ {
464
+ model.keyChallenge = (function(){
465
+ if(jsonObject['keyChallenge'] === null)
466
+ {
467
+ return null;
468
+ }
469
+
470
+ if(typeof jsonObject['keyChallenge'] !== 'string')
471
+ {
472
+ return String(jsonObject['keyChallenge']);
473
+ }
474
+
475
+ return jsonObject['keyChallenge'];
476
+ }());
477
+ }
478
+
429
479
  if('handoverNotes' in jsonObject)
430
480
  {
431
481
  model.handoverNotes = (function(){
@@ -68,10 +68,10 @@ class ShiftQualitySummaryModel extends BaseModel
68
68
  /**
69
69
  * The User ID of the Quality Manager for this Summary
70
70
  *
71
- * @type {?string}
71
+ * @type {string}
72
72
  * @public
73
73
  */
74
- this.qualityManagerUserId = null;
74
+ this.qualityManagerUserId = "";
75
75
 
76
76
  /**
77
77
  * The Name of the Quality Manager for this Summary
@@ -243,11 +243,6 @@ class ShiftQualitySummaryModel extends BaseModel
243
243
  if('qualityManagerUserId' in jsonObject)
244
244
  {
245
245
  model.qualityManagerUserId = (function(){
246
- if(jsonObject['qualityManagerUserId'] === null)
247
- {
248
- return null;
249
- }
250
-
251
246
  if(typeof jsonObject['qualityManagerUserId'] !== 'string')
252
247
  {
253
248
  return String(jsonObject['qualityManagerUserId']);
@@ -1,2 +1,2 @@
1
1
  // generated by genversion
2
- export const version = '2.3.2';
2
+ export const version = '2.3.5';