RICADO Gen 4 API JS Client: MAFSizerOutletArticleChangeController

MAFSizerOutletArticleChangeController

Controller Class for MAF Sizer Outlet Article Changes

Constructor

new MAFSizerOutletArticleChangeController()

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 15

Methods

static

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

Create a MAF Sizer Outlet Article Change [POST /packhouse/sites/{siteId}/maf-sizer-outlet-article-changes]

Parameters

siteId number
The Site ID
createData MAFSizerOutletArticleChangeController.CreateData
The MAF Sizer Outlet Article Change Create Data

Returns

Promise.<MAFSizerOutletArticleChangeModel>

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 936

static

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

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

Create a Comment for a MAF Sizer Outlet Article Change

Parameters

siteId number
The Site ID
id string
The MAF Sizer Outlet Article Change ID
content string
The Content of the New Comment

Returns

Promise.<MAFSizerOutletArticleChangeController.CommentItem>

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 300

static

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

Delete a MAF Sizer Outlet Article Change [DELETE /packhouse/sites/{siteId}/maf-sizer-outlet-article-changes/{id}]

Parameters

siteId number
The Site ID
id string
The MAF Sizer Outlet Article Change ID

Returns

Promise.<boolean>

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 75

static

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

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

Delete a Comment for a MAF Sizer Outlet Article Change

Parameters

siteId number
The Site ID
id string
The MAF Sizer Outlet Article Change ID
commentId string
The Comment ID

Returns

Promise.<boolean>

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 883

static

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

List all MAF Sizer Outlet Article Changes [GET /packhouse/sites/{siteId}/maf-sizer-outlet-article-changes]

Parameters

siteId number
The Site ID
queryParameters MAFSizerOutletArticleChangeController.GetAllQueryParameters <optional>

The Optional Query Parameters

Returns

Promise.<Array.<MAFSizerOutletArticleChangeModel>>

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 903

static

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

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

Retrieves Comments for a MAF Sizer Outlet Article Change

Parameters

siteId number
The Site ID
id string
The MAF Sizer Outlet Article Change ID

Returns

Promise.<Array.<MAFSizerOutletArticleChangeController.CommentItem>>

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 97

static

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

Retrieve a MAF Sizer Outlet Article Change [GET /packhouse/sites/{siteId}/maf-sizer-outlet-article-changes/{id}]

Parameters

siteId number
The Site ID
id string
The MAF Sizer Outlet Article Change ID

Returns

Promise.<MAFSizerOutletArticleChangeModel>

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 26

static

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

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

Retrieves Comments for a MAF Sizer Outlet Article Change

Parameters

siteId number
The Site ID
id string
The MAF Sizer Outlet Article Change ID
commentId string
The Comment ID

Returns

Promise.<MAFSizerOutletArticleChangeController.CommentItem>

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 494

static

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

Update a MAF Sizer Outlet Article Change [PATCH /packhouse/sites/{siteId}/maf-sizer-outlet-article-changes/{id}]

Parameters

siteId number
The Site ID
id string
The MAF Sizer Outlet Article Change ID
updateData MAFSizerOutletArticleChangeController.UpdateData
The MAF Sizer Outlet Article Change Update Data

Returns

Promise.<MAFSizerOutletArticleChangeModel>

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 51

static

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

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

Update a Comment for a MAF Sizer Outlet Article Change

Parameters

siteId number
The Site ID
id string
The MAF Sizer Outlet Article Change ID
commentId string
The Comment ID
content string
The Updated Content for the Comment

Returns

Promise.<MAFSizerOutletArticleChangeController.CommentItem>

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 689

Type Definitions

CommentItem

A CommentItem Type

Type

Object

Properties

id string

The Comment ID
userAccount MAFSizerOutletArticleChangeController.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

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 1000

CreateData

The Create Data for a MAF Sizer Outlet Article Change

Type

Object

Properties

mafSizerId string

The MAF 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
previousArticleName string <optional>
<nullable>

The Name of the Previous Article that was active on the Outlet
newArticleName string

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

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 967

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

Object

Properties

mafSizerId string <optional>

The MAF Sizer ID this Outlet Change is associated with
outletNumber string <optional>

The Sizer Outlet Number this Outlet Change is associated with
previousArticleName string <optional>
<nullable>

The Name of the Previous Article that was active on the Outlet
newArticleName string <optional>

The Name of the New Article that is now active on the Outlet
createdTimestampBegin Date <optional>

Filter by the Timestamp when this MAF Sizer Outlet Article Change occurred. Results Greater than or Equal to Timestamp
createdTimestampEnd Date <optional>

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

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 954

UpdateData

The Update Data for a MAF Sizer Outlet Article Change

Type

Object

Properties

mafSizerId string <optional>

The MAF Sizer ID this Outlet Change is associated with
createdTimestamp Date <optional>

When this Outlet Change occurred
previousArticleName string <optional>
<nullable>

The Name of the Previous Article that was active on the Outlet
newArticleName string <optional>

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

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 979

UserAccount

A UserAccount Type

Type

Object

Properties

id string <nullable>

The User Account ID
firstName string <nullable>

The User's First Name
lastName string <nullable>

The User's Last Name

Source

Controllers/Packhouse/Site/MAFSizerOutletArticleChangeController.js , line 990