RICADO Gen 4 API JS Client: CompacSizerController

CompacSizerController

Controller Class for Compac Sizers

Constructor

new CompacSizerController()

Source

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

Methods

static

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

Create a Compac Sizer [POST /packhouse/sites/{siteId}/compac-sizers]

Parameters

siteId number
The Site ID
createData CompacSizerController.CreateData
The Compac Sizer Create Data

Returns

Promise.<CompacSizerModel>

Source

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

static

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

Delete a Compac Sizer [DELETE /packhouse/sites/{siteId}/compac-sizers/{id}]

Parameters

siteId number
The Site ID
id string
The Compac Sizer ID

Returns

Promise.<boolean>

Source

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

static

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

List all Compac Sizers [GET /packhouse/sites/{siteId}/compac-sizers]

Parameters

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

The Optional Query Parameters

Returns

Promise.<Array.<CompacSizerModel>>

Source

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

static

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

Retrieve a Compac Sizer [GET /packhouse/sites/{siteId}/compac-sizers/{id}]

Parameters

siteId number
The Site ID
id string
The Compac Sizer ID

Returns

Promise.<CompacSizerModel>

Source

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

static

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

Update a Compac Sizer [PATCH /packhouse/sites/{siteId}/compac-sizers/{id}]

Parameters

siteId number
The Site ID
id string
The Compac Sizer ID
updateData CompacSizerController.UpdateData
The Compac Sizer Update Data

Returns

Promise.<CompacSizerModel>

Source

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

Type Definitions

CompacSizerFrame

A CompacSizerFrame Type

Type

Object

Properties

number number

The Frame Number
startLane number

Lane Number where this Frame Begins
endLane number

Lane Number where this Frame Ends
points Object

The Points used by this Frame

Source

Controllers/Packhouse/Site/CompacSizerController.js , line 204

CompacSizerFruitSize

A CompacSizerFruitSize Type

Type

Object

Properties

fruitSize string

The Fruit Size
points Object

The Points used by this Fruit Size Configuration

Source

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

CompacSizerLane

A CompacSizerLane 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/CompacSizerController.js , line 194

CompacSizerOutlet

A CompacSizerOutlet 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/CompacSizerController.js , line 215

CreateData

The Create Data for a Compac Sizer

Type

Object

Properties

rtuId number <optional>
<nullable>

The RTU this Compac Sizer belongs to
name string

The Compac Sizer Name
packingLineId string

The Packing Line ID that manages this Compac Sizer
sizerType string

The Sizer Type
autoCreateBatchDelay number <optional>

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

The Points used by this Compac Sizer
lanes Array.<CompacSizerController.CompacSizerLane> <optional>

The Lanes defined for this Compac Sizer
frames Array.<CompacSizerController.CompacSizerFrame> <optional>

An Optional Array of Frames defined for this Compac Sizer
outlets Array.<CompacSizerController.CompacSizerOutlet> <optional>

The Outlets defined for this Compac Sizer
fruitSizes Array.<CompacSizerController.CompacSizerFruitSize> <optional>

The Fruit Sizes defined and handled by this Compac Sizer
freshPackIntegration CompacSizerController.FreshPackCompacSizerIntegration <optional>
<nullable>

The FreshPack Integration Configuration for this Compac Sizer
sources Array.<(CompacSizerController.RiserSource|CompacSizerController.SizerSource)> <optional>

An Array of Sources that deliver Fruit to this Compac Sizer

Source

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

FreshPackCompacSizerIntegration

A FreshPackCompacSizerIntegration 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/CompacSizerController.js , line 235

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

Object

Properties

rtuId number <optional>
<nullable>

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

The Compac Sizer Name
packingLineId string <optional>

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

The Sizer Type

Source

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

RiserSource

A RiserSource Type

Type

Object

Properties

type string

The Source Type
riserId string

ID of the Riser Object

Source

Controllers/Packhouse/Site/CompacSizerController.js , line 247

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 Compac Sizer

Source

Controllers/Packhouse/Site/CompacSizerController.js , line 256

UpdateData

The Update Data for a Compac Sizer

Type

Object

Properties

name string <optional>

The Compac Sizer Name
packingLineId string <optional>

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

The Sizer Type
autoCreateBatchDelay number <optional>

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

The Points used by this Compac Sizer
lanes Array.<CompacSizerController.CompacSizerLane> <optional>

The Lanes defined for this Compac Sizer
frames Array.<CompacSizerController.CompacSizerFrame> <optional>

An Optional Array of Frames defined for this Compac Sizer
outlets Array.<CompacSizerController.CompacSizerOutlet> <optional>

The Outlets defined for this Compac Sizer
fruitSizes Array.<CompacSizerController.CompacSizerFruitSize> <optional>

The Fruit Sizes defined and handled by this Compac Sizer
freshPackIntegration CompacSizerController.FreshPackCompacSizerIntegration <optional>
<nullable>

The FreshPack Integration Configuration for this Compac Sizer
sources Array.<(CompacSizerController.RiserSource|CompacSizerController.SizerSource)> <optional>

An Array of Sources that deliver Fruit to this Compac Sizer

Source

Controllers/Packhouse/Site/CompacSizerController.js , line 176