RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

RejectBinWeightController

Controller Class for Reject Bin Weights

Constructor

new RejectBinWeightController()

Source

Methods

static

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

Create a Reject Bin Weight [POST /packhouse/sites/{siteId}/reject-bin-weights]

Parameters

  • siteId number

    The Site ID

  • createData RejectBinWeightController.CreateData

    The Reject Bin Weight Create Data

Returns

  • Promise.<RejectBinWeightModel>

Source

static

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

Create a Comment [POST /packhouse/sites/{siteId}/reject-bin-weights/{id}/comments]

Create a Comment for a Reject Bin Weight

Parameters

  • siteId number

    The Site ID

  • id string

    The Reject Bin Weight ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<RejectBinWeightController.CommentItem>

Source

static

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

Delete a Comment [DELETE /packhouse/sites/{siteId}/reject-bin-weights/{id}/comments/{commentId}]

Delete a Comment for a Reject Bin Weight

Parameters

  • siteId number

    The Site ID

  • id string

    The Reject Bin Weight ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

List all Reject Bin Weights [GET /packhouse/sites/{siteId}/reject-bin-weights]

Parameters

  • siteId number

    The Site ID

  • queryParameters RejectBinWeightController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<RejectBinWeightModel>>

Source

static

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

Retrieve Comments [GET /packhouse/sites/{siteId}/reject-bin-weights/{id}/comments]

Retrieves Comments for a Reject Bin Weight

Parameters

  • siteId number

    The Site ID

  • id string

    The Reject Bin Weight ID

Returns

  • Promise.<Array.<RejectBinWeightController.CommentItem>>

Source

static

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

