RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

BinTipBinController

Controller Class for Bin Tip Bins

Constructor

new BinTipBinController()

Source

Methods

static

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

Create a Bin Tip Bin [POST /packhouse/sites/{siteId}/bin-tip-bins]

Parameters

  • siteId number

    The Site ID

  • createData BinTipBinController.CreateData

    The Bin Tip Bin Create Data

Returns

  • Promise.<BinTipBinModel>

Source

static

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

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

Create a Comment for a Bin Tip Bin

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Bin ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<BinTipBinController.CommentItem>

Source

static

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

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

Delete a Comment for a Bin Tip Bin

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Bin ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

List all Bin Tip Bins [GET /packhouse/sites/{siteId}/bin-tip-bins]

Parameters

  • siteId number

    The Site ID

  • queryParameters BinTipBinController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<BinTipBinModel>>

Source

static

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

Retrieve Comments [GET /packhouse/sites/{siteId}/bin-tip-bins/{id}/comments]

Retrieves Comments for a Bin Tip Bin

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Bin ID

Returns

  • Promise.<Array.<BinTipBinController.CommentItem>>

Source

static

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

Retrieve a Bin Tip Bin [GET /packhouse/sites/{siteId}/bin-tip-bins/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Bin ID

Returns

  • Promise.<BinTipBinModel>

Source

static

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

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

Retrieves Comments for a Bin Tip Bin

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Bin ID

  • commentId string

    The Comment ID

Returns

  • Promise.<BinTipBinController.CommentItem>

Source

static

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

Update a Bin Tip Bin [PATCH /packhouse/sites/{siteId}/bin-tip-bins/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Bin ID

  • updateData BinTipBinController.UpdateData

    The Bin Tip Bin Update Data

Returns

  • Promise.<BinTipBinModel>

Source

static

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

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

Update a Comment for a Bin Tip Bin

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Bin ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<BinTipBinController.CommentItem>

Source

Type Definitions

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount BinTipBinController.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 Bin Tip Bin

Type

  • Object

Properties

  • binTipId string

    The Bin Tip ID associated with this Bin

  • packrunId string <optional>

    The Packrun ID associated with this Bin

  • createdTimestamp Date <optional>

    When this Bin was Created

  • binNumber string <optional>
    <nullable>

    A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)

  • binNumberSource string <optional>
    <nullable>

    The Source of the Bin Number

  • timeBatchId string <optional>
    <nullable>

    The Time Batch ID associated with this Bin

  • fullWeight number <optional>
    <nullable>

    The Full Weight for this Bin

  • emptyWeight number <optional>
    <nullable>

    The Empty Weight for this Bin

  • fullBinWeightId string <optional>
    <nullable>

    The BinTipWeight ID as the Source for the Full Weight of this Bin

  • emptyBinWeightId string <optional>
    <nullable>

    The BinTipWeight ID as the Source for the Empty Weight of this Bin

  • freshPackFieldBinWeightApi BinTipBinController.FieldBinWeightApiStatus <optional>
    <nullable>

    Results from Interacting with the FreshPack API to Send Field Bin Weights

Source

FieldBinWeightApiStatus

A FieldBinWeightApiStatus Type

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

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • binTipId string <optional>

    The Bin Tip ID associated with this Bin

  • packrunId string <optional>

    The Packrun ID associated with this Bin

  • binNumber string <optional>
    <nullable>

    A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)

  • binNumberSource string <optional>
    <nullable>

    The Source of the Bin Number

  • fullBinWeightId string <optional>
    <nullable>

    The BinTipWeight ID as the Source for the Full Weight of this Bin

  • emptyBinWeightId string <optional>
    <nullable>

    The BinTipWeight ID as the Source for the Empty Weight of this Bin

  • createdTimestampBegin Date <optional>

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

  • createdTimestampEnd Date <optional>

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

Source

UpdateData

The Update Data for a Bin Tip Bin

Type

  • Object

Properties

  • binTipId string <optional>

    The Bin Tip ID associated with this Bin

  • createdTimestamp Date <optional>

    When this Bin was Created

  • binNumber string <optional>
    <nullable>

    A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)

  • binNumberSource string <optional>
    <nullable>

    The Source of the Bin Number

  • timeBatchId string <optional>
    <nullable>

    The Time Batch ID associated with this Bin

  • fullWeight number <optional>
    <nullable>

    The Full Weight for this Bin

  • emptyWeight number <optional>
    <nullable>

    The Empty Weight for this Bin

  • fullBinWeightId string <optional>
    <nullable>

    The BinTipWeight ID as the Source for the Full Weight of this Bin

  • emptyBinWeightId string <optional>
    <nullable>

    The BinTipWeight ID as the Source for the Empty Weight of this Bin

  • freshPackFieldBinWeightApi BinTipBinController.FieldBinWeightApiStatus <optional>
    <nullable>

    Results from Interacting with the FreshPack API to Send Field Bin Weights

Source