RICADO Gen 4 API JS Client: ReemoonSizerPackrunSummaryController

ReemoonSizerPackrunSummaryController

Controller Class for Reemoon Sizer Packrun Summaries

Constructor

new ReemoonSizerPackrunSummaryController()

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 15

Methods

static

create(siteId, createData) → {Promise.<ReemoonSizerPackrunSummaryModel>}

Create a Reemoon Sizer Packrun Summary [POST /packhouse/sites/{siteId}/reemoon-sizer-packrun-summaries]

Parameters

siteId number
The Site ID
createData ReemoonSizerPackrunSummaryController.CreateData
The Reemoon Sizer Packrun Summary Create Data

Returns

Promise.<ReemoonSizerPackrunSummaryModel>

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 936

static

createComment(siteId, id, content) → {Promise.<ReemoonSizerPackrunSummaryController.CommentItem>}

Create a Comment [POST /packhouse/sites/{siteId}/reemoon-sizer-packrun-summaries/{id}/comments]

Create a Comment for a Reemoon Sizer Packrun Summary

Parameters

siteId number
The Site ID
id string
The Reemoon Sizer Packrun Summary ID
content string
The Content of the New Comment

Returns

Promise.<ReemoonSizerPackrunSummaryController.CommentItem>

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 300

static

delete(siteId, id) → {Promise.<boolean>}

Delete a Reemoon Sizer Packrun Summary [DELETE /packhouse/sites/{siteId}/reemoon-sizer-packrun-summaries/{id}]

Parameters

siteId number
The Site ID
id string
The Reemoon Sizer Packrun Summary ID

Returns

Promise.<boolean>

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 75

static

deleteOneComment(siteId, id, commentId) → {Promise.<boolean>}

Delete a Comment [DELETE /packhouse/sites/{siteId}/reemoon-sizer-packrun-summaries/{id}/comments/{commentId}]

Delete a Comment for a Reemoon Sizer Packrun Summary

Parameters

siteId number
The Site ID
id string
The Reemoon Sizer Packrun Summary ID
commentId string
The Comment ID

Returns

Promise.<boolean>

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 883

static

getAll(siteId, queryParametersopt) → {Promise.<Array.<ReemoonSizerPackrunSummaryModel>>}

List all Reemoon Sizer Packrun Summaries [GET /packhouse/sites/{siteId}/reemoon-sizer-packrun-summaries]

Parameters

siteId number
The Site ID
queryParameters ReemoonSizerPackrunSummaryController.GetAllQueryParameters <optional>

The Optional Query Parameters

Returns

Promise.<Array.<ReemoonSizerPackrunSummaryModel>>

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 903

static

getComments(siteId, id) → {Promise.<Array.<ReemoonSizerPackrunSummaryController.CommentItem>>}

Retrieve Comments [GET /packhouse/sites/{siteId}/reemoon-sizer-packrun-summaries/{id}/comments]

Retrieves Comments for a Reemoon Sizer Packrun Summary

Parameters

siteId number
The Site ID
id string
The Reemoon Sizer Packrun Summary ID

Returns

Promise.<Array.<ReemoonSizerPackrunSummaryController.CommentItem>>

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 97

static

getOne(siteId, id) → {Promise.<ReemoonSizerPackrunSummaryModel>}

Retrieve a Reemoon Sizer Packrun Summary [GET /packhouse/sites/{siteId}/reemoon-sizer-packrun-summaries/{id}]

Parameters

siteId number
The Site ID
id string
The Reemoon Sizer Packrun Summary ID

Returns

Promise.<ReemoonSizerPackrunSummaryModel>

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 26

static

getOneComment(siteId, id, commentId) → {Promise.<ReemoonSizerPackrunSummaryController.CommentItem>}

Retrieve a Comment [GET /packhouse/sites/{siteId}/reemoon-sizer-packrun-summaries/{id}/comments/{commentId}]

Retrieves Comments for a Reemoon Sizer Packrun Summary

Parameters

siteId number
The Site ID
id string
The Reemoon Sizer Packrun Summary ID
commentId string
The Comment ID

Returns

Promise.<ReemoonSizerPackrunSummaryController.CommentItem>

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 494

static

update(siteId, id, updateData) → {Promise.<ReemoonSizerPackrunSummaryModel>}

Update a Reemoon Sizer Packrun Summary [PATCH /packhouse/sites/{siteId}/reemoon-sizer-packrun-summaries/{id}]

