RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

FreshPackBinLotController

Controller Class for FreshPack Bin Lots

Constructor

new FreshPackBinLotController()

Source

Methods

static

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

Create a FreshPack Bin Lot [POST /packhouse/sites/{siteId}/freshpack-bin-lots]

Parameters

  • siteId number

    The Site ID

  • createData FreshPackBinLotController.CreateData

    The FreshPack Bin Lot Create Data

Returns

  • Promise.<FreshPackBinLotModel>

Source

static

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

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

Create a Comment for a FreshPack Bin Lot

Parameters

  • siteId number

    The Site ID

  • id string

    The FreshPack Bin Lot ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<FreshPackBinLotController.CommentItem>

Source

static

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

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

Delete a Comment for a FreshPack Bin Lot

Parameters

  • siteId number

    The Site ID

  • id string

    The FreshPack Bin Lot ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

List all FreshPack Bin Lots [GET /packhouse/sites/{siteId}/freshpack-bin-lots]

Parameters

  • siteId number

    The Site ID

  • queryParameters FreshPackBinLotController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<FreshPackBinLotModel>>

Source

static

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

Retrieve Comments [GET /packhouse/sites/{siteId}/freshpack-bin-lots/{id}/comments]

Retrieves Comments for a FreshPack Bin Lot

Parameters

  • siteId number

    The Site ID

  • id string

    The FreshPack Bin Lot ID

Returns

  • Promise.<Array.<FreshPackBinLotController.CommentItem>>

Source

static

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

Retrieve a FreshPack Bin Lot [GET /packhouse/sites/{siteId}/freshpack-bin-lots/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The FreshPack Bin Lot ID

Returns

  • Promise.<FreshPackBinLotModel>

Source

static

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

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

Retrieves Comments for a FreshPack Bin Lot

Parameters

  • siteId number

    The Site ID

  • id string

    The FreshPack Bin Lot ID

  • commentId string

    The Comment ID

Returns

  • Promise.<FreshPackBinLotController.CommentItem>

Source

static

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

Update a FreshPack Bin Lot [PATCH /packhouse/sites/{siteId}/freshpack-bin-lots/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The FreshPack Bin Lot ID

  • updateData FreshPackBinLotController.UpdateData

    The FreshPack Bin Lot Update Data

Returns

  • Promise.<FreshPackBinLotModel>

Source

static

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

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

Update a Comment for a FreshPack Bin Lot

Parameters

  • siteId number

    The Site ID

  • id string

    The FreshPack Bin Lot ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<FreshPackBinLotController.CommentItem>

Source

Type Definitions

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount FreshPackBinLotController.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 FreshPack Bin Lot

Type

  • Object

Properties

  • binTipId string

    The Bin Tip ID this Bin Lot is associated with

  • binLotCode string <optional>

    The Bin Lot Code

  • createdTimestamp Date <optional>

    When this Bin Lot was Created

  • packrunIds Array.<string> <optional>

    An Array of Packrun IDs associated with this Bin Lot

  • binNumbers Array.<string> <optional>

    An Array of Bin Numbers for this Bin Lot

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • binTipId string <optional>

    The Bin Tip ID this Bin Lot is associated with

  • binLotCode string <optional>

    The Bin Lot Code

  • createdTimestampBegin Date <optional>

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

  • createdTimestampEnd Date <optional>

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

Source

UpdateData

The Update Data for a FreshPack Bin Lot

Type

  • Object

Properties

  • binTipId string <optional>

    The Bin Tip ID this Bin Lot is associated with

  • createdTimestamp Date <optional>

    When this Bin Lot was Created

  • packrunIds Array.<string> <optional>

    An Array of Packrun IDs associated with this Bin Lot

  • binNumbers Array.<string> <optional>

    An Array of Bin Numbers for this Bin Lot

Source