Class: OrderlistService
Defined in: service/OrderlistService.ts:151
Backwards-compatible class form. New code should call orderlistService(client).
Constructors
Constructor
new OrderlistService(
client):OrderlistService
Defined in: service/OrderlistService.ts:153
Parameters
client
Returns
OrderlistService
Methods
addOrderlistItems()
addOrderlistItems(
id,input):Promise<Orderlist>
Defined in: service/OrderlistService.ts:190
Adds items to an orderlist
Parameters
id
number
Orderlist ID
input
Items to add
Returns
Promise<Orderlist>
assignOrderlistCompanies()
assignOrderlistCompanies(
id,input):Promise<Orderlist>
Defined in: service/OrderlistService.ts:214
Assigns companies to an orderlist
Parameters
id
number
Orderlist ID
input
Companies to assign
Returns
Promise<Orderlist>
assignOrderlistUsers()
assignOrderlistUsers(
id,input):Promise<Orderlist>
Defined in: service/OrderlistService.ts:202
Assigns users to an orderlist
Parameters
id
number
Orderlist ID
input
Users to assign
Returns
Promise<Orderlist>
createOrderlist()
createOrderlist(
input):Promise<Orderlist>
Defined in: service/OrderlistService.ts:173
Creates a new orderlist
Parameters
input
Orderlist creation input
Returns
Promise<Orderlist>
deleteOrderlist()
deleteOrderlist(
id):Promise<boolean>
Defined in: service/OrderlistService.ts:184
Deletes an orderlist
Parameters
id
number
Orderlist ID to delete
Returns
Promise<boolean>
getComputedOrderlists()
getComputedOrderlists(
input):Promise<ComputedOrderlistsResponse>
Defined in: service/OrderlistService.ts:168
Retrieves computed (merged) orderlists
Parameters
input
Computed orderlists input
Returns
Promise<ComputedOrderlistsResponse>
getOrderlist()
getOrderlist(
id):Promise<Orderlist>
Defined in: service/OrderlistService.ts:158
Retrieves a specific orderlist by ID
Parameters
id
number
Orderlist ID
Returns
Promise<Orderlist>
getOrderlists()
getOrderlists(
input?):Promise<OrderlistsResponse>
Defined in: service/OrderlistService.ts:163
Retrieves orderlists with search
Parameters
input?
Search input parameters
Returns
Promise<OrderlistsResponse>
removeOrderlistItems()
removeOrderlistItems(
id,input):Promise<Orderlist>
Defined in: service/OrderlistService.ts:196
Removes items from an orderlist
Parameters
id
number
Orderlist ID
input
Items to remove
Returns
Promise<Orderlist>
unassignOrderlistCompanies()
unassignOrderlistCompanies(
id,input):Promise<Orderlist>
Defined in: service/OrderlistService.ts:220
Unassigns companies from an orderlist
Parameters
id
number
Orderlist ID
input
Companies to unassign
Returns
Promise<Orderlist>
unassignOrderlistUsers()
unassignOrderlistUsers(
id,input):Promise<Orderlist>
Defined in: service/OrderlistService.ts:208
Unassigns users from an orderlist
Parameters
id
number
Orderlist ID
input
Users to unassign
Returns
Promise<Orderlist>
updateOrderlist()
updateOrderlist(
id,input):Promise<Orderlist>
Defined in: service/OrderlistService.ts:179
Updates an existing orderlist
Parameters
id
number
Orderlist ID
input
Orderlist update input
Returns
Promise<Orderlist>