@ricado/api-client 2.3.6 → 2.3.7

package/lib/Controllers/Packhouse/Site/index.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
+var _BinTipBinCardController = _interopRequireDefault(require("./BinTipBinCardController"));
+
 var _BinTipBinController = _interopRequireDefault(require("./BinTipBinController"));
 
 var _BinTipWeightController = _interopRequireDefault(require("./BinTipWeightController"));
@@ -69,6 +71,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @namespace Controllers.Packhouse.Site
  */
 var Site = {
+  BinTipBinCardController: _BinTipBinCardController.default,
   BinTipBinController: _BinTipBinController.default,
   BinTipWeightController: _BinTipWeightController.default,
   CompacSizerBatchController: _CompacSizerBatchController.default,

package/lib/Models/Packhouse/Site/BinTipBinCardModel.js

@@ -0,0 +1,235 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _BaseModel2 = _interopRequireDefault(require("../../../Models/BaseModel"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
+
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
+
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
+
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
+
+/**
+ * Model Class for a Bin Tip Bin Card
+ * 
+ * @class
+ * @hideconstructor
+ * @extends BaseModel
+ */
+var BinTipBinCardModel = /*#__PURE__*/function (_BaseModel) {
+  _inherits(BinTipBinCardModel, _BaseModel);
+
+  var _super = _createSuper(BinTipBinCardModel);
+
+  /**
+   * BinTipBinCardModel Constructor
+   * 
+   * @protected
+   * @param {number} siteId The Site ID associated with this Bin Tip Bin Card
+   */
+  function BinTipBinCardModel(siteId) {
+    var _this;
+
+    _classCallCheck(this, BinTipBinCardModel);
+
+    _this = _super.call(this);
+    /**
+     * The Bin Tip Bin Card ID
+     * 
+     * @type {string}
+     * @public
+     */
+
+    _this.id = "";
+    /**
+     * The Bin Tip ID associated with this Bin Card
+     * 
+     * @type {string}
+     * @public
+     */
+
+    _this.binTipId = "";
+    /**
+     * The Bin ID associated with this Bin Card
+     * 
+     * @type {string}
+     * @public
+     */
+
+    _this.binTipBinId = "";
+    /**
+     * When this Bin Card was Created
+     * 
+     * @type {Date}
+     * @public
+     */
+
+    _this.createdTimestamp = new Date();
+    /**
+     * A Base64 Encoded Image of the Bin Card
+     * 
+     * @type {?string}
+     * @public
+     */
+
+    _this.image = null;
+    /**
+     * Whether the Bin Tip Bin Card has been deleted
+     * 
+     * @type {boolean}
+     * @public
+     */
+
+    _this.deleted = false;
+    /**
+     * When the Bin Tip Bin Card was last updated
+     * 
+     * @type {Date}
+     * @public
+     */
+
+    _this.updateTimestamp = new Date();
+    /**
+     * The Site ID associated with this Bin Tip Bin Card
+     * 
+     * @type {number}
+     * @public
+     */
+
+    _this.siteId = siteId;
+    return _this;
+  }
+  /**
+   * Create a new **BinTipBinCardModel** from a JSON Object or JSON String
+   * 
+   * @static
+   * @public
+   * @param {Object<string, any>|string} json A JSON Object or JSON String
+   * @param {number} siteId The Site ID associated with this Bin Tip Bin Card
+   * @return {BinTipBinCardModel}
+   */
+
+
+  _createClass(BinTipBinCardModel, null, [{
+    key: "fromJSON",
+    value: function fromJSON(json, siteId) {
+      var model = new BinTipBinCardModel(siteId);
+      /**
+       * The JSON Object
+       * 
+       * @type {Object<string, any>}
+       */
+
+      var jsonObject = {};
+
+      if (typeof json === 'string') {
+        jsonObject = JSON.parse(json);
+      } else if (_typeof(json) === 'object') {
+        jsonObject = json;
+      }
+
+      if ('id' in jsonObject) {
+        model.id = function () {
+          if (typeof jsonObject['id'] !== 'string') {
+            return String(jsonObject['id']);
+          }
+
+          return jsonObject['id'];
+        }();
+      }
+
+      if ('binTipId' in jsonObject) {
+        model.binTipId = function () {
+          if (typeof jsonObject['binTipId'] !== 'string') {
+            return String(jsonObject['binTipId']);
+          }
+
+          return jsonObject['binTipId'];
+        }();
+      }
+
+      if ('binTipBinId' in jsonObject) {
+        model.binTipBinId = function () {
+          if (typeof jsonObject['binTipBinId'] !== 'string') {
+            return String(jsonObject['binTipBinId']);
+          }
+
+          return jsonObject['binTipBinId'];
+        }();
+      }
+
+      if ('createdTimestamp' in jsonObject) {
+        model.createdTimestamp = function () {
+          if (typeof jsonObject['createdTimestamp'] !== 'string') {
+            return new Date(String(jsonObject['createdTimestamp']));
+          }
+
+          return new Date(jsonObject['createdTimestamp']);
+        }();
+      }
+
+      if ('image' in jsonObject) {
+        model.image = function () {
+          if (jsonObject['image'] === null) {
+            return null;
+          }
+
+          if (typeof jsonObject['image'] !== 'string') {
+            return String(jsonObject['image']);
+          }
+
+          return jsonObject['image'];
+        }();
+      }
+
+      if ('deleted' in jsonObject) {
+        model.deleted = function () {
+          if (typeof jsonObject['deleted'] !== 'boolean') {
+            return Boolean(jsonObject['deleted']);
+          }
+
+          return jsonObject['deleted'];
+        }();
+      }
+
+      if ('updateTimestamp' in jsonObject) {
+        model.updateTimestamp = function () {
+          if (typeof jsonObject['updateTimestamp'] !== 'string') {
+            return new Date(String(jsonObject['updateTimestamp']));
+          }
+
+          return new Date(jsonObject['updateTimestamp']);
+        }();
+      }
+
+      return model;
+    }
+  }]);
+
+  return BinTipBinCardModel;
+}(_BaseModel2.default);
+
+var _default = BinTipBinCardModel;
+exports.default = _default;

package/lib/Models/Packhouse/Site/index.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
+var _BinTipBinCardModel = _interopRequireDefault(require("./BinTipBinCardModel"));
+
 var _BinTipBinModel = _interopRequireDefault(require("./BinTipBinModel"));
 
 var _BinTipWeightModel = _interopRequireDefault(require("./BinTipWeightModel"));
@@ -69,6 +71,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @namespace Models.Packhouse.Site
  */
 var Site = {
+  BinTipBinCardModel: _BinTipBinCardModel.default,
   BinTipBinModel: _BinTipBinModel.default,
   BinTipWeightModel: _BinTipWeightModel.default,
   CompacSizerBatchModel: _CompacSizerBatchModel.default,

package/lib/PackageVersion.js

@@ -5,5 +5,5 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = void 0;
 // generated by genversion
-var version = '2.3.6';
+var version = '2.3.7';
 exports.version = version;

package/lib/index.d.ts

@@ -3131,6 +3131,7 @@ declare module '@ricado/api-client/Models/Site' {
 declare module '@ricado/api-client/Controllers/Packhouse/Site' {
     export default Site;
     namespace Site {
+        export { BinTipBinCardController };
         export { BinTipBinController };
         export { BinTipWeightController };
         export { CompacSizerBatchController };
@@ -3158,6 +3159,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
         export { SoftSortPackrunSummaryController };
         export { VarietyController };
     }
+    import BinTipBinCardController from "@ricado/api-client/Controllers/Packhouse/Site/BinTipBinCardController";
     import BinTipBinController from "@ricado/api-client/Controllers/Packhouse/Site/BinTipBinController";
     import BinTipWeightController from "@ricado/api-client/Controllers/Packhouse/Site/BinTipWeightController";
     import CompacSizerBatchController from "@ricado/api-client/Controllers/Packhouse/Site/CompacSizerBatchController";
@@ -4724,6 +4726,7 @@ declare module '@ricado/api-client/Controllers/Site/TemporaryObjectController' {
 declare module '@ricado/api-client/Models/Packhouse/Site' {
     export default Site;
     namespace Site {
+        export { BinTipBinCardModel };
         export { BinTipBinModel };
         export { BinTipWeightModel };
         export { CompacSizerBatchModel };
@@ -4751,6 +4754,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
         export { SoftSortPackrunSummaryModel };
         export { VarietyModel };
     }
+    import BinTipBinCardModel from "@ricado/api-client/Models/Packhouse/Site/BinTipBinCardModel";
     import BinTipBinModel from "@ricado/api-client/Models/Packhouse/Site/BinTipBinModel";
     import BinTipWeightModel from "@ricado/api-client/Models/Packhouse/Site/BinTipWeightModel";
     import CompacSizerBatchModel from "@ricado/api-client/Models/Packhouse/Site/CompacSizerBatchModel";
@@ -5379,6 +5383,234 @@ declare module '@ricado/api-client/Models/Site/TemporaryObjectModel' {
     import BaseModel from "@ricado/api-client/Models/BaseModel";
 }
 
+declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBinCardController' {
+    export default BinTipBinCardController;
+    /**
+        * Controller Class for Bin Tip Bin Cards
+        *
+        * @class
+        */
+    class BinTipBinCardController {
+            /**
+                * Retrieve a Bin Tip Bin Card [GET /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @return {Promise<BinTipBinCardModel>}
+                */
+            static getOne(siteId: number, id: string): Promise<BinTipBinCardModel>;
+            /**
+                * Update a Bin Tip Bin Card [PATCH /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @param {BinTipBinCardController.UpdateData} updateData The Bin Tip Bin Card Update Data
+                * @return {Promise<BinTipBinCardModel>}
+                */
+            static update(siteId: number, id: string, updateData: BinTipBinCardController.UpdateData): Promise<BinTipBinCardModel>;
+            /**
+                * Delete a Bin Tip Bin Card [DELETE /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @return {Promise<boolean>}
+                */
+            static delete(siteId: number, id: string): Promise<boolean>;
+            /**
+                * Retrieve Comments [GET /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments]
+                *
+                * Retrieves Comments for a Bin Tip Bin Card
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @return {Promise<Array<BinTipBinCardController.CommentItem>>}
+                */
+            static getComments(siteId: number, id: string): Promise<Array<BinTipBinCardController.CommentItem>>;
+            /**
+                * Create a Comment [POST /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments]
+                *
+                * Create a Comment for a Bin Tip Bin Card
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @param {string} content The Content of the New Comment
+                * @return {Promise<BinTipBinCardController.CommentItem>}
+                */
+            static createComment(siteId: number, id: string, content: string): Promise<BinTipBinCardController.CommentItem>;
+            /**
+                * Retrieve a Comment [GET /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments/{commentId}]
+                *
+                * Retrieves Comments for a Bin Tip Bin Card
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @param {string} commentId The Comment ID
+                * @return {Promise<BinTipBinCardController.CommentItem>}
+                */
+            static getOneComment(siteId: number, id: string, commentId: string): Promise<BinTipBinCardController.CommentItem>;
+            /**
+                * Update a Comment [PATCH /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments/{commentId}]
+                *
+                * Update a Comment for a Bin Tip Bin Card
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @param {string} commentId The Comment ID
+                * @param {string} content The Updated Content for the Comment
+                * @return {Promise<BinTipBinCardController.CommentItem>}
+                */
+            static updateOneComment(siteId: number, id: string, commentId: string, content: string): Promise<BinTipBinCardController.CommentItem>;
+            /**
+                * Delete a Comment [DELETE /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments/{commentId}]
+                *
+                * Delete a Comment for a Bin Tip Bin Card
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @param {string} commentId The Comment ID
+                * @return {Promise<boolean>}
+                */
+            static deleteOneComment(siteId: number, id: string, commentId: string): Promise<boolean>;
+            /**
+                * List all Bin Tip Bin Cards [GET /packhouse/sites/{siteId}/bin-tip-bin-cards]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {BinTipBinCardController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+                * @return {Promise<BinTipBinCardModel[]>}
+                */
+            static getAll(siteId: number, queryParameters?: BinTipBinCardController.GetAllQueryParameters | undefined): Promise<BinTipBinCardModel[]>;
+            /**
+                * Create a Bin Tip Bin Card [POST /packhouse/sites/{siteId}/bin-tip-bin-cards]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {BinTipBinCardController.CreateData} createData The Bin Tip Bin Card Create Data
+                * @return {Promise<BinTipBinCardModel>}
+                */
+            static create(siteId: number, createData: BinTipBinCardController.CreateData): Promise<BinTipBinCardModel>;
+    }
+    namespace BinTipBinCardController {
+            /**
+                * The Optional Query Parameters for the getAll Function
+                */
+            export type GetAllQueryParameters = {
+                    /**
+                        * The Bin Tip ID associated with this Bin Card
+                        */
+                    binTipId?: string;
+                    /**
+                        * The Bin ID associated with this Bin Card
+                        */
+                    binTipBinId?: string;
+                    /**
+                        * Filter by the Timestamp when this Bin Card was Created. Results Greater than or Equal to Timestamp
+                        */
+                    createdTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when this Bin Card was Created. Results Less than or Equal to Timestamp
+                        */
+                    createdTimestampEnd?: Date;
+            };
+            /**
+                * The Create Data for a Bin Tip Bin Card
+                */
+            export type CreateData = {
+                    /**
+                        * The Bin Tip ID associated with this Bin Card
+                        */
+                    binTipId: string;
+                    /**
+                        * The Bin ID associated with this Bin Card
+                        */
+                    binTipBinId?: string;
+                    /**
+                        * When this Bin Card was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * A Base64 Encoded Image of the Bin Card
+                        */
+                    image?: string | null;
+            };
+            /**
+                * The Update Data for a Bin Tip Bin Card
+                */
+            export type UpdateData = {
+                    /**
+                        * The Bin Tip ID associated with this Bin Card
+                        */
+                    binTipId?: string;
+                    /**
+                        * When this Bin Card was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * A Base64 Encoded Image of the Bin Card
+                        */
+                    image?: string | null;
+            };
+            /**
+                * A **UserAccount** Type
+                */
+            export type UserAccount = {
+                    /**
+                        * The User Account ID
+                        */
+                    id: string | null;
+                    /**
+                        * The User's First Name
+                        */
+                    firstName: string | null;
+                    /**
+                        * The User's Last Name
+                        */
+                    lastName: string | null;
+            };
+            /**
+                * A **CommentItem** Type
+                */
+            export type CommentItem = {
+                    /**
+                        * The Comment ID
+                        */
+                    id: string;
+                    userAccount: UserAccount;
+                    /**
+                        * The Content of the Comment
+                        */
+                    content: string | null;
+                    /**
+                        * When the Comment was Created
+                        */
+                    createdTimestamp: Date | null;
+                    /**
+                        * When the Comment was last Updated
+                        */
+                    updatedTimestamp: Date | null;
+            };
+    }
+    import BinTipBinCardModel from "@ricado/api-client/Models/Packhouse/Site/BinTipBinCardModel";
+}
+
 declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBinController' {
     export default BinTipBinController;
     /**
@@ -12865,6 +13097,95 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/VarietyController'
     import VarietyModel from "@ricado/api-client/Models/Packhouse/Site/VarietyModel";
 }
 
+declare module '@ricado/api-client/Models/Packhouse/Site/BinTipBinCardModel' {
+    export default BinTipBinCardModel;
+    /**
+        * Model Class for a Bin Tip Bin Card
+        *
+        * @class
+        * @hideconstructor
+        * @extends BaseModel
+        */
+    class BinTipBinCardModel extends BaseModel {
+            /**
+                * Create a new **BinTipBinCardModel** from a JSON Object or JSON String
+                *
+                * @static
+                * @public
+                * @param {Object<string, any>|string} json A JSON Object or JSON String
+                * @param {number} siteId The Site ID associated with this Bin Tip Bin Card
+                * @return {BinTipBinCardModel}
+                */
+            static fromJSON(json: {
+                    [x: string]: any;
+            } | string, siteId: number): BinTipBinCardModel;
+            /**
+                * BinTipBinCardModel Constructor
+                *
+                * @protected
+                * @param {number} siteId The Site ID associated with this Bin Tip Bin Card
+                */
+            protected constructor();
+            /**
+                * The Bin Tip Bin Card ID
+                *
+                * @type {string}
+                * @public
+                */
+            id: string;
+            /**
+                * The Bin Tip ID associated with this Bin Card
+                *
+                * @type {string}
+                * @public
+                */
+            binTipId: string;
+            /**
+                * The Bin ID associated with this Bin Card
+                *
+                * @type {string}
+                * @public
+                */
+            binTipBinId: string;
+            /**
+                * When this Bin Card was Created
+                *
+                * @type {Date}
+                * @public
+                */
+            createdTimestamp: Date;
+            /**
+                * A Base64 Encoded Image of the Bin Card
+                *
+                * @type {?string}
+                * @public
+                */
+            image: string | null;
+            /**
+                * Whether the Bin Tip Bin Card has been deleted
+                *
+                * @type {boolean}
+                * @public
+                */
+            deleted: boolean;
+            /**
+                * When the Bin Tip Bin Card was last updated
+                *
+                * @type {Date}
+                * @public
+                */
+            updateTimestamp: Date;
+            /**
+                * The Site ID associated with this Bin Tip Bin Card
+                *
+                * @type {number}
+                * @public
+                */
+            siteId: number;
+    }
+    import BaseModel from "@ricado/api-client/Models/BaseModel";
+}
+
 declare module '@ricado/api-client/Models/Packhouse/Site/BinTipBinModel' {
     export default BinTipBinModel;
     /**

package/package.json

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