@ricado/api-client 1.4.1 → 2.1.0

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 (136) 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 +2 -2
  7. package/lib/Controllers/Packhouse/Site/CompacSizerBatchController.js +2 -2
  8. package/lib/Controllers/Packhouse/Site/CompacSizerController.js +1 -1
  9. package/lib/Controllers/Packhouse/Site/CompacSizerOutletProductChangeController.js +2 -2
  10. package/lib/Controllers/Packhouse/Site/CompacSizerOutletTypeChangeController.js +2 -2
  11. package/lib/Controllers/Packhouse/Site/CompacSizerOutletTypeController.js +1 -1
  12. package/lib/Controllers/Packhouse/Site/CompacSizerPackrunSummaryController.js +2 -2
  13. package/lib/Controllers/Packhouse/Site/DowntimeEventController.js +2 -2
  14. package/lib/Controllers/Packhouse/Site/FreshPackPackrunSummaryController.js +2 -2
  15. package/lib/Controllers/Packhouse/Site/GrowingMethodController.js +1 -1
  16. package/lib/Controllers/Packhouse/Site/PackTypeController.js +1 -1
  17. package/lib/Controllers/Packhouse/Site/PackingLineController.js +1 -1
  18. package/lib/Controllers/Packhouse/Site/PackrunController.js +288 -2
  19. package/lib/Controllers/Packhouse/Site/RejectBinController.js +2 -2
  20. package/lib/Controllers/Packhouse/Site/RejectBinScaleController.js +1 -1
  21. package/lib/Controllers/Packhouse/Site/RejectBinWeightController.js +2 -2
  22. package/lib/Controllers/Packhouse/Site/ShiftController.js +2 -2
  23. package/lib/Controllers/Packhouse/Site/ShiftFocusMeetingController.js +2 -2
  24. package/lib/Controllers/Packhouse/Site/ShiftHourlyEntryController.js +2 -2
  25. package/lib/Controllers/Packhouse/Site/VarietyController.js +1 -1
  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 +2 -2
  31. package/lib/Controllers/Site/AlarmGroupController.js +1 -1
  32. package/lib/Controllers/Site/DefinitionController.js +1 -1
  33. package/lib/Controllers/Site/PermanentObjectController.js +1 -1
  34. package/lib/Controllers/Site/PermanentObjectDataController.js +2 -2
  35. package/lib/Controllers/Site/PointController.js +2 -2
  36. package/lib/Controllers/Site/TemporaryObjectController.js +1 -1
  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 -185
  56. package/lib/Models/Packhouse/Site/CompacSizerBatchModel.js +40 -169
  57. package/lib/Models/Packhouse/Site/CompacSizerModel.js +58 -265
  58. package/lib/Models/Packhouse/Site/CompacSizerOutletProductChangeModel.js +46 -201
  59. package/lib/Models/Packhouse/Site/CompacSizerOutletTypeChangeModel.js +40 -169
  60. package/lib/Models/Packhouse/Site/CompacSizerOutletTypeModel.js +34 -137
  61. package/lib/Models/Packhouse/Site/CompacSizerPackrunSummaryModel.js +52 -233
  62. package/lib/Models/Packhouse/Site/DowntimeEventModel.js +58 -265
  63. package/lib/Models/Packhouse/Site/FreshPackPackrunSummaryModel.js +40 -169
  64. package/lib/Models/Packhouse/Site/GrowingMethodModel.js +34 -137
  65. package/lib/Models/Packhouse/Site/PackTypeModel.js +40 -169
  66. package/lib/Models/Packhouse/Site/PackingLineModel.js +61 -281
  67. package/lib/Models/Packhouse/Site/PackrunModel.js +61 -281
  68. package/lib/Models/Packhouse/Site/RejectBinModel.js +43 -185
  69. package/lib/Models/Packhouse/Site/RejectBinScaleModel.js +52 -233
  70. package/lib/Models/Packhouse/Site/RejectBinWeightModel.js +46 -201
  71. package/lib/Models/Packhouse/Site/ShiftFocusMeetingModel.js +52 -233
  72. package/lib/Models/Packhouse/Site/ShiftHourlyEntryModel.js +127 -633
  73. package/lib/Models/Packhouse/Site/ShiftModel.js +73 -345
  74. package/lib/Models/Packhouse/Site/VarietyModel.js +40 -169
  75. package/lib/Models/RTUModel.js +26 -117
  76. package/lib/Models/RTUPluginModel.js +23 -101
  77. package/lib/Models/Site/AlarmGroupModel.js +37 -153
  78. package/lib/Models/Site/AlarmModel.js +67 -313
  79. package/lib/Models/Site/DefinitionModel.js +34 -137
  80. package/lib/Models/Site/PermanentObjectDataModel.js +40 -169
  81. package/lib/Models/Site/PermanentObjectModel.js +37 -153
  82. package/lib/Models/Site/PointModel.js +49 -217
  83. package/lib/Models/Site/TemporaryObjectModel.js +34 -137
  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 +945 -1206
  94. package/package.json +3 -3
  95. package/src/Controllers/Packhouse/Site/PackrunController.js +361 -0
  96. package/src/Models/AccountPolicyModel.js +21 -117
  97. package/src/Models/ApiAccountModel.js +21 -117
  98. package/src/Models/CompanyModel.js +15 -87
  99. package/src/Models/FirebaseTokenModel.js +24 -132
  100. package/src/Models/Packhouse/Site/BinTipWeightModel.js +32 -163
  101. package/src/Models/Packhouse/Site/CompacSizerBatchModel.js +29 -148
  102. package/src/Models/Packhouse/Site/CompacSizerModel.js +47 -238
  103. package/src/Models/Packhouse/Site/CompacSizerOutletProductChangeModel.js +35 -178
  104. package/src/Models/Packhouse/Site/CompacSizerOutletTypeChangeModel.js +29 -148
  105. package/src/Models/Packhouse/Site/CompacSizerOutletTypeModel.js +23 -118
  106. package/src/Models/Packhouse/Site/CompacSizerPackrunSummaryModel.js +41 -208
  107. package/src/Models/Packhouse/Site/DowntimeEventModel.js +47 -238
  108. package/src/Models/Packhouse/Site/FreshPackPackrunSummaryModel.js +29 -148
  109. package/src/Models/Packhouse/Site/GrowingMethodModel.js +23 -118
  110. package/src/Models/Packhouse/Site/PackTypeModel.js +29 -148
  111. package/src/Models/Packhouse/Site/PackingLineModel.js +50 -253
  112. package/src/Models/Packhouse/Site/PackrunModel.js +50 -253
  113. package/src/Models/Packhouse/Site/RejectBinModel.js +32 -163
  114. package/src/Models/Packhouse/Site/RejectBinScaleModel.js +41 -208
  115. package/src/Models/Packhouse/Site/RejectBinWeightModel.js +35 -178
  116. package/src/Models/Packhouse/Site/ShiftFocusMeetingModel.js +41 -208
  117. package/src/Models/Packhouse/Site/ShiftHourlyEntryModel.js +116 -583
  118. package/src/Models/Packhouse/Site/ShiftModel.js +62 -313
  119. package/src/Models/Packhouse/Site/VarietyModel.js +29 -148
  120. package/src/Models/RTUModel.js +18 -102
  121. package/src/Models/RTUPluginModel.js +15 -87
  122. package/src/Models/Site/AlarmGroupModel.js +26 -133
  123. package/src/Models/Site/AlarmModel.js +56 -283
  124. package/src/Models/Site/DefinitionModel.js +23 -118
  125. package/src/Models/Site/PermanentObjectDataModel.js +29 -148
  126. package/src/Models/Site/PermanentObjectModel.js +26 -133
  127. package/src/Models/Site/PointModel.js +38 -193
  128. package/src/Models/Site/TemporaryObjectModel.js +23 -118
  129. package/src/Models/Site/index.js +0 -2
  130. package/src/Models/SiteModel.js +18 -102
  131. package/src/Models/TokenModel.js +30 -162
  132. package/src/Models/UserAccountActionTokenModel.js +33 -177
  133. package/src/Models/UserAccountModel.js +30 -162
  134. package/src/PackageVersion.js +1 -1
  135. package/lib/Models/Site/BaseSiteModel.js +0 -58
  136. package/src/Models/Site/BaseSiteModel.js +0 -30
