RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

FreshPackFruitTemperatureController

Controller Class for FreshPack Fruit Temperatures

Constructor

new FreshPackFruitTemperatureController()

Source

Methods

static

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

Create a FreshPack Fruit Temperature [POST /packhouse/sites/{siteId}/freshpack-fruit-temperatures]

Parameters

  • siteId number

    The Site ID

  • createData FreshPackFruitTemperatureController.CreateData

    The FreshPack Fruit Temperature Create Data

Returns

  • Promise.<FreshPackFruitTemperatureModel>

Source

static

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

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

Create a Comment for a FreshPack Fruit Temperature

Parameters

  • siteId number

    The Site ID

  • id string

    The FreshPack Fruit Temperature ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<FreshPackFruitTemperatureController.CommentItem>

Source

static

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

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

Delete a Comment for a FreshPack Fruit Temperature

Parameters

  • siteId number

    The Site ID

  • id string

    The FreshPack Fruit Temperature ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

List all FreshPack Fruit Temperatures [GET /packhouse/sites/{siteId}/freshpack-fruit-temperatures]

Parameters

  • siteId number

    The Site ID

  • queryParameters FreshPackFruitTemperatureController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<FreshPackFruitTemperatureModel>>

Source

static

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

Retrieve Comments [GET /packhouse/sites/{siteId}/freshpack-fruit-temperatures/{id}/comments]

Retrieves Comments for a FreshPack Fruit Temperature

Parameters

  • siteId number

    The Site ID

  • id string

    The FreshPack Fruit Temperature ID

Returns

  • Promise.<Array.<FreshPackFruitTemperatureController.CommentItem>>

Source

static

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

Retrieve a FreshPack Fruit Temperature [GET /packhouse/sites/{siteId}/freshpack-fruit-temperatures/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The FreshPack Fruit Temperature ID

Returns

  • Promise.<FreshPackFruitTemperatureModel>

Source

static

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

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

Retrieves Comments for a FreshPack Fruit Temperature

Parameters

  • siteId number

    The Site ID

  • id string

    The FreshPack Fruit Temperature ID

  • commentId string

    The Comment ID

Returns

  • Promise.<FreshPackFruitTemperatureController.CommentItem>

Source

static

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

Update a FreshPack Fruit Temperature [PATCH /packhouse/sites/{siteId}/freshpack-fruit-temperatures/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The FreshPack Fruit Temperature ID

  • updateData FreshPackFruitTemperatureController.UpdateData

    The FreshPack Fruit Temperature Update Data

Returns

  • Promise.<FreshPackFruitTemperatureModel>

Source

static

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

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

Update a Comment for a FreshPack Fruit Temperature

Parameters

  • siteId number

    The Site ID

  • id string

    The FreshPack Fruit Temperature ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<FreshPackFruitTemperatureController.CommentItem>

Source

Type Definitions

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount FreshPackFruitTemperatureController.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 Fruit Temperature

Type

  • Object

Properties

  • binTipId string

    The Bin Tip ID this Fruit Temperature is associated with

  • freshPackBinLotId string <optional>

    The Fresh Pack Bin Lot ID this Fruit Temperature is associated with

  • createdTimestamp Date <optional>

    When this Fruit Temperature was Created

  • temperature number

    The Temperature of the Fruit

  • packrunId string

    The Packrun ID associated with this Fruit Temperature

  • freshPackFruitTemperatureApi FreshPackFruitTemperatureController.FruitTemperatureApiStatus <optional>
    <nullable>

    Result from Interacting with the FreshPack API to Send this Fruit Temperature

Source

FruitTemperatureApiStatus

A FruitTemperatureApiStatus 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 this Fruit Temperature is associated with

  • freshPackBinLotId string <optional>

    The Fresh Pack Bin Lot ID this Fruit Temperature is associated with

  • packrunId string <optional>

    The Packrun ID associated with this Fruit Temperature

  • createdTimestampBegin Date <optional>

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

  • createdTimestampEnd Date <optional>

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

Source

UpdateData

The Update Data for a FreshPack Fruit Temperature

Type

  • Object

Properties

  • binTipId string <optional>

    The Bin Tip ID this Fruit Temperature is associated with

  • createdTimestamp Date <optional>

    When this Fruit Temperature was Created

  • temperature number <optional>

    The Temperature of the Fruit

  • packrunId string <optional>

    The Packrun ID associated with this Fruit Temperature

  • freshPackFruitTemperatureApi FreshPackFruitTemperatureController.FruitTemperatureApiStatus <optional>
    <nullable>

    Result from Interacting with the FreshPack API to Send this Fruit Temperature

Source