/**
* File Auto-Generated by the RICADO Gen 4 PHP API Project
*
* Do Not Edit this File Manually!
*/
import RequestHelper from '../../../RequestHelper';
import SampleResultModel from '../../../Models/Lab/Site/SampleResultModel';
/**
* Controller Class for Sample Results
*
* @class
*/
class SampleResultController
{
/**
* Retrieve a Sample Result [GET /lab/sites/{siteId}/sample-results/{id}]
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Sample Result ID
* @return {Promise<SampleResultModel>}
*/
static getOne(siteId, id)
{
return new Promise((resolve, reject) => {
RequestHelper.getRequest(`/lab/sites/${siteId}/sample-results/${id}`)
.then((result) => {
let resolveValue = (function(){
return SampleResultModel.fromJSON(result, siteId);
}());
resolve(resolveValue);
})
.catch(error => reject(error));
});
}
/**
* Update a Sample Result [PATCH /lab/sites/{siteId}/sample-results/{id}]
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Sample Result ID
* @param {SampleResultController.UpdateData} updateData The Sample Result Update Data
* @return {Promise<SampleResultModel>}
*/
static update(siteId, id, updateData)
{
return new Promise((resolve, reject) => {
RequestHelper.patchRequest(`/lab/sites/${siteId}/sample-results/${id}`, updateData)
.then((result) => {
let resolveValue = (function(){
return SampleResultModel.fromJSON(result, siteId);
}());
resolve(resolveValue);
})
.catch(error => reject(error));
});
}
/**
* Delete a Sample Result [DELETE /lab/sites/{siteId}/sample-results/{id}]
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Sample Result ID
* @return {Promise<boolean>}
*/
static delete(siteId, id)
{
return new Promise((resolve, reject) => {
RequestHelper.deleteRequest(`/lab/sites/${siteId}/sample-results/${id}`)
.then((result) => {
resolve(result ?? true);
})
.catch(error => reject(error));
});
}
/**
* Retrieve Comments [GET /lab/sites/{siteId}/sample-results/{id}/comments]
*
* Retrieves Comments for a Sample Result
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Sample Result ID
* @return {Promise<Array<SampleResultController.CommentItem>>}
*/
static getComments(siteId, id)
{
return new Promise((resolve, reject) => {
RequestHelper.getRequest(`/lab/sites/${siteId}/sample-results/${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 /lab/sites/{siteId}/sample-results/{id}/comments]
*
* Create a Comment for a Sample Result
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Sample Result ID
* @param {string} content The Content of the New Comment
* @return {Promise<SampleResultController.CommentItem>}
*/
static createComment(siteId, id, content)
{
return new Promise((resolve, reject) => {
RequestHelper.postRequest(`/lab/sites/${siteId}/sample-results/${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 /lab/sites/{siteId}/sample-results/{id}/comments/{commentId}]
*
* Retrieves Comments for a Sample Result
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Sample Result ID
* @param {string} commentId The Comment ID
* @return {Promise<SampleResultController.CommentItem>}
*/
static getOneComment(siteId, id, commentId)
{
return new Promise((resolve, reject) => {
RequestHelper.getRequest(`/lab/sites/${siteId}/sample-results/${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 /lab/sites/{siteId}/sample-results/{id}/comments/{commentId}]
*
* Update a Comment for a Sample Result
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Sample Result ID
* @param {string} commentId The Comment ID
* @param {string} content The Updated Content for the Comment
* @return {Promise<SampleResultController.CommentItem>}
*/
static updateOneComment(siteId, id, commentId, content)
{
return new Promise((resolve, reject) => {
RequestHelper.patchRequest(`/lab/sites/${siteId}/sample-results/${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 /lab/sites/{siteId}/sample-results/{id}/comments/{commentId}]
*
* Delete a Comment for a Sample Result
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {string} id The Sample Result ID
* @param {string} commentId The Comment ID
* @return {Promise<boolean>}
*/
static deleteOneComment(siteId, id, commentId)
{
return new Promise((resolve, reject) => {
RequestHelper.deleteRequest(`/lab/sites/${siteId}/sample-results/${id}/comments/${commentId}`)
.then((result) => {
resolve(result ?? true);
})
.catch(error => reject(error));
});
}
/**
* List all Sample Results [GET /lab/sites/{siteId}/sample-results]
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {SampleResultController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
* @return {Promise<SampleResultModel[]>}
*/
static getAll(siteId, queryParameters = {})
{
return new Promise((resolve, reject) => {
RequestHelper.getRequest(`/lab/sites/${siteId}/sample-results`, queryParameters)
.then((result) => {
let resolveValue = (function(){
if(Array.isArray(result) !== true)
{
return [];
}
return result.map((resultItem) => {
return (function(){
return SampleResultModel.fromJSON(resultItem, siteId);
}());
});
}());
resolve(resolveValue);
})
.catch(error => reject(error));
});
}
/**
* Create a Sample Result [POST /lab/sites/{siteId}/sample-results]
*
* @static
* @public
* @param {number} siteId The Site ID
* @param {SampleResultController.CreateData} createData The Sample Result Create Data
* @return {Promise<SampleResultModel>}
*/
static create(siteId, createData)
{
return new Promise((resolve, reject) => {
RequestHelper.postRequest(`/lab/sites/${siteId}/sample-results`, createData)
.then((result) => {
let resolveValue = (function(){
return SampleResultModel.fromJSON(result, siteId);
}());
resolve(resolveValue);
})
.catch(error => reject(error));
});
}
}
export default SampleResultController;
/**
* The Optional Query Parameters for the getAll Function
*
* @typedef {Object} SampleResultController.GetAllQueryParameters
* @property {string} [labId] The Lab ID this Sample Result is associated with
* @property {string} [sampleId] The Sample ID this Sample Result is associated with
* @property {Date} [createdTimestampBegin] Filter by the Timestamp when Sample Results were Created. Results Greater than or Equal to Timestamp
* @property {Date} [createdTimestampEnd] Filter by the Timestamp when Sample Results were Created. Results Less than or Equal to Timestamp
* @memberof Controllers.Lab.Site
*/
/**
* The Create Data for a Sample Result
*
* @typedef {Object} SampleResultController.CreateData
* @property {string} labId The Lab ID this Sample Result is associated with
* @property {string} [sampleId] The Sample ID this Sample Result is associated with
* @property {Date} [createdTimestamp] When this Sample Result was Created
* @property {number} totalDuration The Total Duration (in seconds) of the Sample
* @property {number} warmUpDuration The Warm Up Duration (in seconds) of the Sample
* @property {?Date} [warmUpCompletedTimestamp] Timestamp of when the Warm Up process was Completed - `null` if not Completed
* @property {number} belowTargetDuration The Below Temperature Target Duration (in seconds) of the Sample
* @property {number} aboveTargetDuration The Above Temperature Target Duration (in seconds) of the Sample
* @property {number} withinTargetDuration The Within Temperature Target Duration (in seconds) of the Sample
* @property {?Date} [finishCriteriaMetTimestamp] Timestamp of when the Finish Criteria was Met for the Sample - `null` if not Met
* @property {?Date} [latestUnloadTimestamp] Latest Possible Timestamp of when the Sample should have been Unloaded to remain Compliant
* @property {?number} [totalAverageTemperature] The Average Temperature for the Total Duration of the Sample
* @property {?number} [warmUpRateOfChangeTemperature] The Average Temperature Rate-of-Change seen during the Warm Up process for the Sample
* @property {?number} [belowTargetMinimumTemperature] The Minimum Temperature seen Below the Temperature Target for the Sample
* @property {?number} [belowTargetAverageTemperature] The Average Temperature seen Below the Temperature Target for the Sample
* @property {?number} [aboveTargetMaximumTemperature] The Maximum Temperature seen Above the Temperature Target for the Sample
* @property {?number} [aboveTargetAverageTemperature] The Average Temperature seen Above the Temperature Target for the Sample
* @property {?number} [withinTargetMinimumTemperature] The Minimum Temperature seen Within the Temperature Target for the Sample
* @property {?number} [withinTargetMaximumTemperature] The Maximum Temperature seen Within the Temperature Target for the Sample
* @property {?number} [withinTargetAverageTemperature] The Average Temperature seen Within the Temperature Target for the Sample
* @memberof Controllers.Lab.Site
*/
/**
* The Update Data for a Sample Result
*
* @typedef {Object} SampleResultController.UpdateData
* @property {string} [labId] The Lab ID this Sample Result is associated with
* @property {Date} [createdTimestamp] When this Sample Result was Created
* @property {number} [totalDuration] The Total Duration (in seconds) of the Sample
* @property {number} [warmUpDuration] The Warm Up Duration (in seconds) of the Sample
* @property {?Date} [warmUpCompletedTimestamp] Timestamp of when the Warm Up process was Completed - `null` if not Completed
* @property {number} [belowTargetDuration] The Below Temperature Target Duration (in seconds) of the Sample
* @property {number} [aboveTargetDuration] The Above Temperature Target Duration (in seconds) of the Sample
* @property {number} [withinTargetDuration] The Within Temperature Target Duration (in seconds) of the Sample
* @property {?Date} [finishCriteriaMetTimestamp] Timestamp of when the Finish Criteria was Met for the Sample - `null` if not Met
* @property {?Date} [latestUnloadTimestamp] Latest Possible Timestamp of when the Sample should have been Unloaded to remain Compliant
* @property {?number} [totalAverageTemperature] The Average Temperature for the Total Duration of the Sample
* @property {?number} [warmUpRateOfChangeTemperature] The Average Temperature Rate-of-Change seen during the Warm Up process for the Sample
* @property {?number} [belowTargetMinimumTemperature] The Minimum Temperature seen Below the Temperature Target for the Sample
* @property {?number} [belowTargetAverageTemperature] The Average Temperature seen Below the Temperature Target for the Sample
* @property {?number} [aboveTargetMaximumTemperature] The Maximum Temperature seen Above the Temperature Target for the Sample
* @property {?number} [aboveTargetAverageTemperature] The Average Temperature seen Above the Temperature Target for the Sample
* @property {?number} [withinTargetMinimumTemperature] The Minimum Temperature seen Within the Temperature Target for the Sample
* @property {?number} [withinTargetMaximumTemperature] The Maximum Temperature seen Within the Temperature Target for the Sample
* @property {?number} [withinTargetAverageTemperature] The Average Temperature seen Within the Temperature Target for the Sample
* @memberof Controllers.Lab.Site
*/
/**
* A **UserAccount** Type
*
* @typedef {Object} SampleResultController.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.Lab.Site
*/
/**
* A **CommentItem** Type
*
* @typedef {Object} SampleResultController.CommentItem
* @property {string} id The Comment ID
* @property {SampleResultController.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.Lab.Site
*/source