@@ -4,16 +4,16 @@
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
@@ -29,172 +29,65 @@ class AlarmGroupModel extends BaseSiteModel
29
29
  * The Alarm Group ID
30
30
  *
31
31
  * @type {string}
32
- * @private
32
+ * @public
33
33
  */
34
- this._id = undefined;
34
+ this.id = undefined;
35
35
 
36
36
  /**
37
37
  * The RTU this Alarm Group belongs to
38
38
  *
39
39
  * @type {?number}
40
- * @private
40
+ * @public
41
41
  */
42
- this._rtuId = undefined;
42
+ this.rtuId = undefined;
43
43
 
44
44
  /**
45
45
  * The Alarm Group Name
46
46
  *
47
47
  * @type {string}
48
- * @private
48
+ * @public
49
49
  */
50
- this._name = undefined;
50
+ this.name = undefined;
51
51
 
52
52
  /**
53
53
  * The Boolean Point used to Reset this Alarm Group
54
54
  *
55
55
  * @type {number}
56
- * @private
56
+ * @public
57
57
  */
58
- this._resetPoint = undefined;
58
+ this.resetPoint = undefined;
59
59
 
60
60
  /**
61
61
  * An Array of Points and the States to be Written when this Alarm Group is Reset
62
62
  *
63
63
  * @type {Array<{point: number, value: boolean}>}
64
- * @private
64
+ * @public
65
65
  */