Parameters

siteId number
The Site ID
id string
The Reemoon Sizer Packrun Summary ID
updateData ReemoonSizerPackrunSummaryController.UpdateData
The Reemoon Sizer Packrun Summary Update Data

Returns

Promise.<ReemoonSizerPackrunSummaryModel>

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 51

static

updateOneComment(siteId, id, commentId, content) → {Promise.<ReemoonSizerPackrunSummaryController.CommentItem>}

Update a Comment [PATCH /packhouse/sites/{siteId}/reemoon-sizer-packrun-summaries/{id}/comments/{commentId}]

Update a Comment for a Reemoon Sizer Packrun Summary

Parameters

siteId number
The Site ID
id string
The Reemoon Sizer Packrun Summary ID
commentId string
The Comment ID
content string
The Updated Content for the Comment

Returns

Promise.<ReemoonSizerPackrunSummaryController.CommentItem>

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 689

Type Definitions

CommentItem

A CommentItem Type

Type

Object

Properties

id string

The Comment ID
userAccount ReemoonSizerPackrunSummaryController.UserAccount
content string <nullable>

The Content of the Comment
createdTimestamp Date <nullable>

When the Comment was Created
updatedTimestamp Date <nullable>

When the Comment was last Updated

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 1001

CreateData

The Create Data for a Reemoon Sizer Packrun Summary

Type

Object

Properties

reemoonSizerId string

The Reemoon Sizer ID this Summary is associated with
packrunId string <optional>

The Packrun ID this Summary is associated with
createdTimestamp Date <optional>

When this Summary was Created
timeBatchId string <optional>
<nullable>

The Time Batch this Summary is associated with
outletSummaries Array.<ReemoonSizerPackrunSummaryController.OutletSummary> <optional>

An Array of Packrun Summary Data Objects for each Outlet
initialOutletProducts Array.<ReemoonSizerPackrunSummaryController.InitialOutletProduct> <optional>

An Array that contains the Products initially Assigned to each Outlet

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 966

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

Object

Properties

reemoonSizerId string <optional>

The Reemoon Sizer ID this Summary is associated with
packrunId string <optional>

The Packrun ID this Summary is associated with
timeBatchId string <optional>
<nullable>

The Time Batch this Summary is associated with
createdTimestampBegin Date <optional>

Filter by the Timestamp when this Reemoon Sizer Packrun Summary was Created. Results Greater than or Equal to Timestamp
createdTimestampEnd Date <optional>

Filter by the Timestamp when this Reemoon Sizer Packrun Summary was Created. Results Less than or Equal to Timestamp

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 954

InitialOutletProduct

A InitialOutletProduct Type

Type

Object

Properties

outletNumber number

The Outlet Number
productId number <nullable>

The Product ID assigned to the Outlet
productName string

The Name of the Product assigned to the Outlet

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 1037

OutletSummary

A OutletSummary Type

Type

Object

Properties

name string

The Outlet Name
type string

The Generic Outlet Type
number number

The Outlet Number
totals Array.<ReemoonSizerPackrunSummaryController.OutletTotal>

An Array of Totals for the Outlet

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 1026

OutletTotal

A OutletTotal Type

Type

Object

Properties

classType string <nullable>

The Class Type
fruitSize string

The Fruit Size
packType string <nullable>

The Pack Type
weight number

The Weight expressed in Kilograms
fruitCount number

The Fruit Count
packCount number <nullable>

The Number of Packs

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 1013

UpdateData

The Update Data for a Reemoon Sizer Packrun Summary

Type

Object

Properties

reemoonSizerId string <optional>

The Reemoon Sizer ID this Summary is associated with
createdTimestamp Date <optional>

When this Summary was Created
timeBatchId string <optional>
<nullable>

The Time Batch this Summary is associated with
outletSummaries Array.<ReemoonSizerPackrunSummaryController.OutletSummary> <optional>

An Array of Packrun Summary Data Objects for each Outlet
initialOutletProducts Array.<ReemoonSizerPackrunSummaryController.InitialOutletProduct> <optional>

An Array that contains the Products initially Assigned to each Outlet

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 979

UserAccount

A UserAccount Type

Type

Object

Properties

id string <nullable>

The User Account ID
firstName string <nullable>

The User's First Name
lastName string <nullable>

The User's Last Name

Source

Controllers/Packhouse/Site/ReemoonSizerPackrunSummaryController.js , line 991