RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

ShiftFocusMeetingController

Controller Class for Shift Focus Meetings

Constructor

new ShiftFocusMeetingController()

Source

Methods

static

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

Create a Shift Focus Meeting [POST /packhouse/sites/{siteId}/shift-focus-meetings]

Parameters

  • siteId number

    The Site ID

  • createData ShiftFocusMeetingController.CreateData

    The Shift Focus Meeting Create Data

Returns

  • Promise.<ShiftFocusMeetingModel>

Source

static

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

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

Create a Comment for a Shift Focus Meeting

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Focus Meeting ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<ShiftFocusMeetingController.CommentItem>

Source

static

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

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

Delete a Comment for a Shift Focus Meeting

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Focus Meeting ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

List all Shift Focus Meetings [GET /packhouse/sites/{siteId}/shift-focus-meetings]

Parameters

  • siteId number

    The Site ID

  • queryParameters ShiftFocusMeetingController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<ShiftFocusMeetingModel>>

Source

static

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

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

Retrieves Comments for a Shift Focus Meeting

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Focus Meeting ID

Returns

  • Promise.<Array.<ShiftFocusMeetingController.CommentItem>>

Source

static

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

Retrieve a Shift Focus Meeting [GET /packhouse/sites/{siteId}/shift-focus-meetings/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Focus Meeting ID

Returns

  • Promise.<ShiftFocusMeetingModel>

Source

static

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

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

Retrieves Comments for a Shift Focus Meeting

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Focus Meeting ID

  • commentId string

    The Comment ID

Returns

  • Promise.<ShiftFocusMeetingController.CommentItem>

Source

static

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

Update a Shift Focus Meeting [PATCH /packhouse/sites/{siteId}/shift-focus-meetings/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Focus Meeting ID

  • updateData ShiftFocusMeetingController.UpdateData

    The Shift Focus Meeting Update Data

Returns

  • Promise.<ShiftFocusMeetingModel>

Source

static

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

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

Update a Comment for a Shift Focus Meeting

Parameters

  • siteId number

    The Site ID

  • id string

    The Shift Focus Meeting ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<ShiftFocusMeetingController.CommentItem>

Source

Type Definitions

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount ShiftFocusMeetingController.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 Focus Meeting

Type

  • Object

Properties

  • packingLineId string

    The Packing Line ID this Focus Meeting is associated with

  • shiftId string <optional>

    The Shift ID this Focus Meeting is asssociated with

  • createdTimestamp Date <optional>

    When this Focus Meeting was Created

  • scheduledTimestamp Date <optional>

    When this Focus Meeting is Scheduled to Begin

  • startTimestamp Date <optional>
    <nullable>

    When this Focus Meeting was Started

  • finishTimestamp Date <optional>
    <nullable>

    When this Focus Meeting was Completed

  • nextKeyFocus string <optional>
    <nullable>

    An Optional Key Focus until the Next Meeting

  • successRating number <optional>
    <nullable>

    An Optional Rating between 1 and 10 on how Successful the Focus Meeting was

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • packingLineId string <optional>

    The Packing Line ID this Focus Meeting is associated with

  • shiftId string <optional>

    The Shift ID this Focus Meeting is asssociated with

  • createdTimestampBegin Date <optional>

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

  • createdTimestampEnd Date <optional>

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

  • scheduledTimestampBegin Date <optional>

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

  • scheduledTimestampEnd Date <optional>

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

  • startTimestampBegin Date <optional>

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

  • startTimestampEnd Date <optional>

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

  • finishTimestampBegin Date <optional>

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

  • finishTimestampEnd Date <optional>

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

  • updateTimestampBegin Date <optional>

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

  • updateTimestampEnd Date <optional>

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

Source

UpdateData

The Update Data for a Shift Focus Meeting

Type

  • Object

Properties

  • packingLineId string <optional>

    The Packing Line ID this Focus Meeting is associated with

  • createdTimestamp Date <optional>

    When this Focus Meeting was Created

  • scheduledTimestamp Date <optional>

    When this Focus Meeting is Scheduled to Begin

  • startTimestamp Date <optional>
    <nullable>

    When this Focus Meeting was Started

  • finishTimestamp Date <optional>
    <nullable>

    When this Focus Meeting was Completed

  • nextKeyFocus string <optional>
    <nullable>

    An Optional Key Focus until the Next Meeting

  • successRating number <optional>
    <nullable>

    An Optional Rating between 1 and 10 on how Successful the Focus Meeting was

Source