RICADO Gen 4 API JS Client: CompacSizerPackrunSummaryController

CompacSizerPackrunSummaryController

Controller Class for Compac Sizer Packrun Summaries

Constructor

new CompacSizerPackrunSummaryController()

Source

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

Methods

static

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

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

Parameters

siteId number
The Site ID
createData CompacSizerPackrunSummaryController.CreateData
The Compac Sizer Packrun Summary Create Data

Returns

Promise.<CompacSizerPackrunSummaryModel>

Source

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

static

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

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

Create a Comment for a Compac Sizer Packrun Summary

Parameters

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

Returns

Promise.<CompacSizerPackrunSummaryController.CommentItem>

Source

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

static

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

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

Parameters

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

Returns

Promise.<boolean>

Source

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

static

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

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

Delete a Comment for a Compac Sizer Packrun Summary

Parameters

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

Returns

Promise.<boolean>

Source

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

static

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

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

Parameters

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

The Optional Query Parameters

Returns

Promise.<Array.<CompacSizerPackrunSummaryModel>>

Source

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

static

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

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

Retrieves Comments for a Compac Sizer Packrun Summary

Parameters

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

Returns

Promise.<Array.<CompacSizerPackrunSummaryController.CommentItem>>

Source

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

static

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

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

Parameters

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

Returns

Promise.<CompacSizerPackrunSummaryModel>

Source

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

static

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

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

Retrieves Comments for a Compac Sizer Packrun Summary

Parameters

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

Returns

Promise.<CompacSizerPackrunSummaryController.CommentItem>

Source

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

static

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

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

Parameters

siteId number
The Site ID
id string
The Compac Sizer Packrun Summary ID
updateData CompacSizerPackrunSummaryController.UpdateData
The Compac Sizer Packrun Summary Update Data

Returns

Promise.<CompacSizerPackrunSummaryModel>

Source

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

static

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

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

Update a Comment for a Compac Sizer Packrun Summary

Parameters

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

Returns

Promise.<CompacSizerPackrunSummaryController.CommentItem>

Source

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

Type Definitions

CommentItem

A CommentItem Type

Type

Object

Properties

id string

The Comment ID
userAccount CompacSizerPackrunSummaryController.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/CompacSizerPackrunSummaryController.js , line 1007

CreateData

The Create Data for a Compac Sizer Packrun Summary

Type

Object

Properties

compacSizerId string

The Compac 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.<CompacSizerPackrunSummaryController.OutletSummary> <optional>

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

An Array that contains the Products initially Assigned to each Outlet
outletProductChanges Array.<CompacSizerPackrunSummaryController.OutletProductChange> <optional>

An Array of Outlet Product Changes
initialOutletTypes Array.<CompacSizerPackrunSummaryController.InitialOutletType> <optional>

An Array that contains the Types initially configured for each Outlet
outletTypeChanges Array.<CompacSizerPackrunSummaryController.OutletTypeChange> <optional>

An Array of Outlet Type Changes. Only applies to Outlets configured as Dynamic

Source

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

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

Object

Properties

compacSizerId string <optional>

The Compac 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 Compac Sizer Packrun Summary was Created. Results Greater than or Equal to Timestamp
createdTimestampEnd Date <optional>

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

Source

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

InitialOutletProduct

A InitialOutletProduct Type

Type

Object

Properties

outletNumber number

The Outlet Number
productId string

The Product ID assigned to the Outlet
productName string <nullable>

The Name of the Product assigned to the Outlet

Source

Controllers/Packhouse/Site/CompacSizerPackrunSummaryController.js , line 1043

InitialOutletType

A InitialOutletType Type

Type

Object

Properties

outletNumber number

The Outlet Number
type string

The Generic Type configured on the Outlet
typeId string <nullable>

The Type ID configured on the Outlet. Only applies when the type is Dynamic

Source

Controllers/Packhouse/Site/CompacSizerPackrunSummaryController.js , line 1065

OutletProductChange

A OutletProductChange Type

Type

Object

Properties

timestamp Date

When the Outlet Product was Changed
outletNumber number

The Outlet Number
productId string

The new Product ID that has been assigned to the Outlet
productName string <nullable>

The Name of the new Product that has been assigned to the Outlet
outletProductChangeId string

The ID of the associated Compac Sizer Outlet Product Change*

Source

Controllers/Packhouse/Site/CompacSizerPackrunSummaryController.js , line 1053

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.<CompacSizerPackrunSummaryController.OutletTotal>

An Array of Totals for the Outlet

Source

Controllers/Packhouse/Site/CompacSizerPackrunSummaryController.js , line 1032

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/CompacSizerPackrunSummaryController.js , line 1019

OutletTypeChange

A OutletTypeChange Type

Type

Object

Properties

timestamp Date

When the Outlet Type was Changed
outletNumber number

The Outlet Number
typeId string <nullable>

The new Dynamic Type ID that has been configured for the Outlet

Source

Controllers/Packhouse/Site/CompacSizerPackrunSummaryController.js , line 1075

UpdateData

The Update Data for a Compac Sizer Packrun Summary

Type

Object

Properties

compacSizerId string <optional>

The Compac 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.<CompacSizerPackrunSummaryController.OutletSummary> <optional>

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

An Array that contains the Products initially Assigned to each Outlet
outletProductChanges Array.<CompacSizerPackrunSummaryController.OutletProductChange> <optional>

An Array of Outlet Product Changes
initialOutletTypes Array.<CompacSizerPackrunSummaryController.InitialOutletType> <optional>

An Array that contains the Types initially configured for each Outlet
outletTypeChanges Array.<CompacSizerPackrunSummaryController.OutletTypeChange> <optional>

An Array of Outlet Type Changes. Only applies to Outlets configured as Dynamic

Source

Controllers/Packhouse/Site/CompacSizerPackrunSummaryController.js , line 982

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/CompacSizerPackrunSummaryController.js , line 997