Retrieve a Reject Bin Weight [GET /packhouse/sites/{siteId}/reject-bin-weights/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Reject Bin Weight ID

Returns

  • Promise.<RejectBinWeightModel>

Source

static

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

Retrieve a Comment [GET /packhouse/sites/{siteId}/reject-bin-weights/{id}/comments/{commentId}]

Retrieves Comments for a Reject Bin Weight

Parameters

  • siteId number

    The Site ID

  • id string

    The Reject Bin Weight ID

  • commentId string

    The Comment ID

Returns

  • Promise.<RejectBinWeightController.CommentItem>

Source

static

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

Update a Reject Bin Weight [PATCH /packhouse/sites/{siteId}/reject-bin-weights/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Reject Bin Weight ID

  • updateData RejectBinWeightController.UpdateData

    The Reject Bin Weight Update Data

Returns

  • Promise.<RejectBinWeightModel>

Source

static

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

Update a Comment [PATCH /packhouse/sites/{siteId}/reject-bin-weights/{id}/comments/{commentId}]

Update a Comment for a Reject Bin Weight

Parameters

  • siteId number

    The Site ID

  • id string

    The Reject Bin Weight ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<RejectBinWeightController.CommentItem>

Source

Type Definitions

BeltSource

A BeltSource Type

Type

  • Object

Properties

  • type string

    Type of this Reject Bin Source

  • beltName string <nullable>

    Name of the Belt

  • weights Array.<{classType: string, weight: number, fruitCount: ?number}>

    An Array of Weights by Class Type for this Reject Bin Source

Source

BinWeightApiStatus

Results from Interacting with the FreshPack API to Send Multi-Grower Bin Weights

Type

  • Object

Properties

  • requestCount number

    Number of Requests made to the FreshPack API

  • requestTimestamp Date <nullable>

    Timestamp of the last Request made to the FreshPack API

  • responseCode number <nullable>

    Response Code from the last FreshPack API Request

  • responseMessage string <nullable>

    Response Message from the last FreshPack API Request

  • completed boolean

    Whether Interaction with the FreshPack API has been Completed

Source

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount RejectBinWeightController.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 Reject Bin Weight

Type

  • Object

Properties

  • rejectBinScaleId string

    The Reject Bin Scale ID this Reject Weight is associated with

  • rejectBinId string <optional>

    The Reject Bin ID this Reject Weight is associated with

  • createdTimestamp Date <optional>

    When this Reject Bin Weight was Created

  • packrunId string <optional>
    <nullable>

    The Packrun this Reject Weight is associated with

  • netWeight number

    The Net Weight Captured by the Reject Bin Scale

  • sources Array.<(RejectBinWeightController.SortingTableSource|RejectBinWeightController.BeltSource|RejectBinWeightController.SizerOutletSource|RejectBinWeightController.MixedSource)> <optional>

    The Source Weights that make up the Net Weight

  • freshPackMultiGrowerBinWeights Array.<RejectBinWeightController.FreshPackMultiGrowerBinWeight>

    The Multi-Grower Bin Weights that will be submitted to FreshPack

Source

FreshPackMultiGrowerBinWeight

A FreshPackMultiGrowerBinWeight Type

Type

  • Object

Properties

  • classType string

    The Class Type of this Multi-Grower Bin Weight

  • weight number

    The Net Weight in Kilograms of this Multi-Grower Bin Weight

  • weightApi RejectBinWeightController.BinWeightApiStatus <nullable>

    Results from Interacting with the FreshPack API to Send Multi-Grower Bin Weights

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • rejectBinScaleId string <optional>

    The Reject Bin Scale ID this Reject Weight is associated with

  • rejectBinId string <optional>

    The Reject Bin ID this Reject Weight is associated with

  • packrunId string <optional>
    <nullable>

    The Packrun this Reject Weight is associated with

  • createdTimestampBegin Date <optional>

    Filter by the Timestamp when this Reject Bin Weight was Created. Results Greater than or Equal to Timestamp

  • createdTimestampEnd Date <optional>

    Filter by the Timestamp when this Reject Bin Weight was Created. Results Less than or Equal to Timestamp

Source

MixedSource

A MixedSource Type

Type

  • Object

Properties

  • type string

    Type of this Reject Bin Source

  • mixedNames Array.<string>

    An Array of Mixed Source Names

  • weights Array.<{classType: string, weight: number, fruitCount: ?number}>

    An Array of Weights by Class Type for this Reject Bin Source

Source

SizerOutletSource

A SizerOutletSource Type

Type

  • Object

Properties

  • type string

    Type of this Reject Bin Source

  • sizerId string

    ID of the Sizer Object

  • sizerName string <nullable>

    Name of the Sizer

  • outletNumber number

    Outlet Number of the Sizer Outlet

  • outletName string <nullable>

    Name of the Sizer Outlet

  • weights Array.<{classType: string, weight: number, fruitCount: ?number}>

    An Array of Weights by Class Type for this Reject Bin Source

Source

SortingTableSource

A SortingTableSource Type

Type

  • Object

Properties

  • type string

    Type of this Reject Bin Source

  • sortingTableId string

    ID of the Sorting Table Object

  • sortingTableName string <nullable>

    Name of the Sorting Table

  • weights Array.<{classType: string, weight: number, fruitCount: ?number}>

    An Array of Weights by Class Type for this Reject Bin Source

Source

UpdateData

The Update Data for a Reject Bin Weight

Type

  • Object

Properties

  • rejectBinScaleId string <optional>

    The Reject Bin Scale ID this Reject Weight is associated with

  • createdTimestamp Date <optional>

    When this Reject Bin Weight was Created

  • packrunId string <optional>
    <nullable>

    The Packrun this Reject Weight is associated with

  • netWeight number <optional>

    The Net Weight Captured by the Reject Bin Scale

  • sources Array.<(RejectBinWeightController.SortingTableSource|RejectBinWeightController.BeltSource|RejectBinWeightController.SizerOutletSource|RejectBinWeightController.MixedSource)> <optional>

    The Source Weights that make up the Net Weight

  • freshPackMultiGrowerBinWeights Array.<RejectBinWeightController.FreshPackMultiGrowerBinWeight> <optional>

    The Multi-Grower Bin Weights that will be submitted to FreshPack

Source