Constructor
new CompacSizerOutletTypeController()
Source
Methods
create(siteId, createData) → {Promise.<CompacSizerOutletTypeModel>}
Create a Compac Sizer Outlet Type [POST /packhouse/sites/{siteId}/compac-sizer-outlet-types]
Parameters
-
siteId
number
The Site ID
-
createData
CompacSizerOutletTypeController.CreateData
The Compac Sizer Outlet Type Create Data
Returns
-
Promise.<CompacSizerOutletTypeModel>
Source
delete(siteId, id) → {Promise.<boolean>}
Delete a Compac Sizer Outlet Type [DELETE /packhouse/sites/{siteId}/compac-sizer-outlet-types/{id}]
Parameters
-
siteId
number
The Site ID
-
id
string
The Compac Sizer Outlet Type ID
Returns
-
Promise.<boolean>
Source
getAll(siteId, queryParametersopt) → {Promise.<Array.<CompacSizerOutletTypeModel>>}
List all Compac Sizer Outlet Types [GET /packhouse/sites/{siteId}/compac-sizer-outlet-types]
Parameters
-
siteId
number
The Site ID
-
queryParameters
CompacSizerOutletTypeController.GetAllQueryParameters
<optional>
The Optional Query Parameters
Returns
-
Promise.<Array.<CompacSizerOutletTypeModel>>
Source
getOne(siteId, id) → {Promise.<CompacSizerOutletTypeModel>}
Retrieve a Compac Sizer Outlet Type [GET /packhouse/sites/{siteId}/compac-sizer-outlet-types/{id}]
Parameters
-
siteId
number
The Site ID
-
id
string
The Compac Sizer Outlet Type ID
Returns
-
Promise.<CompacSizerOutletTypeModel>
Source
update(siteId, id, updateData) → {Promise.<CompacSizerOutletTypeModel>}
Update a Compac Sizer Outlet Type [PATCH /packhouse/sites/{siteId}/compac-sizer-outlet-types/{id}]
Parameters
-
siteId
number
The Site ID
-
id
string
The Compac Sizer Outlet Type ID
-
updateData
CompacSizerOutletTypeController.UpdateData
The Compac Sizer Outlet Type Update Data
Returns
-
Promise.<CompacSizerOutletTypeModel>
Source
Type Definitions
CreateData
The Create Data for a Compac Sizer Outlet Type
Type
-
Object
Properties
-
name
string
<optional>
The Name for this Dynamic Outlet Type
-
type
string
The Generic Outlet Type
-
description
string
<optional>
An Optional Description for this Dynamic Outlet Type
Source
GetAllQueryParameters
The Optional Query Parameters for the getAll Function
Type
-
Object
Properties
-
name
string
<optional>
The Name for this Dynamic Outlet Type
-
type
string
<optional>
The Generic Outlet Type
Source
UpdateData
The Update Data for a Compac Sizer Outlet Type
Type
-
Object
Properties
-
type
string
<optional>
The Generic Outlet Type
-
description
string
<optional>
An Optional Description for this Dynamic Outlet Type