RICADO Gen 4 API JS Client: ReemoonSizerController

ReemoonSizerController

Controller Class for Reemoon Sizers

Constructor

new ReemoonSizerController()

Source

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

Methods

static

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

Create a Reemoon Sizer [POST /packhouse/sites/{siteId}/reemoon-sizers]

Parameters

siteId number
The Site ID
createData ReemoonSizerController.CreateData
The Reemoon Sizer Create Data

Returns

Promise.<ReemoonSizerModel>

Source

Controllers/Packhouse/Site/ReemoonSizerController.js , line 128

static

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

Delete a Reemoon Sizer [DELETE /packhouse/sites/{siteId}/reemoon-sizers/{id}]

Parameters

siteId number
The Site ID
id string
The Reemoon Sizer ID

Returns

Promise.<boolean>

Source

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

static

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

List all Reemoon Sizers [GET /packhouse/sites/{siteId}/reemoon-sizers]

Parameters

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

The Optional Query Parameters

Returns

Promise.<Array.<ReemoonSizerModel>>

Source

Controllers/Packhouse/Site/ReemoonSizerController.js , line 95

static

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

Retrieve a Reemoon Sizer [GET /packhouse/sites/{siteId}/reemoon-sizers/{id}]

Parameters

siteId number
The Site ID
id string
The Reemoon Sizer ID

Returns

Promise.<ReemoonSizerModel>

Source

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

static

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

Update a Reemoon Sizer [PATCH /packhouse/sites/{siteId}/reemoon-sizers/{id}]

Parameters

siteId number
The Site ID
id string
The Reemoon Sizer ID
updateData ReemoonSizerController.UpdateData
The Reemoon Sizer Update Data

Returns

Promise.<ReemoonSizerModel>

Source

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

Type Definitions

CreateData

The Create Data for a Reemoon Sizer

Type

Object

Properties

rtuId number <optional>
<nullable>

The RTU this Reemoon Sizer belongs to
name string

The Reemoon Sizer Name
packingLineId string

The Packing Line ID that manages this Reemoon Sizer
sizerType string

The Sizer Type
autoCreateBatchDelay number <optional>

The Auto Create Batch Delay in Seconds for this Reemoon Sizer
points Object

The Points used by this Reemoon Sizer
lanes Array.<ReemoonSizerController.ReemoonSizerLane> <optional>

The Lanes defined for this Reemoon Sizer
outlets Array.<ReemoonSizerController.ReemoonSizerOutlet> <optional>

The Outlets defined for this Reemoon Sizer
fruitSizes Array.<ReemoonSizerController.ReemoonSizerFruitSize> <optional>

The Fruit Sizes defined and handled by this Reemoon Sizer
freshPackIntegration ReemoonSizerController.FreshPackReemoonSizerIntegration <optional>
<nullable>

The FreshPack Integration Configuration for this Reemoon Sizer
reemoonIntegration ReemoonSizerController.ReemoonSizerIntegration

The Reemoon Integration Configuration for this Reemoon Sizer
sources Array.<(ReemoonSizerController.RiserSource|ReemoonSizerController.SizerSource)> <optional>

An Array of Sources that deliver Fruit to this Reemoon Sizer
productClassTypes Array.<ReemoonSizerController.ProductClassType> <optional>

An Array of Product to Class Type Maps for this Reemoon Sizer

Source

Controllers/Packhouse/Site/ReemoonSizerController.js , line 157

FreshPackReemoonSizerIntegration

A FreshPackReemoonSizerIntegration Type

Type

Object

Properties

points Object

The Points used by this FreshPack Sizer Integration
enabled boolean

Whether this FreshPack Sizer Integration is Enabled
materialGroupId number

The FreshPack Material Group ID to be used for Multi-Grower Bins from this Sizer
binTypeId number

The FreshPack Bin Type ID to be used for Multi-Grower Bins from this Sizer
bulkWeightClassTypes Array.<string>

An Array of Class Types that should be Sent to FreshPack as Bulk Weights in Multi-Grower Bins

Source

Controllers/Packhouse/Site/ReemoonSizerController.js , line 226

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

Object

Properties

rtuId number <optional>
<nullable>

