RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

BinTipBinCardController

Controller Class for Bin Tip Bin Cards

Constructor

new BinTipBinCardController()

Source

Methods

static

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

Create a Bin Tip Bin Card [POST /packhouse/sites/{siteId}/bin-tip-bin-cards]

Parameters

  • siteId number

    The Site ID

  • createData BinTipBinCardController.CreateData

    The Bin Tip Bin Card Create Data

Returns

  • Promise.<BinTipBinCardModel>

Source

static

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

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

Create a Comment for a Bin Tip Bin Card

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Bin Card ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<BinTipBinCardController.CommentItem>

Source

static

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

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

Delete a Comment for a Bin Tip Bin Card

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Bin Card ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

List all Bin Tip Bin Cards [GET /packhouse/sites/{siteId}/bin-tip-bin-cards]

Parameters

  • siteId number

    The Site ID

  • queryParameters BinTipBinCardController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<BinTipBinCardModel>>

Source

static

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

Retrieve Comments [GET /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments]

Retrieves Comments for a Bin Tip Bin Card

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Bin Card ID

Returns

  • Promise.<Array.<BinTipBinCardController.CommentItem>>

Source

static

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

Retrieve a Bin Tip Bin Card [GET /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Bin Card ID

Returns

  • Promise.<BinTipBinCardModel>

Source

static

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

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

Retrieves Comments for a Bin Tip Bin Card

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Bin Card ID

  • commentId string

    The Comment ID

Returns

  • Promise.<BinTipBinCardController.CommentItem>

Source

static

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

Update a Bin Tip Bin Card [PATCH /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Bin Card ID

  • updateData BinTipBinCardController.UpdateData

    The Bin Tip Bin Card Update Data

Returns

  • Promise.<BinTipBinCardModel>

Source

static

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

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

Update a Comment for a Bin Tip Bin Card

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Bin Card ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<BinTipBinCardController.CommentItem>

Source

Type Definitions

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount BinTipBinCardController.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 Bin Tip Bin Card

Type

  • Object

Properties

  • binTipId string

    The Bin Tip ID associated with this Bin Card

  • binTipBinId string <optional>

    The Bin ID associated with this Bin Card

  • createdTimestamp Date <optional>

    When this Bin Card was Created

  • image string <optional>
    <nullable>

    A Base64 Encoded Image of the Bin Card

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • binTipId string <optional>

    The Bin Tip ID associated with this Bin Card

  • binTipBinId string <optional>

    The Bin ID associated with this Bin Card

  • createdTimestampBegin Date <optional>

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

  • createdTimestampEnd Date <optional>

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

Source

UpdateData

The Update Data for a Bin Tip Bin Card

Type

  • Object

Properties

  • binTipId string <optional>

    The Bin Tip ID associated with this Bin Card

  • createdTimestamp Date <optional>

    When this Bin Card was Created

  • image string <optional>
    <nullable>

    A Base64 Encoded Image of the Bin Card

Source