@ricado/api-client 1.3.0 → 2.0.1

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.
Files changed (139) hide show
  1. package/dist/ricado.api.client.js +1 -1
  2. package/lib/Controllers/Packhouse/Site/BinTipWeightController.js +4 -4
  3. package/lib/Controllers/Packhouse/Site/CompacSizerBatchController.js +4 -4
  4. package/lib/Controllers/Packhouse/Site/CompacSizerController.js +4 -4
  5. package/lib/Controllers/Packhouse/Site/CompacSizerOutletProductChangeController.js +4 -4
  6. package/lib/Controllers/Packhouse/Site/CompacSizerOutletTypeChangeController.js +4 -4
  7. package/lib/Controllers/Packhouse/Site/CompacSizerOutletTypeController.js +4 -4
  8. package/lib/Controllers/Packhouse/Site/CompacSizerPackrunSummaryController.js +4 -4
  9. package/lib/Controllers/Packhouse/Site/DowntimeEventController.js +4 -4
  10. package/lib/Controllers/Packhouse/Site/FreshPackPackrunSummaryController.js +4 -4
  11. package/lib/Controllers/Packhouse/Site/GrowingMethodController.js +4 -4
  12. package/lib/Controllers/Packhouse/Site/PackTypeController.js +4 -4
  13. package/lib/Controllers/Packhouse/Site/PackingLineController.js +4 -4
  14. package/lib/Controllers/Packhouse/Site/PackrunController.js +4 -4
  15. package/lib/Controllers/Packhouse/Site/RejectBinController.js +4 -4
  16. package/lib/Controllers/Packhouse/Site/RejectBinScaleController.js +4 -4
  17. package/lib/Controllers/Packhouse/Site/RejectBinWeightController.js +4 -4
  18. package/lib/Controllers/Packhouse/Site/ShiftController.js +4 -4
  19. package/lib/Controllers/Packhouse/Site/ShiftFocusMeetingController.js +4 -4
  20. package/lib/Controllers/Packhouse/Site/ShiftHourlyEntryController.js +4 -4
  21. package/lib/Controllers/Packhouse/Site/VarietyController.js +4 -4
  22. package/lib/Controllers/Site/AlarmController.js +4 -4
  23. package/lib/Controllers/Site/AlarmGroupController.js +4 -4
  24. package/lib/Controllers/Site/DefinitionController.js +4 -4
  25. package/lib/Controllers/Site/PermanentObjectController.js +4 -4
  26. package/lib/Controllers/Site/PermanentObjectDataController.js +4 -4
  27. package/lib/Controllers/Site/PointController.js +6 -4
  28. package/lib/Controllers/Site/TemporaryObjectController.js +4 -4
  29. package/lib/Models/AccountPolicyModel.js +26 -130
  30. package/lib/Models/ApiAccountModel.js +26 -130
  31. package/lib/Models/CompanyModel.js +20 -98
  32. package/lib/Models/FirebaseTokenModel.js +29 -146
  33. package/lib/Models/Packhouse/Site/BinTipWeightModel.js +40 -192
  34. package/lib/Models/Packhouse/Site/CompacSizerBatchModel.js +37 -176
  35. package/lib/Models/Packhouse/Site/CompacSizerModel.js +55 -272
  36. package/lib/Models/Packhouse/Site/CompacSizerOutletProductChangeModel.js +43 -208
  37. package/lib/Models/Packhouse/Site/CompacSizerOutletTypeChangeModel.js +37 -176
  38. package/lib/Models/Packhouse/Site/CompacSizerOutletTypeModel.js +31 -144
  39. package/lib/Models/Packhouse/Site/CompacSizerPackrunSummaryModel.js +49 -240
  40. package/lib/Models/Packhouse/Site/DowntimeEventModel.js +55 -272
  41. package/lib/Models/Packhouse/Site/FreshPackPackrunSummaryModel.js +37 -176
  42. package/lib/Models/Packhouse/Site/GrowingMethodModel.js +31 -144
  43. package/lib/Models/Packhouse/Site/PackTypeModel.js +37 -176
  44. package/lib/Models/Packhouse/Site/PackingLineModel.js +58 -288
  45. package/lib/Models/Packhouse/Site/PackrunModel.js +58 -288
  46. package/lib/Models/Packhouse/Site/RejectBinModel.js +40 -192
  47. package/lib/Models/Packhouse/Site/RejectBinScaleModel.js +49 -240
  48. package/lib/Models/Packhouse/Site/RejectBinWeightModel.js +43 -208
  49. package/lib/Models/Packhouse/Site/ShiftFocusMeetingModel.js +49 -240
  50. package/lib/Models/Packhouse/Site/ShiftHourlyEntryModel.js +124 -640
  51. package/lib/Models/Packhouse/Site/ShiftModel.js +70 -352
  52. package/lib/Models/Packhouse/Site/VarietyModel.js +37 -176
  53. package/lib/Models/RTUModel.js +23 -114
  54. package/lib/Models/RTUPluginModel.js +20 -98
  55. package/lib/Models/Site/AlarmGroupModel.js +34 -160
  56. package/lib/Models/Site/AlarmModel.js +64 -320
  57. package/lib/Models/Site/DefinitionModel.js +31 -144
  58. package/lib/Models/Site/PermanentObjectDataModel.js +37 -176
  59. package/lib/Models/Site/PermanentObjectModel.js +34 -160
  60. package/lib/Models/Site/PointModel.js +46 -224
  61. package/lib/Models/Site/TemporaryObjectModel.js +31 -144
  62. package/lib/Models/Site/index.js +0 -3
  63. package/lib/Models/SiteModel.js +23 -114
  64. package/lib/Models/TokenModel.js +35 -178
  65. package/lib/Models/UserAccountActionTokenModel.js +38 -194
  66. package/lib/Models/UserAccountModel.js +35 -178
  67. package/lib/PackageVersion.js +1 -1
  68. package/lib/index.d.ts +841 -1588
  69. package/lib/index.js +67 -38
  70. package/package.json +3 -3
  71. package/src/Controllers/Packhouse/Site/BinTipWeightController.js +4 -4
  72. package/src/Controllers/Packhouse/Site/CompacSizerBatchController.js +4 -4
  73. package/src/Controllers/Packhouse/Site/CompacSizerController.js +4 -4
  74. package/src/Controllers/Packhouse/Site/CompacSizerOutletProductChangeController.js +4 -4
  75. package/src/Controllers/Packhouse/Site/CompacSizerOutletTypeChangeController.js +4 -4
  76. package/src/Controllers/Packhouse/Site/CompacSizerOutletTypeController.js +4 -4
  77. package/src/Controllers/Packhouse/Site/CompacSizerPackrunSummaryController.js +4 -4
  78. package/src/Controllers/Packhouse/Site/DowntimeEventController.js +4 -4
  79. package/src/Controllers/Packhouse/Site/FreshPackPackrunSummaryController.js +4 -4
  80. package/src/Controllers/Packhouse/Site/GrowingMethodController.js +4 -4
  81. package/src/Controllers/Packhouse/Site/PackTypeController.js +4 -4
  82. package/src/Controllers/Packhouse/Site/PackingLineController.js +4 -4
  83. package/src/Controllers/Packhouse/Site/PackrunController.js +4 -4
  84. package/src/Controllers/Packhouse/Site/RejectBinController.js +4 -4
  85. package/src/Controllers/Packhouse/Site/RejectBinScaleController.js +4 -4
  86. package/src/Controllers/Packhouse/Site/RejectBinWeightController.js +4 -4
  87. package/src/Controllers/Packhouse/Site/ShiftController.js +4 -4
  88. package/src/Controllers/Packhouse/Site/ShiftFocusMeetingController.js +4 -4
  89. package/src/Controllers/Packhouse/Site/ShiftHourlyEntryController.js +4 -4
  90. package/src/Controllers/Packhouse/Site/VarietyController.js +4 -4
  91. package/src/Controllers/Site/AlarmController.js +4 -4
  92. package/src/Controllers/Site/AlarmGroupController.js +4 -4
  93. package/src/Controllers/Site/DefinitionController.js +4 -4
  94. package/src/Controllers/Site/PermanentObjectController.js +4 -4
  95. package/src/Controllers/Site/PermanentObjectDataController.js +4 -4
  96. package/src/Controllers/Site/PointController.js +6 -4
  97. package/src/Controllers/Site/TemporaryObjectController.js +4 -4
  98. package/src/Models/AccountPolicyModel.js +21 -117
  99. package/src/Models/ApiAccountModel.js +21 -117
  100. package/src/Models/CompanyModel.js +15 -87
  101. package/src/Models/FirebaseTokenModel.js +24 -132
  102. package/src/Models/Packhouse/Site/BinTipWeightModel.js +33 -174
  103. package/src/Models/Packhouse/Site/CompacSizerBatchModel.js +30 -159
  104. package/src/Models/Packhouse/Site/CompacSizerModel.js +48 -249
  105. package/src/Models/Packhouse/Site/CompacSizerOutletProductChangeModel.js +36 -189
  106. package/src/Models/Packhouse/Site/CompacSizerOutletTypeChangeModel.js +30 -159
  107. package/src/Models/Packhouse/Site/CompacSizerOutletTypeModel.js +24 -129
  108. package/src/Models/Packhouse/Site/CompacSizerPackrunSummaryModel.js +42 -219
  109. package/src/Models/Packhouse/Site/DowntimeEventModel.js +48 -249
  110. package/src/Models/Packhouse/Site/FreshPackPackrunSummaryModel.js +30 -159
  111. package/src/Models/Packhouse/Site/GrowingMethodModel.js +24 -129
  112. package/src/Models/Packhouse/Site/PackTypeModel.js +30 -159
  113. package/src/Models/Packhouse/Site/PackingLineModel.js +51 -264
  114. package/src/Models/Packhouse/Site/PackrunModel.js +51 -264
  115. package/src/Models/Packhouse/Site/RejectBinModel.js +33 -174
  116. package/src/Models/Packhouse/Site/RejectBinScaleModel.js +42 -219
  117. package/src/Models/Packhouse/Site/RejectBinWeightModel.js +36 -189
  118. package/src/Models/Packhouse/Site/ShiftFocusMeetingModel.js +42 -219
  119. package/src/Models/Packhouse/Site/ShiftHourlyEntryModel.js +117 -594
  120. package/src/Models/Packhouse/Site/ShiftModel.js +63 -324
  121. package/src/Models/Packhouse/Site/VarietyModel.js +30 -159
  122. package/src/Models/RTUModel.js +18 -102
  123. package/src/Models/RTUPluginModel.js +15 -87
  124. package/src/Models/Site/AlarmGroupModel.js +27 -144
  125. package/src/Models/Site/AlarmModel.js +57 -294
  126. package/src/Models/Site/DefinitionModel.js +24 -129
  127. package/src/Models/Site/PermanentObjectDataModel.js +30 -159
  128. package/src/Models/Site/PermanentObjectModel.js +27 -144
  129. package/src/Models/Site/PointModel.js +39 -204
  130. package/src/Models/Site/TemporaryObjectModel.js +24 -129
  131. package/src/Models/Site/index.js +0 -2
  132. package/src/Models/SiteModel.js +18 -102
  133. package/src/Models/TokenModel.js +30 -162
  134. package/src/Models/UserAccountActionTokenModel.js +33 -177
  135. package/src/Models/UserAccountModel.js +30 -162
  136. package/src/PackageVersion.js +1 -1
  137. package/src/index.js +35 -3
  138. package/lib/Models/Site/BaseSiteModel.js +0 -58
  139. package/src/Models/Site/BaseSiteModel.js +0 -30