The RTU this Reemoon Sizer belongs to
name string <optional>

The Reemoon Sizer Name
packingLineId string <optional>

The Packing Line ID that manages this Reemoon Sizer
sizerType string <optional>

The Sizer Type

Source

Controllers/Packhouse/Site/ReemoonSizerController.js , line 146

ProductClassType

A ProductClassType Type

Type

Object

Properties

productName string

Name of the Reemoon Sizer Product
classType string

The Class Type for this Reemoon Sizer Product
matchType string

The Match Type used when Evaluating the Product Name

Source

Controllers/Packhouse/Site/ReemoonSizerController.js , line 269

ReemoonSizerFruitSize

A ReemoonSizerFruitSize Type

Type

Object

Properties

fruitSize string

The Fruit Size
points Object

The Points used by this Fruit Size Configuration

Source

Controllers/Packhouse/Site/ReemoonSizerController.js , line 217

ReemoonSizerIntegration

A ReemoonSizerIntegration Type

Type

Object

Properties

points Object

The Points used by this Reemoon Sizer Integration
enabled boolean

Whether this Reemoon Sizer Integration is Enabled
username string

Username for Authenticating with the Reemoon Sizer API
password string

Password for Authenticating with the Reemoon Sizer API
apiBaseUrl string

Base URL of the Reemoon Sizer API

Source

Controllers/Packhouse/Site/ReemoonSizerController.js , line 238

ReemoonSizerLane

A ReemoonSizerLane Type

Type

Object

Properties

id string

Unique ID of this Lane
number number

The Lane Number
points Object

The Points used by this Lane

Source

Controllers/Packhouse/Site/ReemoonSizerController.js , line 196

ReemoonSizerOutlet

A ReemoonSizerOutlet Type

Type

Object

Properties

id string

Unique ID of this Outlet
number number

The Outlet Number
type string

The Outlet Type
points Object

The Points used by this Outlet

Source

Controllers/Packhouse/Site/ReemoonSizerController.js , line 206

RiserSource

A RiserSource Type

Type

Object

Properties

type string

The Source Type
riserId string

ID of the Riser Object

Source

Controllers/Packhouse/Site/ReemoonSizerController.js , line 250

SizerSource

A SizerSource Type

Type

Object

Properties

type string

The Source Type
sizerId string

ID of the Sizer Object
outletNumbers Array.<number>

An Array of Outlet Numbers on the Source Sizer that supply this Reemoon Sizer

Source

Controllers/Packhouse/Site/ReemoonSizerController.js , line 259

UpdateData

The Update Data for a Reemoon Sizer

Type

Object

Properties

name string <optional>

The Reemoon Sizer Name
packingLineId string <optional>

The Packing Line ID that manages this Reemoon Sizer
sizerType string <optional>

The Sizer Type
autoCreateBatchDelay number <optional>

The Auto Create Batch Delay in Seconds for this Reemoon Sizer
points Object <optional>

The Points used by this Reemoon Sizer
lanes Array.<ReemoonSizerController.ReemoonSizerLane> <optional>

The Lanes defined for this Reemoon Sizer
outlets Array.<ReemoonSizerController.ReemoonSizerOutlet> <optional>

The Outlets defined for this Reemoon Sizer
fruitSizes Array.<ReemoonSizerController.ReemoonSizerFruitSize> <optional>

The Fruit Sizes defined and handled by this Reemoon Sizer
freshPackIntegration ReemoonSizerController.FreshPackReemoonSizerIntegration <optional>
<nullable>

The FreshPack Integration Configuration for this Reemoon Sizer
reemoonIntegration ReemoonSizerController.ReemoonSizerIntegration <optional>

The Reemoon Integration Configuration for this Reemoon Sizer
sources Array.<(ReemoonSizerController.RiserSource|ReemoonSizerController.SizerSource)> <optional>

An Array of Sources that deliver Fruit to this Reemoon Sizer
productClassTypes Array.<ReemoonSizerController.ProductClassType> <optional>

An Array of Product to Class Type Maps for this Reemoon Sizer

Source

Controllers/Packhouse/Site/ReemoonSizerController.js , line 177