RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

CompacSizerOutletProductChangeController

Controller Class for Compac Sizer Outlet Product Changes

Constructor

new CompacSizerOutletProductChangeController()

Source

Methods

static

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

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

Parameters

  • siteId number

    The Site ID

  • createData CompacSizerOutletProductChangeController.CreateData

    The Compac Sizer Outlet Product Change Create Data

Returns

  • Promise.<CompacSizerOutletProductChangeModel>

Source

static

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

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

Create a Comment for a Compac Sizer Outlet Product Change

Parameters

  • siteId number

    The Site ID

  • id string

    The Compac Sizer Outlet Product Change ID

  • content string

    The Content of the New Comment

Returns

  • Promise.<CompacSizerOutletProductChangeController.CommentItem>

Source

static

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

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

Delete a Comment for a Compac Sizer Outlet Product Change

Parameters

  • siteId number

    The Site ID

  • id string

    The Compac Sizer Outlet Product Change ID

  • commentId string

    The Comment ID

Returns

  • Promise.<boolean>

Source

static

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

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

Parameters

  • siteId number

    The Site ID

  • queryParameters CompacSizerOutletProductChangeController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<CompacSizerOutletProductChangeModel>>

Source

static

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

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

Retrieves Comments for a Compac Sizer Outlet Product Change

Parameters

  • siteId number

    The Site ID

  • id string

    The Compac Sizer Outlet Product Change ID

Returns

  • Promise.<Array.<CompacSizerOutletProductChangeController.CommentItem>>

Source

static

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

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

Parameters

  • siteId number

    The Site ID

  • id string

    The Compac Sizer Outlet Product Change ID

Returns

  • Promise.<CompacSizerOutletProductChangeModel>

Source

static

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

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

Retrieves Comments for a Compac Sizer Outlet Product Change

Parameters

  • siteId number

    The Site ID

  • id string

    The Compac Sizer Outlet Product Change ID

  • commentId string

    The Comment ID

Returns

  • Promise.<CompacSizerOutletProductChangeController.CommentItem>

Source

static

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

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

Parameters

  • siteId number

    The Site ID

  • id string

    The Compac Sizer Outlet Product Change ID

  • updateData CompacSizerOutletProductChangeController.UpdateData

    The Compac Sizer Outlet Product Change Update Data

Returns

  • Promise.<CompacSizerOutletProductChangeModel>

Source

static

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

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

Update a Comment for a Compac Sizer Outlet Product Change

Parameters

  • siteId number

    The Site ID

  • id string

    The Compac Sizer Outlet Product Change ID

  • commentId string

    The Comment ID

  • content string

    The Updated Content for the Comment

Returns

  • Promise.<CompacSizerOutletProductChangeController.CommentItem>

Source

Type Definitions

CommentItem

A CommentItem Type

Type

  • Object

Properties

  • id string

    The Comment ID

  • userAccount CompacSizerOutletProductChangeController.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 Product Change

Type

  • Object

Properties

  • compacSizerId string

    The Compac Sizer ID this Outlet Change is associated with

  • outletNumber string <optional>

    The Sizer Outlet Number this Outlet Change is associated with

  • createdTimestamp Date <optional>

    When this Outlet Change occurred

  • previousProductId string <optional>
    <nullable>

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

  • previousProductName string <optional>
    <nullable>

    The Name of the Previous Product that was active on the Outlet

  • newProductId string

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

  • newProductName string

    The Name of the New Product 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 Change is associated with

  • outletNumber string <optional>

    The Sizer Outlet Number this Outlet Change is associated with

  • previousProductId string <optional>
    <nullable>

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

  • previousProductName string <optional>
    <nullable>

    The Name of the Previous Product that was active on the Outlet

  • newProductId string <optional>

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

  • newProductName string <optional>

    The Name of the New Product that is now active on the Outlet

  • createdTimestampBegin Date <optional>

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

  • createdTimestampEnd Date <optional>

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

Source

UpdateData

The Update Data for a Compac Sizer Outlet Product Change

Type

  • Object

Properties

  • compacSizerId string <optional>

    The Compac Sizer ID this Outlet Change is associated with

  • createdTimestamp Date <optional>

    When this Outlet Change occurred

  • previousProductId string <optional>
    <nullable>

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

  • previousProductName string <optional>
    <nullable>

    The Name of the Previous Product that was active on the Outlet

  • newProductId string <optional>

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

  • newProductName string <optional>

    The Name of the New Product that is now active on the Outlet

Source