/**
* File Auto-Generated by the RICADO Gen 4 PHP API Project
*
* Do Not Edit this File Manually!
*/
import RequestHelper from '../../../RequestHelper';
import SoftSortPackrunSummaryModel from '../../../Models/Packhouse/Site/SoftSortPackrunSummaryModel';
/**
* Controller Class for Soft-Sort Packrun Summaries
*
* @class
*/
class SoftSortPackrunSummaryController
{
/**
* Retrieve a Soft-Sort Packrun Summary [GET /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}]
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Soft-Sort Packrun Summary ID
* @return {Promise<SoftSortPackrunSummaryModel>}
*/
static getOne(siteId, id)
{
return new Promise((resolve, reject) => {
RequestHelper.getRequest(`/packhouse/sites/${siteId}/softsort-packrun-summaries/${id}`)
.then((result) => {
let resolveValue = (function(){
return SoftSortPackrunSummaryModel.fromJSON(result, siteId);
}());
resolve(resolveValue);
})
.catch(error => reject(error));
});
}
/**
* Update a Soft-Sort Packrun Summary [PATCH /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}]
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Soft-Sort Packrun Summary ID
* @param {SoftSortPackrunSummaryController.UpdateData} updateData The Soft-Sort Packrun Summary Update Data
* @return {Promise<SoftSortPackrunSummaryModel>}
*/
static update(siteId, id, updateData)
{
return new Promise((resolve, reject) => {
RequestHelper.patchRequest(`/packhouse/sites/${siteId}/softsort-packrun-summaries/${id}`, updateData)
.then((result) => {
let resolveValue = (function(){
return SoftSortPackrunSummaryModel.fromJSON(result, siteId);
}());
resolve(resolveValue);
})
.catch(error => reject(error));
});
}
/**
* Delete a Soft-Sort Packrun Summary [DELETE /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}]
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Soft-Sort Packrun Summary ID
* @return {Promise<boolean>}
*/
static delete(siteId, id)
{
return new Promise((resolve, reject) => {
RequestHelper.deleteRequest(`/packhouse/sites/${siteId}/softsort-packrun-summaries/${id}`)
.then((result) => {
resolve(result ?? true);
})
.catch(error => reject(error));
});
}
/**
* Retrieve Comments [GET /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments]
*
* Retrieves Comments for a Soft-Sort Packrun Summary
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Soft-Sort Packrun Summary ID
* @return {Promise<Array<SoftSortPackrunSummaryController.CommentItem>>}
*/
static getComments(siteId, id)
{
return new Promise((resolve, reject) => {
RequestHelper.getRequest(`/packhouse/sites/${siteId}/softsort-packrun-summaries/${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' && 'userAccount' in resultItem)
{
resultItemObject.userAccount = (function(){
let userAccountObject = {};
if(typeof resultItem.userAccount === 'object' && 'id' in resultItem.userAccount)
{
userAccountObject.id = (function(){
if(resultItem.userAccount.id === null)
{
return null;
}
if(typeof resultItem.userAccount.id !== 'string')
{
return String(resultItem.userAccount.id);
}
return resultItem.userAccount.id;
}());
}
else
{
userAccountObject.id = null;
}
if(typeof resultItem.userAccount === 'object' && 'firstName' in resultItem.userAccount)
{
userAccountObject.firstName = (function(){
if(resultItem.userAccount.firstName === null)
{
return null;
}
if(typeof resultItem.userAccount.firstName !== 'string')
{
return String(resultItem.userAccount.firstName);
}
return resultItem.userAccount.firstName;
}());
}
else
{
userAccountObject.firstName = null;
}
if(typeof resultItem.userAccount === 'object' && 'lastName' in resultItem.userAccount)
{
userAccountObject.lastName = (function(){
if(resultItem.userAccount.lastName === null)
{
return null;
}
if(typeof resultItem.userAccount.lastName !== 'string')
{
return String(resultItem.userAccount.lastName);
}
return resultItem.userAccount.lastName;
}());
}
else
{
userAccountObject.lastName = null;
}
return userAccountObject;
}());
}
else
{
resultItemObject.userAccount = (function(){
let userAccountDefaultValue = {};
userAccountDefaultValue.id = null;
userAccountDefaultValue.firstName = null;
userAccountDefaultValue.lastName = null;
return userAccountDefaultValue;
}());
}
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}/softsort-packrun-summaries/{id}/comments]
*
* Create a Comment for a Soft-Sort Packrun Summary
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Soft-Sort Packrun Summary ID
* @param {string} content The Content of the New Comment
* @return {Promise<SoftSortPackrunSummaryController.CommentItem>}
*/
static createComment(siteId, id, content)
{
return new Promise((resolve, reject) => {
RequestHelper.postRequest(`/packhouse/sites/${siteId}/softsort-packrun-summaries/${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' && 'userAccount' in result)
{
resultObject.userAccount = (function(){
let userAccountObject = {};
if(typeof result.userAccount === 'object' && 'id' in result.userAccount)
{
userAccountObject.id = (function(){
if(result.userAccount.id === null)
{
return null;
}
if(typeof result.userAccount.id !== 'string')
{
return String(result.userAccount.id);
}
return result.userAccount.id;
}());
}
else
{
userAccountObject.id = null;
}
if(typeof result.userAccount === 'object' && 'firstName' in result.userAccount)
{
userAccountObject.firstName = (function(){
if(result.userAccount.firstName === null)
{
return null;
}
if(typeof result.userAccount.firstName !== 'string')
{
return String(result.userAccount.firstName);
}
return result.userAccount.firstName;
}());
}
else
{
userAccountObject.firstName = null;
}
if(typeof result.userAccount === 'object' && 'lastName' in result.userAccount)
{
userAccountObject.lastName = (function(){
if(result.userAccount.lastName === null)
{
return null;
}
if(typeof result.userAccount.lastName !== 'string')
{
return String(result.userAccount.lastName);
}
return result.userAccount.lastName;
}());
}
else
{
userAccountObject.lastName = null;
}
return userAccountObject;
}());
}
else
{
resultObject.userAccount = (function(){
let userAccountDefaultValue = {};
userAccountDefaultValue.id = null;
userAccountDefaultValue.firstName = null;
userAccountDefaultValue.lastName = null;
return userAccountDefaultValue;
}());
}
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}/softsort-packrun-summaries/{id}/comments/{commentId}]
*
* Retrieves Comments for a Soft-Sort Packrun Summary
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Soft-Sort Packrun Summary ID
* @param {string} commentId The Comment ID
* @return {Promise<SoftSortPackrunSummaryController.CommentItem>}
*/
static getOneComment(siteId, id, commentId)
{
return new Promise((resolve, reject) => {
RequestHelper.getRequest(`/packhouse/sites/${siteId}/softsort-packrun-summaries/${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' && 'userAccount' in result)
{
resultObject.userAccount = (function(){
let userAccountObject = {};
if(typeof result.userAccount === 'object' && 'id' in result.userAccount)
{
userAccountObject.id = (function(){
if(result.userAccount.id === null)
{
return null;
}
if(typeof result.userAccount.id !== 'string')
{
return String(result.userAccount.id);
}
return result.userAccount.id;
}());
}
else
{
userAccountObject.id = null;
}
if(typeof result.userAccount === 'object' && 'firstName' in result.userAccount)
{
userAccountObject.firstName = (function(){
if(result.userAccount.firstName === null)
{
return null;
}
if(typeof result.userAccount.firstName !== 'string')
{
return String(result.userAccount.firstName);
}
return result.userAccount.firstName;
}());
}
else
{
userAccountObject.firstName = null;
}
if(typeof result.userAccount === 'object' && 'lastName' in result.userAccount)
{
userAccountObject.lastName = (function(){
if(result.userAccount.lastName === null)
{
return null;
}
if(typeof result.userAccount.lastName !== 'string')
{
return String(result.userAccount.lastName);
}
return result.userAccount.lastName;
}());
}
else
{
userAccountObject.lastName = null;
}
return userAccountObject;
}());
}
else
{
resultObject.userAccount = (function(){
let userAccountDefaultValue = {};
userAccountDefaultValue.id = null;
userAccountDefaultValue.firstName = null;
userAccountDefaultValue.lastName = null;
return userAccountDefaultValue;
}());
}
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}/softsort-packrun-summaries/{id}/comments/{commentId}]
*
* Update a Comment for a Soft-Sort Packrun Summary
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Soft-Sort Packrun Summary ID
* @param {string} commentId The Comment ID
* @param {string} content The Updated Content for the Comment
* @return {Promise<SoftSortPackrunSummaryController.CommentItem>}
*/
static updateOneComment(siteId, id, commentId, content)
{
return new Promise((resolve, reject) => {
RequestHelper.patchRequest(`/packhouse/sites/${siteId}/softsort-packrun-summaries/${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' && 'userAccount' in result)
{
resultObject.userAccount = (function(){
let userAccountObject = {};
if(typeof result.userAccount === 'object' && 'id' in result.userAccount)
{
userAccountObject.id = (function(){
if(result.userAccount.id === null)
{
return null;
}
if(typeof result.userAccount.id !== 'string')
{
return String(result.userAccount.id);
}
return result.userAccount.id;
}());
}
else
{
userAccountObject.id = null;
}
if(typeof result.userAccount === 'object' && 'firstName' in result.userAccount)
{
userAccountObject.firstName = (function(){
if(result.userAccount.firstName === null)
{
return null;
}
if(typeof result.userAccount.firstName !== 'string')
{
return String(result.userAccount.firstName);
}
return result.userAccount.firstName;
}());
}
else
{
userAccountObject.firstName = null;
}
if(typeof result.userAccount === 'object' && 'lastName' in result.userAccount)
{
userAccountObject.lastName = (function(){
if(result.userAccount.lastName === null)
{
return null;
}
if(typeof result.userAccount.lastName !== 'string')
{
return String(result.userAccount.lastName);
}
return result.userAccount.lastName;
}());
}
else
{
userAccountObject.lastName = null;
}
return userAccountObject;
}());
}
else
{
resultObject.userAccount = (function(){
let userAccountDefaultValue = {};
userAccountDefaultValue.id = null;
userAccountDefaultValue.firstName = null;
userAccountDefaultValue.lastName = null;
return userAccountDefaultValue;
}());
}
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}/softsort-packrun-summaries/{id}/comments/{commentId}]
*
* Delete a Comment for a Soft-Sort Packrun Summary
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Soft-Sort Packrun Summary 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}/softsort-packrun-summaries/${id}/comments/${commentId}`)
.then((result) => {
resolve(result ?? true);
})
.catch(error => reject(error));
});
}
/**
* List all Soft-Sort Packrun Summaries [GET /packhouse/sites/{siteId}/softsort-packrun-summaries]
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {SoftSortPackrunSummaryController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
* @return {Promise<SoftSortPackrunSummaryModel[]>}
*/
static getAll(siteId, queryParameters = {})
{
return new Promise((resolve, reject) => {
RequestHelper.getRequest(`/packhouse/sites/${siteId}/softsort-packrun-summaries`, queryParameters)
.then((result) => {
let resolveValue = (function(){
if(Array.isArray(result) !== true)
{
return [];
}
return result.map((resultItem) => {
return (function(){
return SoftSortPackrunSummaryModel.fromJSON(resultItem, siteId);
}());
});
}());
resolve(resolveValue);
})
.catch(error => reject(error));
});
}
/**
* Create a Soft-Sort Packrun Summary [POST /packhouse/sites/{siteId}/softsort-packrun-summaries]
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {SoftSortPackrunSummaryController.CreateData} createData The Soft-Sort Packrun Summary Create Data
* @return {Promise<SoftSortPackrunSummaryModel>}
*/
static create(siteId, createData)
{
return new Promise((resolve, reject) => {
RequestHelper.postRequest(`/packhouse/sites/${siteId}/softsort-packrun-summaries`, createData)
.then((result) => {
let resolveValue = (function(){
return SoftSortPackrunSummaryModel.fromJSON(result, siteId);
}());
resolve(resolveValue);
})
.catch(error => reject(error));
});
}
}
export default SoftSortPackrunSummaryController;
/**
* The Optional Query Parameters for the getAll Function
*
* @typedef {Object} SoftSortPackrunSummaryController.GetAllQueryParameters
* @property {string} [packingLineId] The Packing Line ID this Summary is associated with
* @property {string} [packrunId] The Packrun ID this Summary is associated with
* @property {?Date} [eventsFinalizedTimestamp] Whether the Soft-Sort Events Data for this Summary has been Finalized
* @property {?boolean} [eventsAccurate] Whether the Soft-Sort Events for this Summary are considered accurate or not
* @property {Date} [createdTimestampBegin] Filter by the Timestamp when this Soft-Sort Packrun Summary was Created. Results Greater than or Equal to Timestamp
* @property {Date} [createdTimestampEnd] Filter by the Timestamp when this Soft-Sort Packrun Summary was Created. Results Less than or Equal to Timestamp
* @memberof Controllers.Packhouse.Site
*/
/**
* The Create Data for a Soft-Sort Packrun Summary
*
* @typedef {Object} SoftSortPackrunSummaryController.CreateData
* @property {string} packingLineId The Packing Line ID this Summary is associated with
* @property {string} [packrunId] The Packrun ID this Summary is associated with
* @property {Date} [createdTimestamp] When this Summary was Created
* @property {number} eventsPerBin The Number of Soft-Sort Events per Bin Tipped
* @property {number} totalEventsCount The Number of Soft-Sort Events that occurred for the Packrun
* @property {number} averageEventsDuration The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds
* @property {number} totalEventsDuration The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds
* @property {?Date} [eventsFinalizedTimestamp] Whether the Soft-Sort Events Data for this Summary has been Finalized
* @property {?boolean} [eventsAccurate] Whether the Soft-Sort Events for this Summary are considered accurate or not
* @property {?string} [eventsNotAccurateReason] A Reason for why the Events for this Summary are not accurate. Applies when `eventsAccurate` is false
* @property {?SoftSortPackrunSummaryController.SoftSortApiStatus} [freshPackSoftSortApi] Results from Interacting with the FreshPack API to Send Soft-Sort Events Data
* @memberof Controllers.Packhouse.Site
*/
/**
* The Update Data for a Soft-Sort Packrun Summary
*
* @typedef {Object} SoftSortPackrunSummaryController.UpdateData
* @property {string} [packingLineId] The Packing Line ID this Summary is associated with
* @property {Date} [createdTimestamp] When this Summary was Created
* @property {number} [eventsPerBin] The Number of Soft-Sort Events per Bin Tipped
* @property {number} [totalEventsCount] The Number of Soft-Sort Events that occurred for the Packrun
* @property {number} [averageEventsDuration] The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds
* @property {number} [totalEventsDuration] The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds
* @property {?Date} [eventsFinalizedTimestamp] Whether the Soft-Sort Events Data for this Summary has been Finalized
* @property {?boolean} [eventsAccurate] Whether the Soft-Sort Events for this Summary are considered accurate or not
* @property {?string} [eventsNotAccurateReason] A Reason for why the Events for this Summary are not accurate. Applies when `eventsAccurate` is false
* @property {?SoftSortPackrunSummaryController.SoftSortApiStatus} [freshPackSoftSortApi] Results from Interacting with the FreshPack API to Send Soft-Sort Events Data
* @memberof Controllers.Packhouse.Site
*/
/**
* A **UserAccount** Type
*
* @typedef {Object} SoftSortPackrunSummaryController.UserAccount
* @property {?string} id The User Account ID
* @property {?string} firstName The User's First Name
* @property {?string} lastName The User's Last Name
* @memberof Controllers.Packhouse.Site
*/
/**
* A **CommentItem** Type
*
* @typedef {Object} SoftSortPackrunSummaryController.CommentItem
* @property {string} id The Comment ID
* @property {SoftSortPackrunSummaryController.UserAccount} userAccount
* @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
*/
/**
* A **SoftSortApiStatus** Type
*
* @typedef {Object} SoftSortPackrunSummaryController.SoftSortApiStatus
* @property {number} requestCount Number of Requests made to the FreshPack API
* @property {?Date} requestTimestamp Timestamp of the last Request made to the FreshPack API
* @property {?number} responseCode Response Code from the last FreshPack API Request
* @property {?string} responseMessage Response Message from the last FreshPack API Request
* @property {boolean} completed Whether Interaction with the FreshPack API has been Completed
* @memberof Controllers.Packhouse.Site
*/source