@ricado/api-client 2.1.1 → 2.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ricado/api-client",
-    "version": "2.1.1",
+    "version": "2.2.0",
     "description": "RICADO Gen 4 API Client Library for NodeJS and Browsers",
     "author": {
         "name": "Ash Neilson"

package/src/Controllers/Packhouse/Site/BinTipBinController.js

@@ -0,0 +1,665 @@
+/**
+ * File Auto-Generated by the RICADO Gen 4 PHP API Project
+ * 
+ * Do Not Edit this File Manually!
+ */
+
+import RequestHelper from '../../../RequestHelper';
+import BinTipBinModel from '../../../Models/Packhouse/Site/BinTipBinModel';
+
+/**
+ * Controller Class for Bin Tip Bins
+ * 
+ * @class
+ */
+class BinTipBinController
+{
+    /**
+     * Retrieve a Bin Tip Bin [GET /packhouse/sites/{siteId}/bin-tip-bins/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @return {Promise<BinTipBinModel>}
+     */
+    static getOne(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/packhouse/sites/${siteId}/bin-tip-bins/${id}`)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return BinTipBinModel.fromJSON(result, siteId);
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Update a Bin Tip Bin [PATCH /packhouse/sites/{siteId}/bin-tip-bins/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @param {BinTipBinController.UpdateData} updateData The Bin Tip Bin Update Data
+     * @return {Promise<BinTipBinModel>}
+     */
+    static update(siteId, id, updateData)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.patchRequest(`/packhouse/sites/${siteId}/bin-tip-bins/${id}`, updateData)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return BinTipBinModel.fromJSON(result, siteId);
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Delete a Bin Tip Bin [DELETE /packhouse/sites/{siteId}/bin-tip-bins/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @return {Promise<boolean>}
+     */
+    static delete(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.deleteRequest(`/packhouse/sites/${siteId}/bin-tip-bins/${id}`)
+            .then((result) => {
+                resolve(result ?? true);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Retrieve Comments [GET /packhouse/sites/{siteId}/bin-tip-bins/{id}/comments]
+     * 
+     * Retrieves Comments for a Bin Tip Bin
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @return {Promise<Array<BinTipBinController.CommentItem>>}
+     */
+    static getComments(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/packhouse/sites/${siteId}/bin-tip-bins/${id}/comments`)
+            .then((result) => {
+                let resolveValue = (function(){
+                    if(Array.isArray(result) !== true)
+                    {
+                        return [];
+                    }
+                
+                    return result.map((resultItem) => {
+                        return (function(){
+                            let resultItemObject = {};
+                            
+                            if(typeof resultItem === 'object' && 'id' in resultItem)
+                            {
+                                resultItemObject.id = (function(){
+                                    if(typeof resultItem.id !== 'string')
+                                    {
+                                        return String(resultItem.id);
+                                    }
+                
+                                    return resultItem.id;
+                                }());
+                            }
+                            else
+                            {
+                                resultItemObject.id = "";
+                            }
+                            
+                            if(typeof resultItem === 'object' && 'content' in resultItem)
+                            {
+                                resultItemObject.content = (function(){
+                                    if(resultItem.content === null)
+                                    {
+                                        return null;
+                                    }
+                
+                                    if(typeof resultItem.content !== 'string')
+                                    {
+                                        return String(resultItem.content);
+                                    }
+                
+                                    return resultItem.content;
+                                }());
+                            }
+                            else
+                            {
+                                resultItemObject.content = null;
+                            }
+                            
+                            if(typeof resultItem === 'object' && 'createdTimestamp' in resultItem)
+                            {
+                                resultItemObject.createdTimestamp = (function(){
+                                    if(resultItem.createdTimestamp === null)
+                                    {
+                                        return null;
+                                    }
+                
+                                    if(typeof resultItem.createdTimestamp !== 'string')
+                                    {
+                                        return new Date(String(resultItem.createdTimestamp));
+                                    }
+                
+                                    return new Date(resultItem.createdTimestamp);
+                                }());
+                            }
+                            else
+                            {
+                                resultItemObject.createdTimestamp = null;
+                            }
+                            
+                            if(typeof resultItem === 'object' && 'updatedTimestamp' in resultItem)
+                            {
+                                resultItemObject.updatedTimestamp = (function(){
+                                    if(resultItem.updatedTimestamp === null)
+                                    {
+                                        return null;
+                                    }
+                
+                                    if(typeof resultItem.updatedTimestamp !== 'string')
+                                    {
+                                        return new Date(String(resultItem.updatedTimestamp));
+                                    }
+                
+                                    return new Date(resultItem.updatedTimestamp);
+                                }());
+                            }
+                            else
+                            {
+                                resultItemObject.updatedTimestamp = null;
+                            }
+                
+                            return resultItemObject;
+                        }());
+                    });
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Create a Comment [POST /packhouse/sites/{siteId}/bin-tip-bins/{id}/comments]
+     * 
+     * Create a Comment for a Bin Tip Bin
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @param {string} content The Content of the New Comment
+     * @return {Promise<BinTipBinController.CommentItem>}
+     */
+    static createComment(siteId, id, content)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.postRequest(`/packhouse/sites/${siteId}/bin-tip-bins/${id}/comments`, {content})
+            .then((result) => {
+                let resolveValue = (function(){
+                    let resultObject = {};
+                    
+                    if(typeof result === 'object' && 'id' in result)
+                    {
+                        resultObject.id = (function(){
+                            if(typeof result.id !== 'string')
+                            {
+                                return String(result.id);
+                            }
+                
+                            return result.id;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.id = "";
+                    }
+                    
+                    if(typeof result === 'object' && 'content' in result)
+                    {
+                        resultObject.content = (function(){
+                            if(result.content === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.content !== 'string')
+                            {
+                                return String(result.content);
+                            }
+                
+                            return result.content;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.content = null;
+                    }
+                    
+                    if(typeof result === 'object' && 'createdTimestamp' in result)
+                    {
+                        resultObject.createdTimestamp = (function(){
+                            if(result.createdTimestamp === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.createdTimestamp !== 'string')
+                            {
+                                return new Date(String(result.createdTimestamp));
+                            }
+                
+                            return new Date(result.createdTimestamp);
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.createdTimestamp = null;
+                    }
+                    
+                    if(typeof result === 'object' && 'updatedTimestamp' in result)
+                    {
+                        resultObject.updatedTimestamp = (function(){
+                            if(result.updatedTimestamp === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.updatedTimestamp !== 'string')
+                            {
+                                return new Date(String(result.updatedTimestamp));
+                            }
+                
+                            return new Date(result.updatedTimestamp);
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.updatedTimestamp = null;
+                    }
+                
+                    return resultObject;
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Retrieve a Comment [GET /packhouse/sites/{siteId}/bin-tip-bins/{id}/comments/{commentId}]
+     * 
+     * Retrieves Comments for a Bin Tip Bin
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @param {string} commentId The Comment ID
+     * @return {Promise<BinTipBinController.CommentItem>}
+     */
+    static getOneComment(siteId, id, commentId)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/packhouse/sites/${siteId}/bin-tip-bins/${id}/comments/${commentId}`)
+            .then((result) => {
+                let resolveValue = (function(){
+                    let resultObject = {};
+                    
+                    if(typeof result === 'object' && 'id' in result)
+                    {
+                        resultObject.id = (function(){
+                            if(typeof result.id !== 'string')
+                            {
+                                return String(result.id);
+                            }
+                
+                            return result.id;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.id = "";
+                    }
+                    
+                    if(typeof result === 'object' && 'content' in result)
+                    {
+                        resultObject.content = (function(){
+                            if(result.content === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.content !== 'string')
+                            {
+                                return String(result.content);
+                            }
+                
+                            return result.content;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.content = null;
+                    }
+                    
+                    if(typeof result === 'object' && 'createdTimestamp' in result)
+                    {
+                        resultObject.createdTimestamp = (function(){
+                            if(result.createdTimestamp === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.createdTimestamp !== 'string')
+                            {
+                                return new Date(String(result.createdTimestamp));
+                            }
+                
+                            return new Date(result.createdTimestamp);
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.createdTimestamp = null;
+                    }
+                    
+                    if(typeof result === 'object' && 'updatedTimestamp' in result)
+                    {
+                        resultObject.updatedTimestamp = (function(){
+                            if(result.updatedTimestamp === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.updatedTimestamp !== 'string')
+                            {
+                                return new Date(String(result.updatedTimestamp));
+                            }
+                
+                            return new Date(result.updatedTimestamp);
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.updatedTimestamp = null;
+                    }
+                
+                    return resultObject;
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Update a Comment [PATCH /packhouse/sites/{siteId}/bin-tip-bins/{id}/comments/{commentId}]
+     * 
+     * Update a Comment for a Bin Tip Bin
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @param {string} commentId The Comment ID
+     * @param {string} content The Updated Content for the Comment
+     * @return {Promise<BinTipBinController.CommentItem>}
+     */
+    static updateOneComment(siteId, id, commentId, content)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.patchRequest(`/packhouse/sites/${siteId}/bin-tip-bins/${id}/comments/${commentId}`, {content})
+            .then((result) => {
+                let resolveValue = (function(){
+                    let resultObject = {};
+                    
+                    if(typeof result === 'object' && 'id' in result)
+                    {
+                        resultObject.id = (function(){
+                            if(typeof result.id !== 'string')
+                            {
+                                return String(result.id);
+                            }
+                
+                            return result.id;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.id = "";
+                    }
+                    
+                    if(typeof result === 'object' && 'content' in result)
+                    {
+                        resultObject.content = (function(){
+                            if(result.content === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.content !== 'string')
+                            {
+                                return String(result.content);
+                            }
+                
+                            return result.content;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.content = null;
+                    }
+                    
+                    if(typeof result === 'object' && 'createdTimestamp' in result)
+                    {
+                        resultObject.createdTimestamp = (function(){
+                            if(result.createdTimestamp === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.createdTimestamp !== 'string')
+                            {
+                                return new Date(String(result.createdTimestamp));
+                            }
+                
+                            return new Date(result.createdTimestamp);
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.createdTimestamp = null;
+                    }
+                    
+                    if(typeof result === 'object' && 'updatedTimestamp' in result)
+                    {
+                        resultObject.updatedTimestamp = (function(){
+                            if(result.updatedTimestamp === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.updatedTimestamp !== 'string')
+                            {
+                                return new Date(String(result.updatedTimestamp));
+                            }
+                
+                            return new Date(result.updatedTimestamp);
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.updatedTimestamp = null;
+                    }
+                
+                    return resultObject;
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Delete a Comment [DELETE /packhouse/sites/{siteId}/bin-tip-bins/{id}/comments/{commentId}]
+     * 
+     * Delete a Comment for a Bin Tip Bin
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @param {string} commentId The Comment ID
+     * @return {Promise<boolean>}
+     */
+    static deleteOneComment(siteId, id, commentId)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.deleteRequest(`/packhouse/sites/${siteId}/bin-tip-bins/${id}/comments/${commentId}`)
+            .then((result) => {
+                resolve(result ?? true);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * List all Bin Tip Bins [GET /packhouse/sites/{siteId}/bin-tip-bins]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {BinTipBinController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<BinTipBinModel[]>}
+     */
+    static getAll(siteId, queryParameters = {})
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/packhouse/sites/${siteId}/bin-tip-bins`, queryParameters)
+            .then((result) => {
+                let resolveValue = (function(){
+                    if(Array.isArray(result) !== true)
+                    {
+                        return [];
+                    }
+                
+                    return result.map((resultItem) => {
+                        return (function(){
+                            return BinTipBinModel.fromJSON(resultItem, siteId);
+                        }());
+                    });
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Create a Bin Tip Bin [POST /packhouse/sites/{siteId}/bin-tip-bins]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {BinTipBinController.CreateData} createData The Bin Tip Bin Create Data
+     * @return {Promise<BinTipBinModel>}
+     */
+    static create(siteId, createData)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.postRequest(`/packhouse/sites/${siteId}/bin-tip-bins`, createData)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return BinTipBinModel.fromJSON(result, siteId);
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+}
+
+export default BinTipBinController;
+
+/**
+ * The Optional Query Parameters for the getAll Function
+ * 
+ * @typedef {Object} BinTipBinController.GetAllQueryParameters
+ * @property {string} [binTipId] The Bin Tip ID associated with this Bin
+ * @property {string} [packrunId] The Packrun ID associated with this Bin
+ * @property {?string} [fullBinWeightId] The `BinTipWeight` ID as the Source for the Full Weight of this Bin
+ * @property {?string} [emptyBinWeightId] The `BinTipWeight` ID as the Source for the Empty Weight of this Bin
+ * @property {Date} [createdTimestampBegin] Filter by the Timestamp when this Bin was Created. Results Greater than or Equal to Timestamp
+ * @property {Date} [createdTimestampEnd] Filter by the Timestamp when this Bin was Created. Results Less than or Equal to Timestamp
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * The Create Data for a Bin Tip Bin
+ * 
+ * @typedef {Object} BinTipBinController.CreateData
+ * @property {string} binTipId The Bin Tip ID associated with this Bin
+ * @property {string} [packrunId] The Packrun ID associated with this Bin
+ * @property {Date} [createdTimestamp] When this Bin was Created
+ * @property {?string} [binNumber] A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+ * @property {?string} [timeBatchId] The Time Batch ID associated with this Bin
+ * @property {?number} [fullWeight] The Full Weight for this Bin
+ * @property {?number} [emptyWeight] The Empty Weight for this Bin
+ * @property {?string} [fullBinWeightId] The `BinTipWeight` ID as the Source for the Full Weight of this Bin
+ * @property {?string} [emptyBinWeightId] The `BinTipWeight` ID as the Source for the Empty Weight of this Bin
+ * @property {?Object} [freshPackFieldBinWeightApi] The FreshPack Field Bin Weight API Data
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * The Update Data for a Bin Tip Bin
+ * 
+ * @typedef {Object} BinTipBinController.UpdateData
+ * @property {string} [binTipId] The Bin Tip ID associated with this Bin
+ * @property {Date} [createdTimestamp] When this Bin was Created
+ * @property {?string} [binNumber] A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+ * @property {?string} [timeBatchId] The Time Batch ID associated with this Bin
+ * @property {?number} [fullWeight] The Full Weight for this Bin
+ * @property {?number} [emptyWeight] The Empty Weight for this Bin
+ * @property {?string} [fullBinWeightId] The `BinTipWeight` ID as the Source for the Full Weight of this Bin
+ * @property {?string} [emptyBinWeightId] The `BinTipWeight` ID as the Source for the Empty Weight of this Bin
+ * @property {?Object} [freshPackFieldBinWeightApi] The FreshPack Field Bin Weight API Data
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **CommentItem** Type
+ * 
+ * @typedef {Object} BinTipBinController.CommentItem
+ * @property {string} id The Comment ID
+ * @property {?string} content The Content of the Comment
+ * @property {?Date} createdTimestamp When the Comment was Created
+ * @property {?Date} updatedTimestamp When the Comment was last Updated
+ * @memberof Controllers.Packhouse.Site
+ */

package/src/Controllers/Packhouse/Site/CompacSizerController.js

@@ -150,7 +150,7 @@ export default CompacSizerController;
  * @property {?number} [rtuId] The RTU this Compac Sizer belongs to
  * @property {string} [name] The Compac Sizer Name
  * @property {string} [sizerType] The Sizer Type
- * @property {string} [packingLineId] The Packing Line ID this Compac Sizer belongs to
+ * @property {string} [packingLineId] The Packing Line ID that manages this Compac Sizer
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -166,7 +166,7 @@ export default CompacSizerController;
  * @property {string} sizerType The Sizer Type
  * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this Compac Sizer
  * @property {Object[]} [fruitSizes] The Fruit Sizes defined and handled by this Compac Sizer
- * @property {string} packingLineId The Packing Line ID this Compac Sizer belongs to
+ * @property {string} packingLineId The Packing Line ID that manages this Compac Sizer
  * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Compac Sizer
  * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Compac Sizer
  * @memberof Controllers.Packhouse.Site
@@ -183,7 +183,7 @@ export default CompacSizerController;
  * @property {string} [sizerType] The Sizer Type
  * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this Compac Sizer
  * @property {Object[]} [fruitSizes] The Fruit Sizes defined and handled by this Compac Sizer
- * @property {string} [packingLineId] The Packing Line ID this Compac Sizer belongs to
+ * @property {string} [packingLineId] The Packing Line ID that manages this Compac Sizer
  * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Compac Sizer
  * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Compac Sizer
  * @memberof Controllers.Packhouse.Site