RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

PackrunController

Controller Class for Packruns

Constructor

new PackrunController()

Source

Methods

static

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

Create a Packrun [POST /packhouse/sites/{siteId}/packruns]

Parameters

  • siteId number

    The Site ID

  • createData PackrunController.CreateData

    The Packrun Create Data

Returns

  • Promise.<PackrunModel>

Source

static

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

Create a Comment [POST /packhouse/sites/{siteId}/packruns/{id}/comments]

Create a Comment for a Packrun

Parameters

  • siteId number

    The Site ID

  • id string

    The Packrun ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<PackrunController.CommentItem>

Source

static

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

Delete a Comment [DELETE /packhouse/sites/{siteId}/packruns/{id}/comments/{commentId}]

Delete a Comment for a Packrun

Parameters

  • siteId number

    The Site ID

  • id string

    The Packrun ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

List all Packruns [GET /packhouse/sites/{siteId}/packruns]

Parameters

  • siteId number

    The Site ID

  • queryParameters PackrunController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<PackrunModel>>

Source

static

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

Retrieve Comments [GET /packhouse/sites/{siteId}/packruns/{id}/comments]

Retrieves Comments for a Packrun

Parameters

  • siteId number

    The Site ID

  • id string

    The Packrun ID

Returns

  • Promise.<Array.<PackrunController.CommentItem>>

Source

static

getInfeedReport(siteId, id) → {Promise.<PackrunController.PackrunInfeedReport>}

Retrieve a Packrun Infeed Report [GET /packhouse/sites/{siteId}/packruns/{id}/infeedReport]

Retrieves an Infeed Report for a Packrun

Parameters

  • siteId number

    The Site ID

  • id string

    The Packrun ID

Returns

  • Promise.<PackrunController.PackrunInfeedReport>

Source

static

getLatestSummaryData(siteId, id) → {Promise.<PackrunController.PackrunLatestSummaryData>}

Retrive a Packrun's Latest Summary Data [GET /packhouse/sites/{siteId}/packruns/{id}/latestSummaryData]

Retrieves the Latest Summary Data for a Packrun

Parameters

  • siteId number

    The Site ID

  • id string

    The Packrun ID

Returns

  • Promise.<PackrunController.PackrunLatestSummaryData>

Source

static

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

Retrieve a Comment [GET /packhouse/sites/{siteId}/packruns/{id}/comments/{commentId}]

Retrieves Comments for a Packrun

Parameters

  • siteId number

    The Site ID

  • id string

    The Packrun ID

  • commentId string

    The Comment ID

Returns

  • Promise.<PackrunController.CommentItem>

Source

static

getSummaryReport(siteId, id) → {Promise.<PackrunController.PackrunSummaryReport>}

Retrieve a Packrun Summary Report [GET /packhouse/sites/{siteId}/packruns/{id}/summaryReport]

Retrieves a Summary Report for a Packrun

Parameters

  • siteId number

    The Site ID

  • id string

    The Packrun ID

Returns

  • Promise.<PackrunController.PackrunSummaryReport>

Source

static

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

