RICADO Gen 4 API JS Client: MAFSizerPackrunSummaryController

MAFSizerPackrunSummaryController

Controller Class for MAF Sizer Packrun Summaries

Constructor

new MAFSizerPackrunSummaryController()

Source

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

Methods

static

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

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

Parameters

siteId number
The Site ID
createData MAFSizerPackrunSummaryController.CreateData
The MAF Sizer Packrun Summary Create Data

Returns

Promise.<MAFSizerPackrunSummaryModel>

Source

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

static

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

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

Create a Comment for a MAF Sizer Packrun Summary

Parameters

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

Returns

Promise.<MAFSizerPackrunSummaryController.CommentItem>

Source

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

static

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

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

Parameters

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

Returns

Promise.<boolean>

Source

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

static

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

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

Delete a Comment for a MAF Sizer Packrun Summary

Parameters

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

Returns

Promise.<boolean>

Source

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

static

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

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

Parameters

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

The Optional Query Parameters

Returns

Promise.<Array.<MAFSizerPackrunSummaryModel>>

Source

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

static

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

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

Retrieves Comments for a MAF Sizer Packrun Summary

Parameters

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

Returns

Promise.<Array.<MAFSizerPackrunSummaryController.CommentItem>>

Source

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

static

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

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

Parameters

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

Returns

Promise.<MAFSizerPackrunSummaryModel>

Source

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

static

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

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

Retrieves Comments for a MAF Sizer Packrun Summary

Parameters

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

Returns

Promise.<MAFSizerPackrunSummaryController.CommentItem>

Source

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

static

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

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

Parameters

siteId number
The Site ID
id string
The MAF Sizer Packrun Summary ID
updateData MAFSizerPackrunSummaryController.UpdateData
The MAF Sizer Packrun Summary Update Data

Returns

Promise.<MAFSizerPackrunSummaryModel>

Source

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

static

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

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

Update a Comment for a MAF Sizer Packrun Summary

Parameters

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

Returns

Promise.<MAFSizerPackrunSummaryController.CommentItem>

Source

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

Type Definitions

ClassTypeSummary

A ClassTypeSummary Type

Type

Object

Properties

classType string

The Class Type
totals Array.<MAFSizerPackrunSummaryController.ClassTypeTotal>

An Array of Totals for the Class Type

Source

Controllers/Packhouse/Site/MAFSizerPackrunSummaryController.js , line 1029

ClassTypeTotal

A ClassTypeTotal Type

Type

Object

Properties

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/MAFSizerPackrunSummaryController.js , line 1017

CommentItem

A CommentItem Type

Type

Object

Properties

id string

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

CreateData

The Create Data for a MAF Sizer Packrun Summary

Type

Object

Properties

mafSizerId string

The MAF 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
classTypeSummaries Array.<MAFSizerPackrunSummaryController.ClassTypeSummary> <optional>

An Array of Packrun Summary Data Objects for each Class Type
outletSummaries Array.<MAFSizerPackrunSummaryController.OutletSummary> <optional>

An Array of Packrun Summary Data Objects for each Outlet
initialOutletArticles Array.<MAFSizerPackrunSummaryController.InitialOutletArticle> <optional>

An Array that contains the Articles initially Assigned to each Outlet
initialOutletTypes Array.<MAFSizerPackrunSummaryController.InitialOutletType> <optional>

An Array that contains the Types initially configured for each Outlet

Source

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

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

Object

Properties

mafSizerId string <optional>

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

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

Source

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

InitialOutletArticle

A InitialOutletArticle Type

Type

Object

Properties

outletNumber number

The Outlet Number
articleName string <nullable>

The Name of the Article assigned to the Outlet

Source

Controllers/Packhouse/Site/MAFSizerPackrunSummaryController.js , line 1062

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/MAFSizerPackrunSummaryController.js , line 1071

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

An Array of Totals for the Outlet

Source

Controllers/Packhouse/Site/MAFSizerPackrunSummaryController.js , line 1051

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/MAFSizerPackrunSummaryController.js , line 1038

UpdateData

The Update Data for a MAF Sizer Packrun Summary

Type

Object

Properties

mafSizerId string <optional>

The MAF 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
classTypeSummaries Array.<MAFSizerPackrunSummaryController.ClassTypeSummary> <optional>

An Array of Packrun Summary Data Objects for each Class Type
outletSummaries Array.<MAFSizerPackrunSummaryController.OutletSummary> <optional>

An Array of Packrun Summary Data Objects for each Outlet
initialOutletArticles Array.<MAFSizerPackrunSummaryController.InitialOutletArticle> <optional>

An Array that contains the Articles initially Assigned to each Outlet
initialOutletTypes Array.<MAFSizerPackrunSummaryController.InitialOutletType> <optional>

An Array that contains the Types initially configured for each Outlet

Source

Controllers/Packhouse/Site/MAFSizerPackrunSummaryController.js , line 981

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/MAFSizerPackrunSummaryController.js , line 995