@@ -4,24 +4,23 @@
4
4
  * Do Not Edit this File Manually!
5
5
  */
6
6
 
7
- import BaseSiteModel from '../../Models/Site/BaseSiteModel';
7
+ import BaseModel from '../../Models/BaseModel';
8
8
 
9
9
  /**
10
10
  * Model Class for a Alarm Group
11
11
  *
12
12
  * @class
13
13
  * @hideconstructor
14
- * @extends BaseSiteModel
14
+ * @extends BaseModel
15
15
  */
16
- class AlarmGroupModel extends BaseSiteModel
16
+ class AlarmGroupModel extends BaseModel
17
17
  {
18
18
  /**
19
19
  * AlarmGroupModel Constructor
20
20
  *
21
21
  * @protected
22
- * @param {number} siteId The Site ID associated with this Alarm Group
23
22
  */
24
- constructor(siteId)
23
+ constructor()
25
24
  {
26
25
  super();
27
26
 
@@ -29,172 +28,57 @@ class AlarmGroupModel extends BaseSiteModel
29
28
  * The Alarm Group ID
30
29
  *
31
30
  * @type {string}
32
- * @private
31
+ * @public
33
32
  */
34
- this._id = undefined;
33
+ this.id = undefined;
35
34
 
36
35
  /**
37
36
  * The RTU this Alarm Group belongs to
38
37
  *
39
38
  * @type {?number}
40
- * @private
39
+ * @public
41
40
  */
42
- this._rtuId = undefined;
41
+ this.rtuId = undefined;
43
42
 
44
43
  /**
45
44
  * The Alarm Group Name
46
45
  *
47
46
  * @type {string}
48
- * @private
47
+ * @public
49
48
  */
50
- this._name = undefined;
49
+ this.name = undefined;
51
50
 
52
51
  /**
53
52
  * The Boolean Point used to Reset this Alarm Group
54
53
  *
55
54
  * @type {number}
56
- * @private
55
+ * @public
57
56
  */
58
- this._resetPoint = undefined;
57
+ this.resetPoint = undefined;
59
58
 
60
59
  /**
61
60
  * An Array of Points and the States to be Written when this Alarm Group is Reset
62
61
  *
63
62
  * @type {Array<{point: number, value: boolean}>}
64
- * @private
63
+ * @public
65
64
  */
66
- this._externalResetPoints = undefined;
65
+ this.externalResetPoints = undefined;
67
66
 
68
67
  /**
69
68
  * Whether the Alarm Group has been deleted
70
69
  *
71
70
  * @type {boolean}
72
- * @private
71
+ * @public
73
72
  */
74
- this._deleted = undefined;
73
+ this.deleted = undefined;
75
74
 
76
75
  /**
77
76
  * When the Alarm Group was last updated
78
77
  *
79
78
  * @type {Date}
80
- * @private
79
+ * @public
81
80
  */
82
- this._updateTimestamp = undefined;
83
-
84
- /**
85
- * The Site ID associated with this Alarm Group
86
- *
87
- * @type {number}
88
- * @private
89
- */
90
- this._siteId = siteId;
91
- }
92
-
93
- /**
94
- * The Alarm Group ID
95
- *
96
- * @public
97
- * @type {string}
98
- */
99
- get id()
100
- {
101
- return this._id;
102
- }
103
-
104
- /**
105
- * The RTU this Alarm Group belongs to
106
- *
107
- * @public
108
- * @type {?number}
109
- */
110
- get rtuId()
111
- {
112
- return this._rtuId;
113
- }
114
-
115
- /**
116
- * The Alarm Group Name
117
- *
118
- * @public
119
- * @type {string}
120
- */
121
- get name()
122
- {
123
- return this._name;
124
- }
125
-
126
- /**
127
- * The Boolean Point used to Reset this Alarm Group
128
- *
129
- * @public
130
- * @type {number}
131
- */
132
- get resetPoint()
133
- {
134
- return this._resetPoint;
135
- }
136
-
137
- /**
138
- * An Array of Points and the States to be Written when this Alarm Group is Reset
139
- *
140
- * @public
141
- * @type {Array<{point: number, value: boolean}>}
142
- */
143
- get externalResetPoints()
144
- {
145
- return this._externalResetPoints;
146
- }
147
-
148
- /**
149
- * Whether the Alarm Group has been deleted
150
- *
151
- * @public
152
- * @type {boolean}
153
- */
154
- get deleted()
155
- {
156
- return this._deleted;
157
- }
158
-
159
- /**
160
- * When the Alarm Group was last updated
161
- *
162
- * @public
163
- * @type {Date}
164
- */
165
- get updateTimestamp()
166
- {
167
- return this._updateTimestamp;
168
- }
169
-
170
- /**
171
- * The Site ID associated with this Alarm Group
172
- *
173
- * @public
174
- * @type {number}
175
- */
176
- get siteId()
177
- {
178
- return this._siteId;
179
- }
180
-
181
- /**
182
- * Convert this **AlarmGroupModel** to a JSON Object
183
- *
184
- * @public
185
- * @return {Object<string, any>}
186
- */
187
- toJSON()
188
- {
189
- return {
190
- id: this._id,
191
- rtuId: this._rtuId,
192
- name: this._name,
193
- resetPoint: this._resetPoint,
194
- externalResetPoints: this._externalResetPoints,
195
- deleted: this._deleted,
196
- updateTimestamp: this._updateTimestamp
197
- };
81
+ this.updateTimestamp = undefined;
198
82
  }
199
83
 
200
84
  /**
@@ -203,12 +87,11 @@ class AlarmGroupModel extends BaseSiteModel
203
87
  * @static
204
88
  * @public
205
89
  * @param {Object<string, any>|string} json A JSON Object or JSON String
206
- * @param {number} siteId The Site ID associated with this Alarm Group
207
90
  * @return {AlarmGroupModel}
208
91
  */
209
- static fromJSON(json, siteId)
92
+ static fromJSON(json)
210
93
  {
211
- let model = new AlarmGroupModel(siteId);
94
+ let model = new AlarmGroupModel();
212
95
 
213
96
  /**
214
97
  * The JSON Object
@@ -228,7 +111,7 @@ class AlarmGroupModel extends BaseSiteModel
228
111
 
229
112
  if('id' in jsonObject)
230
113
  {
231
- model._id = (function(){
114
+ model.id = (function(){
232
115
  if(typeof jsonObject['id'] !== 'string')
233
116
  {
234
117
  return String(jsonObject['id']);
@@ -240,7 +123,7 @@ class AlarmGroupModel extends BaseSiteModel
240
123
 
241
124
  if('rtuId' in jsonObject)
242
125
  {
243
- model._rtuId = (function(){
126
+ model.rtuId = (function(){
244
127
  if(jsonObject['rtuId'] === null)
245
128
  {
246
129
  return null;
@@ -257,7 +140,7 @@ class AlarmGroupModel extends BaseSiteModel
257
140
 
258
141
  if('name' in jsonObject)
259
142
  {
260
- model._name = (function(){
143
+ model.name = (function(){
261
144
  if(typeof jsonObject['name'] !== 'string')
262
145
  {
263
146
  return String(jsonObject['name']);
@@ -269,7 +152,7 @@ class AlarmGroupModel extends BaseSiteModel
269
152
 
270
153
  if('resetPoint' in jsonObject)
271
154
  {
272
- model._resetPoint = (function(){
155
+ model.resetPoint = (function(){
273
156
  if(typeof jsonObject['resetPoint'] !== 'number')
274
157
  {
275
158
  return Number.isInteger(Number(jsonObject['resetPoint'])) ? Number(jsonObject['resetPoint']) : Math.floor(Number(jsonObject['resetPoint']));
@@ -281,7 +164,7 @@ class AlarmGroupModel extends BaseSiteModel
281
164
 
282
165
  if('externalResetPoints' in jsonObject)
283
166
  {
284
- model._externalResetPoints = (function(){
167
+ model.externalResetPoints = (function(){
285
168
  if(Array.isArray(jsonObject['externalResetPoints']) !== true)
286
169
  {
287
170
  return [];
@@ -331,7 +214,7 @@ class AlarmGroupModel extends BaseSiteModel
331
214
 
332
215
  if('deleted' in jsonObject)
333
216
  {
334
- model._deleted = (function(){
217
+ model.deleted = (function(){
335
218
  if(typeof jsonObject['deleted'] !== 'boolean')
336
219
  {
337
220
  return Boolean(jsonObject['deleted']);
@@ -343,7 +226,7 @@ class AlarmGroupModel extends BaseSiteModel
343
226
 
344
227
  if('updateTimestamp' in jsonObject)
345
228
  {
346
- model._updateTimestamp = (function(){
229
+ model.updateTimestamp = (function(){
347
230
  if(typeof jsonObject['updateTimestamp'] !== 'string')
348
231
  {
349
232
  return new Date(String(jsonObject['updateTimestamp']));