RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

ShiftGrowerChangeMeetingController

Controller Class for Shift Grower Change Meetings

Constructor

new ShiftGrowerChangeMeetingController()

Source

Methods

static

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

Create a Shift Grower Change Meeting [POST /packhouse/sites/{siteId}/shift-grower-change-meetings]

Parameters

  • siteId number

    The Site ID

  • createData ShiftGrowerChangeMeetingController.CreateData

    The Shift Grower Change Meeting Create Data

Returns

  • Promise.<ShiftGrowerChangeMeetingModel>

Source

static

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

Create a Comment [POST /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}/comments]

Create a Comment for a Shift Grower Change Meeting

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Grower Change Meeting ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<ShiftGrowerChangeMeetingController.CommentItem>

Source

static

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

Delete a Comment [DELETE /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}/comments/{commentId}]

Delete a Comment for a Shift Grower Change Meeting

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Grower Change Meeting ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

List all Shift Grower Change Meetings [GET /packhouse/sites/{siteId}/shift-grower-change-meetings]

Parameters

  • siteId number

    The Site ID

  • queryParameters ShiftGrowerChangeMeetingController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<ShiftGrowerChangeMeetingModel>>

Source

static

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

Retrieve Comments [GET /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}/comments]

Retrieves Comments for a Shift Grower Change Meeting

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Grower Change Meeting ID

Returns

  • Promise.<Array.<ShiftGrowerChangeMeetingController.CommentItem>>

Source

static

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

Retrieve a Shift Grower Change Meeting [GET /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Grower Change Meeting ID

Returns

  • Promise.<ShiftGrowerChangeMeetingModel>

Source

static

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

Retrieve a Comment [GET /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}/comments/{commentId}]

Retrieves Comments for a Shift Grower Change Meeting

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Grower Change Meeting ID

  • commentId string

    The Comment ID

Returns

  • Promise.<ShiftGrowerChangeMeetingController.CommentItem>

Source

static

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

Update a Shift Grower Change Meeting [PATCH /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Grower Change Meeting ID

  • updateData ShiftGrowerChangeMeetingController.UpdateData

    The Shift Grower Change Meeting Update Data

Returns

  • Promise.<ShiftGrowerChangeMeetingModel>

Source

static

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

Update a Comment [PATCH /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}/comments/{commentId}]

Update a Comment for a Shift Grower Change Meeting

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Grower Change Meeting ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<ShiftGrowerChangeMeetingController.CommentItem>

Source

Type Definitions

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount ShiftGrowerChangeMeetingController.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 Shift Grower Change Meeting

Type

  • Object

Properties

  • packingLineId string

    The Packing Line ID this Grower Change Meeting is associated with

  • shiftId string <optional>

    The Shift ID this Grower Change Meeting is asssociated with

  • createdTimestamp Date <optional>

    When this Grower Change Meeting was Created

  • scheduledTimestamp Date <optional>

    When this Grower Change Meeting is Scheduled to Begin

  • startTimestamp Date <optional>
    <nullable>

    When this Grower Change Meeting was Started

  • finishTimestamp Date <optional>
    <nullable>

    When this Grower Change Meeting was Completed

  • packrunId string

    The Packrun ID this Grower Change Meeting relates to

  • usefulRating number <optional>
    <nullable>

    An Optional Rating between 1 and 10 on how Useful the Grower Change Meeting was

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • packingLineId string <optional>

    The Packing Line ID this Grower Change Meeting is associated with

  • shiftId string <optional>

    The Shift ID this Grower Change Meeting is asssociated with

  • packrunId string <optional>

    The Packrun ID this Grower Change Meeting relates to

  • createdTimestampBegin Date <optional>

    Filter by the Timestamp when Grower Change Meetings were Created. Results Greater than or Equal to Timestamp

  • createdTimestampEnd Date <optional>

    Filter by the Timestamp when Grower Change Meetings were Created. Results Less than or Equal to Timestamp

  • scheduledTimestampBegin Date <optional>

    Filter by the Timestamp when Grower Change Meetings were Scheduled to Begin. Results Greater than or Equal to Timestamp

  • scheduledTimestampEnd Date <optional>

    Filter by the Timestamp when Grower Change Meetings were Scheduled to Begin. Results Less than or Equal to Timestamp

  • startTimestampBegin Date <optional>

    Filter by the Timestamp when Grower Change Meetings were Started. Results Greater than or Equal to Timestamp

  • startTimestampEnd Date <optional>

    Filter by the Timestamp when Grower Change Meetings were Started. Results Less than or Equal to Timestamp

  • finishTimestampBegin Date <optional>

    Filter by the Timestamp when Grower Change Meetings were Completed. Results Greater than or Equal to Timestamp

  • finishTimestampEnd Date <optional>

    Filter by the Timestamp when Grower Change Meetings were Completed. Results Less than or Equal to Timestamp

  • updateTimestampBegin Date <optional>

    Filter by the Timestamp when Grower Change Meetings were last Updated. Results Greater than or Equal to Timestamp

  • updateTimestampEnd Date <optional>

    Filter by the Timestamp when Grower Change Meetings were last Updated. Results Less than or Equal to Timestamp

Source

UpdateData

The Update Data for a Shift Grower Change Meeting

Type

  • Object

Properties

  • packingLineId string <optional>

    The Packing Line ID this Grower Change Meeting is associated with

  • createdTimestamp Date <optional>

    When this Grower Change Meeting was Created

  • scheduledTimestamp Date <optional>

    When this Grower Change Meeting is Scheduled to Begin

  • startTimestamp Date <optional>
    <nullable>

    When this Grower Change Meeting was Started

  • finishTimestamp Date <optional>
    <nullable>

    When this Grower Change Meeting was Completed

  • packrunId string <optional>

    The Packrun ID this Grower Change Meeting relates to

  • usefulRating number <optional>
    <nullable>

    An Optional Rating between 1 and 10 on how Useful the Grower Change Meeting was

Source