66
- this._externalResetPoints = undefined;
66
+ this.externalResetPoints = undefined;
67
67
 
68
68
  /**
69
69
  * Whether the Alarm Group has been deleted
70
70
  *
71
71
  * @type {boolean}
72
- * @private
72
+ * @public
73
73
  */
74
- this._deleted = undefined;
74
+ this.deleted = undefined;
75
75
 
76
76
  /**
77
77
  * When the Alarm Group was last updated
78
78
  *
79
79
  * @type {Date}
80
- * @private
80
+ * @public
81
81
  */
82
- this._updateTimestamp = undefined;
82
+ this.updateTimestamp = undefined;
83
83
 
84
84
  /**
85
85
  * The Site ID associated with this Alarm Group
86
86
  *
87
87
  * @type {number}
88
- * @private
88
+ * @public
89
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
- };
90
+ this.siteId = siteId;
198
91
  }
199
92
 
200
93
  /**
@@ -228,7 +121,7 @@ class AlarmGroupModel extends BaseSiteModel
228
121
 
229
122
  if('id' in jsonObject)
230
123
  {
231
- model._id = (function(){
124
+ model.id = (function(){
232
125
  if(typeof jsonObject['id'] !== 'string')
233
126
  {
234
127
  return String(jsonObject['id']);
@@ -240,7 +133,7 @@ class AlarmGroupModel extends BaseSiteModel
240
133
 
241
134
  if('rtuId' in jsonObject)
242
135
  {
243
- model._rtuId = (function(){
136
+ model.rtuId = (function(){
244
137
  if(jsonObject['rtuId'] === null)
245
138
  {
246
139
  return null;
@@ -257,7 +150,7 @@ class AlarmGroupModel extends BaseSiteModel
257
150
 
258
151
  if('name' in jsonObject)
259
152
  {
260
- model._name = (function(){
153
+ model.name = (function(){
261
154
  if(typeof jsonObject['name'] !== 'string')
262
155
  {
263
156
  return String(jsonObject['name']);
@@ -269,7 +162,7 @@ class AlarmGroupModel extends BaseSiteModel
269
162
 
270
163
  if('resetPoint' in jsonObject)
271
164
  {
272
- model._resetPoint = (function(){
165
+ model.resetPoint = (function(){
273
166
  if(typeof jsonObject['resetPoint'] !== 'number')
274
167
  {
275
168
  return Number.isInteger(Number(jsonObject['resetPoint'])) ? Number(jsonObject['resetPoint']) : Math.floor(Number(jsonObject['resetPoint']));
@@ -281,7 +174,7 @@ class AlarmGroupModel extends BaseSiteModel
281
174
 
282
175
  if('externalResetPoints' in jsonObject)
283
176
  {
284
- model._externalResetPoints = (function(){
177
+ model.externalResetPoints = (function(){
285
178
  if(Array.isArray(jsonObject['externalResetPoints']) !== true)
286
179
  {
287
180
  return [];
@@ -331,7 +224,7 @@ class AlarmGroupModel extends BaseSiteModel
331
224
 
332
225
  if('deleted' in jsonObject)
333
226
  {
334
- model._deleted = (function(){
227
+ model.deleted = (function(){
335
228
  if(typeof jsonObject['deleted'] !== 'boolean')
336
229
  {
337
230
  return Boolean(jsonObject['deleted']);
@@ -343,7 +236,7 @@ class AlarmGroupModel extends BaseSiteModel
343
236
 
344
237
  if('updateTimestamp' in jsonObject)
345
238
  {
346
- model._updateTimestamp = (function(){
239
+ model.updateTimestamp = (function(){
347
240
  if(typeof jsonObject['updateTimestamp'] !== 'string')
348
241
  {
349
242
  return new Date(String(jsonObject['updateTimestamp']));