RICADO Gen 4 API JS Client: MAFSizerController

MAFSizerController

Controller Class for MAF Sizers

Constructor

new MAFSizerController()

Source

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

Methods

static

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

Create a MAF Sizer [POST /packhouse/sites/{siteId}/maf-sizers]

Parameters

siteId number
The Site ID
createData MAFSizerController.CreateData
The MAF Sizer Create Data

Returns

Promise.<MAFSizerModel>

Source

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

static

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

Delete a MAF Sizer [DELETE /packhouse/sites/{siteId}/maf-sizers/{id}]

Parameters

siteId number
The Site ID
id string
The MAF Sizer ID

Returns

Promise.<boolean>

Source

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

static

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

List all MAF Sizers [GET /packhouse/sites/{siteId}/maf-sizers]

Parameters

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

The Optional Query Parameters

Returns

Promise.<Array.<MAFSizerModel>>

Source

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

static

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

Retrieve a MAF Sizer [GET /packhouse/sites/{siteId}/maf-sizers/{id}]

Parameters

siteId number
The Site ID
id string
The MAF Sizer ID

Returns

Promise.<MAFSizerModel>

Source

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

static

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

Update a MAF Sizer [PATCH /packhouse/sites/{siteId}/maf-sizers/{id}]

Parameters

siteId number
The Site ID
id string
The MAF Sizer ID
updateData MAFSizerController.UpdateData
The MAF Sizer Update Data

Returns

Promise.<MAFSizerModel>

Source

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

Type Definitions

ArticleClassType

A ArticleClassType Type

Type

Object

Properties

articleName string

Name of the MAF Sizer Article
classType string

The Class Type for this MAF Sizer Article

Source

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

CreateData

The Create Data for a MAF Sizer

Type

Object

Properties

rtuId number <optional>
<nullable>

The RTU this MAF Sizer belongs to
name string

The MAF Sizer Name
packingLineId string

The Packing Line ID that manages this MAF Sizer
sizerType string

The Sizer Type
autoCreateBatchDelay number <optional>

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

The Points used by this MAF Sizer
lanes Array.<MAFSizerController.MAFSizerLane> <optional>

The Lanes defined for this MAF Sizer
outlets Array.<MAFSizerController.MAFSizerOutlet> <optional>

The Outlets defined for this MAF Sizer
fruitSizes Array.<MAFSizerController.MAFSizerFruitSize> <optional>

The Fruit Sizes defined and handled by this MAF Sizer
freshPackIntegration MAFSizerController.FreshPackMAFSizerIntegration <optional>
<nullable>

The FreshPack Integration Configuration for this MAF Sizer
mafIntegration MAFSizerController.MAFSizerIntegration <optional>
<nullable>

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

An Array of Sources that deliver Fruit to this MAF Sizer
articleClassTypes Array.<MAFSizerController.ArticleClassType> <optional>

An Array of Article to Class Type Maps for this MAF Sizer

Source

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

FreshPackMAFSizerIntegration

A FreshPackMAFSizerIntegration 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/MAFSizerController.js , line 226

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

Object

Properties

rtuId number <optional>
<nullable>

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

The MAF Sizer Name
packingLineId string <optional>

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

The Sizer Type

Source

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

MAFSizerFruitSize

A MAFSizerFruitSize Type

Type

Object

Properties

fruitSize string

The Fruit Size
points Object

The Points used by this Fruit Size Configuration

Source

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

MAFSizerIntegration

A MAFSizerIntegration Type

Type

Object

Properties

points Object

The Points used by this MAF Sizer Integration
enabled boolean

Whether this MAF Sizer Integration is Enabled
sizerNumber number

The MAF Internal Number for this Sizer
dumpSizerName string

The MAF Internal Name of this Sizer when interacting with the MAF Dump API
statSizerName string

The MAF Internal Name of this Sizer when interacting with the MAF Sizer Stat API

Source

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

MAFSizerLane

A MAFSizerLane 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/MAFSizerController.js , line 196

MAFSizerOutlet

A MAFSizerOutlet 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/MAFSizerController.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/MAFSizerController.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 MAF Sizer

Source

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

UpdateData

The Update Data for a MAF Sizer

Type

Object

Properties

name string <optional>

The MAF Sizer Name
packingLineId string <optional>

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

The Sizer Type
autoCreateBatchDelay number <optional>

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

The Points used by this MAF Sizer
lanes Array.<MAFSizerController.MAFSizerLane> <optional>

The Lanes defined for this MAF Sizer
outlets Array.<MAFSizerController.MAFSizerOutlet> <optional>

The Outlets defined for this MAF Sizer
fruitSizes Array.<MAFSizerController.MAFSizerFruitSize> <optional>

The Fruit Sizes defined and handled by this MAF Sizer
freshPackIntegration MAFSizerController.FreshPackMAFSizerIntegration <optional>
<nullable>

The FreshPack Integration Configuration for this MAF Sizer
mafIntegration MAFSizerController.MAFSizerIntegration <optional>
<nullable>

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

An Array of Sources that deliver Fruit to this MAF Sizer
articleClassTypes Array.<MAFSizerController.ArticleClassType> <optional>

An Array of Article to Class Type Maps for this MAF Sizer

Source

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