RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

CompacSizerOutletTypeChangeController

Controller Class for Compac Sizer Outlet Type Changes

Constructor

new CompacSizerOutletTypeChangeController()

Source

Methods

static

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

Create a Compac Sizer Outlet Type Change [POST /packhouse/sites/{siteId}/compac-sizer-outlet-type-changes]

Parameters

  • siteId number

    The Site ID

  • createData CompacSizerOutletTypeChangeController.CreateData

    The Compac Sizer Outlet Type Change Create Data

Returns

  • Promise.<CompacSizerOutletTypeChangeModel>

Source

static

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

Create a Comment [POST /packhouse/sites/{siteId}/compac-sizer-outlet-type-changes/{id}/comments]

Create a Comment for a Compac Sizer Outlet Type Change

Parameters

  • siteId number

    The Site ID

  • id string

    The Compac Sizer Outlet Type Change ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<CompacSizerOutletTypeChangeController.CommentItem>

Source

static

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

Delete a Comment [DELETE /packhouse/sites/{siteId}/compac-sizer-outlet-type-changes/{id}/comments/{commentId}]

Delete a Comment for a Compac Sizer Outlet Type Change

Parameters

  • siteId number

    The Site ID

  • id string

    The Compac Sizer Outlet Type Change ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

List all Compac Sizer Outlet Type Changes [GET /packhouse/sites/{siteId}/compac-sizer-outlet-type-changes]

Parameters

  • siteId number

    The Site ID

  • queryParameters CompacSizerOutletTypeChangeController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<CompacSizerOutletTypeChangeModel>>

Source

static

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

Retrieve Comments [GET /packhouse/sites/{siteId}/compac-sizer-outlet-type-changes/{id}/comments]

Retrieves Comments for a Compac Sizer Outlet Type Change

Parameters

  • siteId number

    The Site ID

  • id string

    The Compac Sizer Outlet Type Change ID

Returns

  • Promise.<Array.<CompacSizerOutletTypeChangeController.CommentItem>>

Source

static

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

Retrieve a Compac Sizer Outlet Type Change [GET /packhouse/sites/{siteId}/compac-sizer-outlet-type-changes/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Compac Sizer Outlet Type Change ID

Returns

  • Promise.<CompacSizerOutletTypeChangeModel>

Source

static

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

Retrieve a Comment [GET /packhouse/sites/{siteId}/compac-sizer-outlet-type-changes/{id}/comments/{commentId}]

Retrieves Comments for a Compac Sizer Outlet Type Change

Parameters

  • siteId number

    The Site ID

  • id string

    The Compac Sizer Outlet Type Change ID

  • commentId string

    The Comment ID

Returns

  • Promise.<CompacSizerOutletTypeChangeController.CommentItem>

Source

static

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

Update a Compac Sizer Outlet Type Change [PATCH /packhouse/sites/{siteId}/compac-sizer-outlet-type-changes/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Compac Sizer Outlet Type Change ID

  • updateData CompacSizerOutletTypeChangeController.UpdateData

    The Compac Sizer Outlet Type Change Update Data

Returns

  • Promise.<CompacSizerOutletTypeChangeModel>

Source

static

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

Update a Comment [PATCH /packhouse/sites/{siteId}/compac-sizer-outlet-type-changes/{id}/comments/{commentId}]

Update a Comment for a Compac Sizer Outlet Type Change

Parameters

  • siteId number

    The Site ID

  • id string

    The Compac Sizer Outlet Type Change ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<CompacSizerOutletTypeChangeController.CommentItem>

Source

Type Definitions

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount CompacSizerOutletTypeChangeController.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 Compac Sizer Outlet Type Change

Type

  • Object

Properties

  • compacSizerId string

    The Compac Sizer ID this Outlet Type Change is associated with

  • outletNumber string <optional>

    The Sizer Outlet Number this Outlet Type Change is associated with

  • createdTimestamp Date <optional>

    When this Outlet Type Change occurred

  • previousTypeId string <optional>
    <nullable>

    The ID of the Previous Type that was active on the Outlet

  • newTypeId string

    The ID of the New Type that is now active on the Outlet

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • compacSizerId string <optional>

    The Compac Sizer ID this Outlet Type Change is associated with

  • outletNumber string <optional>

    The Sizer Outlet Number this Outlet Type Change is associated with

  • previousTypeId string <optional>
    <nullable>

    The ID of the Previous Type that was active on the Outlet

  • newTypeId string <optional>

    The ID of the New Type that is now active on the Outlet

  • createdTimestampBegin Date <optional>

    Filter by the Timestamp when this Compac Sizer Outlet Type Change occurred. Results Greater than or Equal to Timestamp

  • createdTimestampEnd Date <optional>

    Filter by the Timestamp when this Compac Sizer Outlet Type Change occurred. Results Less than or Equal to Timestamp

Source

UpdateData

The Update Data for a Compac Sizer Outlet Type Change

Type

  • Object

Properties

  • compacSizerId string <optional>

    The Compac Sizer ID this Outlet Type Change is associated with

  • createdTimestamp Date <optional>

    When this Outlet Type Change occurred

  • previousTypeId string <optional>
    <nullable>

    The ID of the Previous Type that was active on the Outlet

  • newTypeId string <optional>

    The ID of the New Type that is now active on the Outlet

Source