Update a Packrun [PATCH /packhouse/sites/{siteId}/packruns/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Packrun ID

  • updateData PackrunController.UpdateData

    The Packrun Update Data

Returns

  • Promise.<PackrunModel>

Source

static

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

Update a Comment [PATCH /packhouse/sites/{siteId}/packruns/{id}/comments/{commentId}]

Update a Comment for a Packrun

Parameters

  • siteId number

    The Site ID

  • id string

    The Packrun ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<PackrunController.CommentItem>

Source

Type Definitions

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount PackrunController.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

CreateData

The Create Data for a Packrun

Type

  • Object

Properties

  • packingLineId string

    The Packing Line ID this Packrun is associated with

  • name string <optional>

    The Packrun Name

  • createdTimestamp Date <optional>

    When this Packrun was Created

  • growerName string

    The Grower Name for this Packrun

  • growerCode string

    The Grower Code for this Packrun

  • maturityArea string

    The Maturity Area for this Packrun

  • startTimestamp Date <optional>
    <nullable>

    When this Packrun was Started

  • finishTimestamp Date <optional>
    <nullable>

    When this Packrun was Finished

  • varietyId string

    The Variety for this Packrun

  • growingMethodId string <optional>
    <nullable>

    The Growing Method for this Packrun

  • allocatedBins number <optional>

    The Number of Allocated Bins for this Packrun

  • timeBatches Array.<PackrunController.TimeBatch> <optional>

    The Time Batches for this Packrun

  • freshPackGraderId number <optional>
    <nullable>

    The FreshPack Grader ID associated with this Packrun

  • freshPackBinLotCode string <optional>
    <nullable>

    The FreshPack Bin Lot Code associated with this Packrun

  • freshPackProduceCode string <optional>
    <nullable>

    The FreshPack Produce Code associated with this Packrun

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • packingLineId string <optional>

    The Packing Line ID this Packrun is associated with

  • name string <optional>

    The Packrun Name

  • growerName string <optional>

    The Grower Name for this Packrun

  • growerCode string <optional>

    The Grower Code for this Packrun

  • maturityArea string <optional>

    The Maturity Area for this Packrun

  • startTimestamp Date <optional>
    <nullable>

    When this Packrun was Started

  • finishTimestamp Date <optional>
    <nullable>

    When this Packrun was Finished

  • varietyId string <optional>

    The Variety for this Packrun

  • growingMethodId string <optional>
    <nullable>

    The Growing Method for this Packrun

  • freshPackGraderId number <optional>
    <nullable>

    The FreshPack Grader ID associated with this Packrun

  • freshPackBinLotCode string <optional>
    <nullable>

    The FreshPack Bin Lot Code associated with this Packrun

  • createdTimestampBegin Date <optional>

    Filter by the Timestamp when this Packrun was Created. Results Greater than or Equal to Timestamp

  • createdTimestampEnd Date <optional>

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

  • startTimestampBegin Date <optional>

    Filter by the Timestamp when this Packrun was Started. Results Greater than or Equal to Timestamp

  • startTimestampEnd Date <optional>

    Filter by the Timestamp when this Packrun was Started. Results Less than or Equal to Timestamp

  • finishTimestampBegin Date <optional>

    Filter by the Timestamp when this Packrun was Finished. Results Greater than or Equal to Timestamp

  • finishTimestampEnd Date <optional>

    Filter by the Timestamp when this Packrun was Finished. Results Less than or Equal to Timestamp

Source

GrowingMethodItem

The Growing Method for the Packrun

Type

  • Object

Properties

  • id string

    The Growing Method ID

  • code string

    The Growing Method Code

  • name string

    The Growing Method Name

  • description string

    The Growing Method Description

Source

PackrunInfeedReport

A PackrunInfeedReport Type

Type

  • Object

Properties

  • id string

    The Packrun ID

  • name string

    The Packrun Name

  • createdTimestamp Date

    When the Packrun was Created

  • startTimestamp Date <nullable>

    When the Packrun was Started

  • finishTimestamp Date <nullable>

    When the Packrun was Finished

  • packingLineId string

    The Packing Line ID

  • packingLineName string <nullable>

    The Packing Line Name

  • growerName string

    The Grower Name

  • growerCode string

    The Grower Code

  • maturityArea string <nullable>

    The Maturity Area

  • allocatedBins number

    The Number of Bins Allocated for the Packrun

  • tippedBins number

    The Number of Bins Tipped for the Packrun

  • softSortRejectWeight number

    The Total Reject Weight for the Soft-Sort category expressed in kilograms

  • softSortRejectPercentage number

    The Percentage of Packrun Weight categorized as Soft-Sort

  • softSortEventsPerBin number

    The Number of Soft-Sort Events per Bin

  • totalSoftSortEventsCount number

    The Number of Soft-Sort Events that occurred for the Packrun

  • averageSoftSortEventsDuration number

    The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds

  • totalSoftSortEventsDuration number

    The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds

  • softSortEventsIsAccurate boolean <nullable>

    Whether the Soft-Sort Events Data is considered accurate or not

  • softSortEventsNotAccurateReason string <nullable>

    A Reason for why the Soft-Sort Events Data is not accurate. Applies when softSortEventsIsAccurate is false

Source

PackrunLatestSummaryData

A PackrunLatestSummaryData Type

Type

  • Object

Properties

  • id string

    The Packrun ID

  • name string

    The Packrun Name

  • createdTimestamp Date

    When the Packrun was Created

  • growerName string

    The Grower Name

  • growerCode string

    The Grower Code

  • maturityArea string <nullable>

    The Maturity Area

  • startTimestamp Date <nullable>

    When the Packrun was Started

  • finishTimestamp Date <nullable>

    When the Packrun was Finished

  • variety PackrunController.VarietyItem

    The Variety for the Packrun

  • growingMethod PackrunController.GrowingMethodItem

    The Growing Method for the Packrun

  • packingLineId string

    The Packing Line ID

  • packingLineName string

    The Packing Line Name

  • status string

    The Status of this Packrun

  • allocatedBins number

    The Number of Bins Allocated for the Packrun

  • tippedBins number

    The Number of Bins Tipped for the Packrun

  • class1FruitSizeProfile Array.<PackrunController.FruitSizeProfileItem>

    An Array of Class 1 Fruit Profiles by Size for the Packrun

  • class1TotalTrays number

    The Total Class 1 Trays for this Packrun

  • class1TraysPerBin number

    The Number of Class 1 Trays per Bin for this Packrun

  • class1AverageFruitSize number

    The Average Class 1 Fruit Size for this Packrun

  • class2TotalTrays number

    The Total Class 2 Trays for this Packrun

  • classTypeTotals Array.<PackrunController.ClassTypePercentageItem>

    An Array of Class Types and their Percentages for this Packrun

Source

PackrunSummaryReport

A PackrunSummaryReport Type

Type

  • Object

Properties

  • id string

    The Packrun ID

  • name string

    The Packrun Name

  • createdTimestamp Date

    When the Packrun was Created

  • growerName string

    The Grower Name

  • growerCode string

    The Grower Code

  • maturityArea string <nullable>

    The Maturity Area

  • startTimestamp Date <nullable>

    When the Packrun was Started

  • finishTimestamp Date <nullable>

    When the Packrun was Finished

  • allocatedBins number

    The Number of Bins Allocated for the Packrun

  • timeBatches Array.<PackrunController.TimeBatchItem>

    The Time Batches for the Packrun

  • variety PackrunController.VarietyItem

    The Variety for the Packrun

  • growingMethod PackrunController.GrowingMethodItem

    The Growing Method for the Packrun

  • packingLineId string

    The Packing Line ID

  • packingLineName string <nullable>

    The Packing Line Name

  • classTypes Array.<PackrunController.ClassTypeItem>

    An Array of Class Types for the Packing Line

  • compacSizers Array.<Object>

    DEPRECATED - An Array of Summarized Compac Sizer Data

  • sizers Array.<PackrunController.SizerItem>
  • incomingSizerIds Array.<string>

    The IDs of the Sizers that directly receive Fruit from the Infeed

  • incomingSizersFruitCount number

    The Incoming Fruit Count of all Incoming Sizers

  • incomingSizersFruitWeight number

    The Incoming Fruit Weight of all Incoming Sizers

  • rejectBinSummary Object

    The Reject Bin Summary for the Packrun

  • binTipSummary Object

    The Bin Tip Summary for the Packrun

  • classTypeTotals Array.<Object>

    An Array of Totals for each Class Type within the Packrun

  • class1SizerSummary Array.<Object>

    An Array of Class 1 Fruit Summaries by Size for all Sizers within the Packrun

  • class1TotalTrays number

    The Total Class 1 Trays for this Packrun

  • class1AverageTrayWeight number

    The Average Class 1 Tray Weight for this Packrun

  • class1FruitSizeProfile Array.<Object>

    An Array of Class 1 Fruit Profiles by Size for the Packrun

  • class1AverageFruitSize number

    The Average Class 1 Fruit Size for this Packrun

  • class1TraysPerBin number

    The Number of Class 1 Trays per Bin for this Packrun

  • class1FreshPackSummary Array.<Object>

    An Array of Class 1 Fruit Summaries by Size from FreshPack for the Packrun

  • class2SizerSummary Array.<Object>

    An Array of Class 2 Fruit Summaries by Size for all Sizers within the Packrun

  • class2TotalTrays number

    The Total Class 2 Trays for this Packrun

  • class2AverageTrayWeight number

    The Average Class 2 Tray Weight for this Packrun

  • class2FreshPackSummary Array.<Object>

    An Array of Class 2 Fruit Summaries by Size from FreshPack for the Packrun

Source

SizerBatchSummaryItem

A SizerBatchSummaryItem Type

Type

  • Object

Properties

  • id string

    The Sizer Batch ID

  • number number

    The Sizer Batch Number

  • name string

    The Sizer Batch Name

  • varietyName string

    The Sizer Variety Name

  • timestamp Date

    The Sizer Batch Timestamp

  • totalFruitCount number

    The Total Fruit Count for the Batch

  • totalFruitWeight number

    The Total Fruit Weight (kg) for the Batch

  • recycleFruitCount number

    The Recycled Fruit Count for the Batch

  • recycleFruitWeight number

    The Recycled Fruit Weight (kg) for the Batch

  • recyclePercentage number

    The Percentage of Total Fruit that was Recycled for the Batch

  • incomingFruitCount number

    The Incoming Fruit Count for the Batch

  • incomingFruitWeight number

    The Incoming Fruit Weight (kg) for the Batch

Source

UpdateData

The Update Data for a Packrun

Type

  • Object

Properties

  • packingLineId string <optional>

    The Packing Line ID this Packrun is associated with

  • createdTimestamp Date <optional>

    When this Packrun was Created

  • growerName string <optional>

    The Grower Name for this Packrun

  • growerCode string <optional>

    The Grower Code for this Packrun

  • maturityArea string <optional>

    The Maturity Area for this Packrun

  • startTimestamp Date <optional>
    <nullable>

    When this Packrun was Started

  • finishTimestamp Date <optional>
    <nullable>

    When this Packrun was Finished

  • varietyId string <optional>

    The Variety for this Packrun

  • growingMethodId string <optional>
    <nullable>

    The Growing Method for this Packrun

  • allocatedBins number <optional>

    The Number of Allocated Bins for this Packrun

  • timeBatches Array.<PackrunController.TimeBatch> <optional>

    The Time Batches for this Packrun

  • freshPackGraderId number <optional>
    <nullable>

    The FreshPack Grader ID associated with this Packrun

  • freshPackBinLotCode string <optional>
    <nullable>

    The FreshPack Bin Lot Code associated with this Packrun

  • freshPackProduceCode string <optional>
    <nullable>

    The FreshPack Produce Code associated with this Packrun

Source

VarietyItem

The Variety for the Packrun

Type

  • Object

Properties

  • id string

    The Variety ID

  • code string

    The Variety Code

  • name string

    The Variety Name

  • description string

    The Variety Description

  • image string

    The Base64 Encoded Image for the Variety

Source