Skip to main content

Function: orderlistService()

orderlistService(client): object

Defined in: service/OrderlistService.ts:28

Service for managing orderlists

Parameters​

client​

GraphQLClient

Returns​

addOrderlistItems()​

addOrderlistItems(id, input): Promise<Orderlist>

Adds items to an orderlist *

Parameters​

id​

number

Orderlist ID *

input​

OrderlistItemsInput

Items to add *

Returns​

Promise<Orderlist>

Promise<Orderlist> The updated orderlist

assignOrderlistCompanies()​

assignOrderlistCompanies(id, input): Promise&lt;Orderlist>

Assigns companies to an orderlist *

Parameters​

id​

number

Orderlist ID *

input​

OrderlistCompaniesInput

Companies to assign *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The updated orderlist

assignOrderlistUsers()​

assignOrderlistUsers(id, input): Promise&lt;Orderlist>

Assigns users to an orderlist *

Parameters​

id​

number

Orderlist ID *

input​

OrderlistUsersInput

Users to assign *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The updated orderlist

createOrderlist()​

createOrderlist(input): Promise&lt;Orderlist>

Creates a new orderlist *

Parameters​

input​

OrderlistCreateInput

Orderlist creation input *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The created orderlist

deleteOrderlist()​

deleteOrderlist(id): Promise&lt;boolean>

Deletes an orderlist *

Parameters​

id​

number

Orderlist ID to delete *

Returns​

Promise&lt;boolean>

Promise<boolean> Success status

getComputedOrderlists()​

getComputedOrderlists(input): Promise&lt;ComputedOrderlistsResponse>

Retrieves computed (merged) orderlists *

Parameters​

input​

ComputedOrderlistsInput

Computed orderlists input *

Returns​

Promise&lt;ComputedOrderlistsResponse>

Promise<ComputedOrderlistsResponse> Computed orderlists response

getOrderlist()​

getOrderlist(id): Promise&lt;Orderlist>

Retrieves a specific orderlist by ID *

Parameters​

id​

number

Orderlist ID *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> Orderlist data

getOrderlists()​

getOrderlists(input?): Promise&lt;OrderlistsResponse>

Retrieves orderlists with search *

Parameters​

input?​

OrderlistSearchInput

Search input parameters *

Returns​

Promise&lt;OrderlistsResponse>

Promise<OrderlistsResponse> Orderlists response

removeOrderlistItems()​

removeOrderlistItems(id, input): Promise&lt;Orderlist>

Removes items from an orderlist *

Parameters​

id​

number

Orderlist ID *

input​

OrderlistItemsInput

Items to remove *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The updated orderlist

unassignOrderlistCompanies()​

unassignOrderlistCompanies(id, input): Promise&lt;Orderlist>

Unassigns companies from an orderlist *

Parameters​

id​

number

Orderlist ID *

input​

OrderlistCompaniesInput

Companies to unassign *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The updated orderlist

unassignOrderlistUsers()​

unassignOrderlistUsers(id, input): Promise&lt;Orderlist>

Unassigns users from an orderlist *

Parameters​

id​

number

Orderlist ID *

input​

OrderlistUsersInput

Users to unassign *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The updated orderlist

updateOrderlist()​

updateOrderlist(id, input): Promise&lt;Orderlist>

Updates an existing orderlist *

Parameters​

id​

number

Orderlist ID *

input​

OrderlistUpdateInput

Orderlist update input *

Returns​

Promise&lt;Orderlist>

Promise<Orderlist> The updated orderlist