RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

SoftSortPackrunSummaryController

Controller Class for Soft-Sort Packrun Summaries

Constructor

new SoftSortPackrunSummaryController()

Source

Methods

static

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

Create a Soft-Sort Packrun Summary [POST /packhouse/sites/{siteId}/softsort-packrun-summaries]

Parameters

  • siteId number

    The Site ID

  • createData SoftSortPackrunSummaryController.CreateData

    The Soft-Sort Packrun Summary Create Data

Returns

  • Promise.<SoftSortPackrunSummaryModel>

Source

static

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

Create a Comment [POST /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments]

Create a Comment for a Soft-Sort Packrun Summary

Parameters

  • siteId number

    The Site ID

  • id string

    The Soft-Sort Packrun Summary ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<SoftSortPackrunSummaryController.CommentItem>

Source

static

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

Delete a Comment [DELETE /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments/{commentId}]

Delete a Comment for a Soft-Sort Packrun Summary

Parameters

  • siteId number

    The Site ID

  • id string

    The Soft-Sort Packrun Summary ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

List all Soft-Sort Packrun Summaries [GET /packhouse/sites/{siteId}/softsort-packrun-summaries]

Parameters

  • siteId number

    The Site ID

  • queryParameters SoftSortPackrunSummaryController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<SoftSortPackrunSummaryModel>>

Source

static

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

Retrieve Comments [GET /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments]

Retrieves Comments for a Soft-Sort Packrun Summary

Parameters

  • siteId number

    The Site ID

  • id string

    The Soft-Sort Packrun Summary ID

Returns

  • Promise.<Array.<SoftSortPackrunSummaryController.CommentItem>>

Source

static

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

Retrieve a Soft-Sort Packrun Summary [GET /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Soft-Sort Packrun Summary ID

Returns

  • Promise.<SoftSortPackrunSummaryModel>

Source

static

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

Retrieve a Comment [GET /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments/{commentId}]

Retrieves Comments for a Soft-Sort Packrun Summary

Parameters

  • siteId number

    The Site ID

  • id string

    The Soft-Sort Packrun Summary ID

  • commentId string

    The Comment ID

Returns

  • Promise.<SoftSortPackrunSummaryController.CommentItem>

Source

static

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

Update a Soft-Sort Packrun Summary [PATCH /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Soft-Sort Packrun Summary ID

  • updateData SoftSortPackrunSummaryController.UpdateData

    The Soft-Sort Packrun Summary Update Data

Returns

  • Promise.<SoftSortPackrunSummaryModel>

Source

static

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

Update a Comment [PATCH /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments/{commentId}]

Update a Comment for a Soft-Sort Packrun Summary

Parameters

  • siteId number

    The Site ID

  • id string

    The Soft-Sort Packrun Summary ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<SoftSortPackrunSummaryController.CommentItem>

Source

Type Definitions

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount SoftSortPackrunSummaryController.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 Soft-Sort Packrun Summary

Type

  • Object

Properties

  • packingLineId string

    The Packing Line ID this Summary is associated with

  • packrunId string <optional>

    The Packrun ID this Summary is associated with

  • createdTimestamp Date <optional>

    When this Summary was Created

  • eventsPerBin number

    The Number of Soft-Sort Events per Bin Tipped

  • totalEventsCount number

    The Number of Soft-Sort Events that occurred for the Packrun

  • averageEventsDuration number

    The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds

  • totalEventsDuration number

    The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds

  • eventsFinalizedTimestamp Date <optional>
    <nullable>

    Whether the Soft-Sort Events Data for this Summary has been Finalized

  • eventsAccurate boolean <optional>
    <nullable>

    Whether the Soft-Sort Events for this Summary are considered accurate or not

  • eventsNotAccurateReason string <optional>
    <nullable>

    A Reason for why the Events for this Summary are not accurate. Applies when eventsAccurate is false

  • freshPackSoftSortApi SoftSortPackrunSummaryController.SoftSortApiStatus <optional>
    <nullable>

    Results from Interacting with the FreshPack API to Send Soft-Sort Events Data

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • packingLineId string <optional>

    The Packing Line ID this Summary is associated with

  • packrunId string <optional>

    The Packrun ID this Summary is associated with

  • eventsFinalizedTimestamp Date <optional>
    <nullable>

    Whether the Soft-Sort Events Data for this Summary has been Finalized

  • eventsAccurate boolean <optional>
    <nullable>

    Whether the Soft-Sort Events for this Summary are considered accurate or not

  • createdTimestampBegin Date <optional>

    Filter by the Timestamp when this Soft-Sort Packrun Summary was Created. Results Greater than or Equal to Timestamp

  • createdTimestampEnd Date <optional>

    Filter by the Timestamp when this Soft-Sort Packrun Summary was Created. Results Less than or Equal to Timestamp

Source

SoftSortApiStatus

A SoftSortApiStatus 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

UpdateData

The Update Data for a Soft-Sort Packrun Summary

Type

  • Object

Properties

  • packingLineId string <optional>

    The Packing Line ID this Summary is associated with

  • createdTimestamp Date <optional>

    When this Summary was Created

  • eventsPerBin number <optional>

    The Number of Soft-Sort Events per Bin Tipped

  • totalEventsCount number <optional>

    The Number of Soft-Sort Events that occurred for the Packrun

  • averageEventsDuration number <optional>

    The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds

  • totalEventsDuration number <optional>

    The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds

  • eventsFinalizedTimestamp Date <optional>
    <nullable>

    Whether the Soft-Sort Events Data for this Summary has been Finalized

  • eventsAccurate boolean <optional>
    <nullable>

    Whether the Soft-Sort Events for this Summary are considered accurate or not

  • eventsNotAccurateReason string <optional>
    <nullable>

    A Reason for why the Events for this Summary are not accurate. Applies when eventsAccurate is false

  • freshPackSoftSortApi SoftSortPackrunSummaryController.SoftSortApiStatus <optional>
    <nullable>

    Results from Interacting with the FreshPack API to Send Soft-Sort Events Data

Source