@ricado/api-client 1.4.0 → 2.0.2

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 (162) hide show
  1. package/dist/ricado.api.client.js +1 -1
  2. package/lib/Controllers/AccountPolicyController.js +1 -1
  3. package/lib/Controllers/ApiAccountController.js +2 -2
  4. package/lib/Controllers/CompanyController.js +1 -1
  5. package/lib/Controllers/FirebaseTokenController.js +1 -1
  6. package/lib/Controllers/Packhouse/Site/BinTipWeightController.js +6 -6
  7. package/lib/Controllers/Packhouse/Site/CompacSizerBatchController.js +6 -6
  8. package/lib/Controllers/Packhouse/Site/CompacSizerController.js +5 -5
  9. package/lib/Controllers/Packhouse/Site/CompacSizerOutletProductChangeController.js +6 -6
  10. package/lib/Controllers/Packhouse/Site/CompacSizerOutletTypeChangeController.js +6 -6
  11. package/lib/Controllers/Packhouse/Site/CompacSizerOutletTypeController.js +5 -5
  12. package/lib/Controllers/Packhouse/Site/CompacSizerPackrunSummaryController.js +6 -6
  13. package/lib/Controllers/Packhouse/Site/DowntimeEventController.js +6 -6
  14. package/lib/Controllers/Packhouse/Site/FreshPackPackrunSummaryController.js +6 -6
  15. package/lib/Controllers/Packhouse/Site/GrowingMethodController.js +5 -5
  16. package/lib/Controllers/Packhouse/Site/PackTypeController.js +5 -5
  17. package/lib/Controllers/Packhouse/Site/PackingLineController.js +5 -5
  18. package/lib/Controllers/Packhouse/Site/PackrunController.js +292 -6
  19. package/lib/Controllers/Packhouse/Site/RejectBinController.js +6 -6
  20. package/lib/Controllers/Packhouse/Site/RejectBinScaleController.js +5 -5
  21. package/lib/Controllers/Packhouse/Site/RejectBinWeightController.js +6 -6
  22. package/lib/Controllers/Packhouse/Site/ShiftController.js +6 -6
  23. package/lib/Controllers/Packhouse/Site/ShiftFocusMeetingController.js +6 -6
  24. package/lib/Controllers/Packhouse/Site/ShiftHourlyEntryController.js +6 -6
  25. package/lib/Controllers/Packhouse/Site/VarietyController.js +5 -5
  26. package/lib/Controllers/RTU/GlobalSettingsController.js +2 -2
  27. package/lib/Controllers/RTU/PluginSettingsController.js +2 -2
  28. package/lib/Controllers/RTUController.js +1 -1
  29. package/lib/Controllers/RTUPluginController.js +1 -1
  30. package/lib/Controllers/Site/AlarmController.js +6 -6
  31. package/lib/Controllers/Site/AlarmGroupController.js +5 -5
  32. package/lib/Controllers/Site/DefinitionController.js +5 -5
  33. package/lib/Controllers/Site/PermanentObjectController.js +5 -5
  34. package/lib/Controllers/Site/PermanentObjectDataController.js +6 -6
  35. package/lib/Controllers/Site/PointController.js +8 -6
  36. package/lib/Controllers/Site/TemporaryObjectController.js +5 -5
  37. package/lib/Controllers/SiteController.js +1 -1
  38. package/lib/Controllers/TokenController.js +2 -2
  39. package/lib/Controllers/ToolsController.js +1 -1
  40. package/lib/Controllers/UserAccountActionTokenController.js +2 -2
  41. package/lib/Controllers/UserAccountController.js +2 -2
  42. package/lib/DataItems/PointValueItem.js +2 -2
  43. package/lib/Errors/BadRequestError.js +7 -3
  44. package/lib/Errors/ForbiddenError.js +7 -3
  45. package/lib/Errors/NetworkError.js +7 -3
  46. package/lib/Errors/NotAllowedError.js +7 -3
  47. package/lib/Errors/NotFoundError.js +7 -3
  48. package/lib/Errors/ServerError.js +7 -3
  49. package/lib/Errors/UnauthorizedError.js +7 -3
  50. package/lib/Models/AccountPolicyModel.js +29 -133
  51. package/lib/Models/ApiAccountModel.js +29 -133
  52. package/lib/Models/BaseModel.js +6 -2
  53. package/lib/Models/CompanyModel.js +23 -101
  54. package/lib/Models/FirebaseTokenModel.js +32 -149
  55. package/lib/Models/Packhouse/Site/BinTipWeightModel.js +43 -195
  56. package/lib/Models/Packhouse/Site/CompacSizerBatchModel.js +40 -179
  57. package/lib/Models/Packhouse/Site/CompacSizerModel.js +58 -275
  58. package/lib/Models/Packhouse/Site/CompacSizerOutletProductChangeModel.js +46 -211
  59. package/lib/Models/Packhouse/Site/CompacSizerOutletTypeChangeModel.js +40 -179
  60. package/lib/Models/Packhouse/Site/CompacSizerOutletTypeModel.js +34 -147
  61. package/lib/Models/Packhouse/Site/CompacSizerPackrunSummaryModel.js +52 -243
  62. package/lib/Models/Packhouse/Site/DowntimeEventModel.js +58 -275
  63. package/lib/Models/Packhouse/Site/FreshPackPackrunSummaryModel.js +40 -179
  64. package/lib/Models/Packhouse/Site/GrowingMethodModel.js +34 -147
  65. package/lib/Models/Packhouse/Site/PackTypeModel.js +40 -179
  66. package/lib/Models/Packhouse/Site/PackingLineModel.js +61 -291
  67. package/lib/Models/Packhouse/Site/PackrunModel.js +61 -291
  68. package/lib/Models/Packhouse/Site/RejectBinModel.js +43 -195
  69. package/lib/Models/Packhouse/Site/RejectBinScaleModel.js +52 -243
  70. package/lib/Models/Packhouse/Site/RejectBinWeightModel.js +46 -211
  71. package/lib/Models/Packhouse/Site/ShiftFocusMeetingModel.js +52 -243
  72. package/lib/Models/Packhouse/Site/ShiftHourlyEntryModel.js +127 -643
  73. package/lib/Models/Packhouse/Site/ShiftModel.js +73 -355
  74. package/lib/Models/Packhouse/Site/VarietyModel.js +40 -179
  75. package/lib/Models/RTUModel.js +26 -117
  76. package/lib/Models/RTUPluginModel.js +23 -101
  77. package/lib/Models/Site/AlarmGroupModel.js +37 -163
  78. package/lib/Models/Site/AlarmModel.js +67 -323
  79. package/lib/Models/Site/DefinitionModel.js +34 -147
  80. package/lib/Models/Site/PermanentObjectDataModel.js +40 -179
  81. package/lib/Models/Site/PermanentObjectModel.js +37 -163
  82. package/lib/Models/Site/PointModel.js +49 -227
  83. package/lib/Models/Site/TemporaryObjectModel.js +34 -147
  84. package/lib/Models/Site/index.js +0 -3
  85. package/lib/Models/SiteModel.js +26 -117
  86. package/lib/Models/TokenModel.js +38 -181
  87. package/lib/Models/UserAccountActionTokenModel.js +41 -197
  88. package/lib/Models/UserAccountModel.js +38 -181
  89. package/lib/PackageVersion.js +1 -1
  90. package/lib/Points.js +1 -1
  91. package/lib/RequestHelper.js +2 -2
  92. package/lib/WebSocketHelper.js +1 -1
  93. package/lib/index.d.ts +931 -1589
  94. package/package.json +3 -3
  95. package/src/Controllers/Packhouse/Site/BinTipWeightController.js +4 -4
  96. package/src/Controllers/Packhouse/Site/CompacSizerBatchController.js +4 -4
  97. package/src/Controllers/Packhouse/Site/CompacSizerController.js +4 -4
  98. package/src/Controllers/Packhouse/Site/CompacSizerOutletProductChangeController.js +4 -4
  99. package/src/Controllers/Packhouse/Site/CompacSizerOutletTypeChangeController.js +4 -4
  100. package/src/Controllers/Packhouse/Site/CompacSizerOutletTypeController.js +4 -4
  101. package/src/Controllers/Packhouse/Site/CompacSizerPackrunSummaryController.js +4 -4
  102. package/src/Controllers/Packhouse/Site/DowntimeEventController.js +4 -4
  103. package/src/Controllers/Packhouse/Site/FreshPackPackrunSummaryController.js +4 -4
  104. package/src/Controllers/Packhouse/Site/GrowingMethodController.js +4 -4
  105. package/src/Controllers/Packhouse/Site/PackTypeController.js +4 -4
  106. package/src/Controllers/Packhouse/Site/PackingLineController.js +4 -4
  107. package/src/Controllers/Packhouse/Site/PackrunController.js +365 -4
  108. package/src/Controllers/Packhouse/Site/RejectBinController.js +4 -4
  109. package/src/Controllers/Packhouse/Site/RejectBinScaleController.js +4 -4
  110. package/src/Controllers/Packhouse/Site/RejectBinWeightController.js +4 -4
  111. package/src/Controllers/Packhouse/Site/ShiftController.js +4 -4
  112. package/src/Controllers/Packhouse/Site/ShiftFocusMeetingController.js +4 -4
  113. package/src/Controllers/Packhouse/Site/ShiftHourlyEntryController.js +4 -4
  114. package/src/Controllers/Packhouse/Site/VarietyController.js +4 -4
  115. package/src/Controllers/Site/AlarmController.js +4 -4
  116. package/src/Controllers/Site/AlarmGroupController.js +4 -4
  117. package/src/Controllers/Site/DefinitionController.js +4 -4
  118. package/src/Controllers/Site/PermanentObjectController.js +4 -4
  119. package/src/Controllers/Site/PermanentObjectDataController.js +4 -4
  120. package/src/Controllers/Site/PointController.js +6 -4
  121. package/src/Controllers/Site/TemporaryObjectController.js +4 -4
  122. package/src/Models/AccountPolicyModel.js +21 -117
  123. package/src/Models/ApiAccountModel.js +21 -117
  124. package/src/Models/CompanyModel.js +15 -87
  125. package/src/Models/FirebaseTokenModel.js +24 -132
  126. package/src/Models/Packhouse/Site/BinTipWeightModel.js +33 -174
  127. package/src/Models/Packhouse/Site/CompacSizerBatchModel.js +30 -159
  128. package/src/Models/Packhouse/Site/CompacSizerModel.js +48 -249
  129. package/src/Models/Packhouse/Site/CompacSizerOutletProductChangeModel.js +36 -189
  130. package/src/Models/Packhouse/Site/CompacSizerOutletTypeChangeModel.js +30 -159
  131. package/src/Models/Packhouse/Site/CompacSizerOutletTypeModel.js +24 -129
  132. package/src/Models/Packhouse/Site/CompacSizerPackrunSummaryModel.js +42 -219
  133. package/src/Models/Packhouse/Site/DowntimeEventModel.js +48 -249
  134. package/src/Models/Packhouse/Site/FreshPackPackrunSummaryModel.js +30 -159
  135. package/src/Models/Packhouse/Site/GrowingMethodModel.js +24 -129
  136. package/src/Models/Packhouse/Site/PackTypeModel.js +30 -159
  137. package/src/Models/Packhouse/Site/PackingLineModel.js +51 -264
  138. package/src/Models/Packhouse/Site/PackrunModel.js +51 -264
  139. package/src/Models/Packhouse/Site/RejectBinModel.js +33 -174
  140. package/src/Models/Packhouse/Site/RejectBinScaleModel.js +42 -219
  141. package/src/Models/Packhouse/Site/RejectBinWeightModel.js +36 -189
  142. package/src/Models/Packhouse/Site/ShiftFocusMeetingModel.js +42 -219
  143. package/src/Models/Packhouse/Site/ShiftHourlyEntryModel.js +117 -594
  144. package/src/Models/Packhouse/Site/ShiftModel.js +63 -324
  145. package/src/Models/Packhouse/Site/VarietyModel.js +30 -159
  146. package/src/Models/RTUModel.js +18 -102
  147. package/src/Models/RTUPluginModel.js +15 -87
  148. package/src/Models/Site/AlarmGroupModel.js +27 -144
  149. package/src/Models/Site/AlarmModel.js +57 -294
  150. package/src/Models/Site/DefinitionModel.js +24 -129
  151. package/src/Models/Site/PermanentObjectDataModel.js +30 -159
  152. package/src/Models/Site/PermanentObjectModel.js +27 -144
  153. package/src/Models/Site/PointModel.js +39 -204
  154. package/src/Models/Site/TemporaryObjectModel.js +24 -129
  155. package/src/Models/Site/index.js +0 -2
  156. package/src/Models/SiteModel.js +18 -102
  157. package/src/Models/TokenModel.js +30 -162
  158. package/src/Models/UserAccountActionTokenModel.js +33 -177
  159. package/src/Models/UserAccountModel.js +30 -162
  160. package/src/PackageVersion.js +1 -1
  161. package/lib/Models/Site/BaseSiteModel.js +0 -58
  162. 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']));