Skip to main content

Class: FavoriteListService

Defined in: service/FavoriteListService.ts:111

Backwards-compatible class form. New code should call favoriteListService(client).

Constructors​

Constructor​

new FavoriteListService(client): FavoriteListService

Defined in: service/FavoriteListService.ts:113

Parameters​

client​

GraphQLClient

Returns​

FavoriteListService

Methods​

addFavoriteListItems()​

addFavoriteListItems(id, input): Promise<FavoriteList>

Defined in: service/FavoriteListService.ts:145

Adds items to a favorite list

Parameters​

id​

string

Favorite list ID

input​

FavoriteListsItemsInput

Items to add via FavoriteListsItemsInput

Returns​

Promise<FavoriteList>

clearFavoriteListItems()​

clearFavoriteListItems(id, products?, clusters?): Promise<FavoriteList>

Defined in: service/FavoriteListService.ts:158

Clears items from a favorite list

Parameters​

id​

string

Favorite list ID

products?​

boolean

Whether to clear products

clusters?​

boolean

Whether to clear clusters

Returns​

Promise<FavoriteList>

createFavoriteList()​

createFavoriteList(input): Promise<FavoriteList>

Defined in: service/FavoriteListService.ts:128

Creates a new favorite list

Parameters​

input​

FavoriteListsCreateInput

Favorite list creation input

Returns​

Promise<FavoriteList>

deleteFavoriteList()​

deleteFavoriteList(id): Promise<boolean>

Defined in: service/FavoriteListService.ts:139

Deletes a favorite list

Parameters​

id​

string

FavoriteList ID to delete

Returns​

Promise<boolean>

getFavoriteList()​

getFavoriteList(variables): Promise<FavoriteList>

Defined in: service/FavoriteListService.ts:118

Retrieves a specific favorite list

Parameters​

variables​

FavoriteListVariables

Favorite list ID

Returns​

Promise<FavoriteList>

getFavoriteLists()​

getFavoriteLists(input?): Promise<FavoriteListsResponse>

Defined in: service/FavoriteListService.ts:123

Retrieves favorite lists with search

Parameters​

input?​

FavoriteListsSearchInput

Search input parameters

Returns​

Promise<FavoriteListsResponse>

removeFavoriteListItems()​

removeFavoriteListItems(id, input): Promise<FavoriteList>

Defined in: service/FavoriteListService.ts:151

Removes items from a favorite list

Parameters​

id​

string

Favorite list ID

input​

FavoriteListsItemsInput

Items to remove via FavoriteListsItemsInput

Returns​

Promise<FavoriteList>

updateFavoriteList()​

updateFavoriteList(id, input): Promise<FavoriteList>

Defined in: service/FavoriteListService.ts:134

Updates an existing favorite list

Parameters​

id​

string

Favorite list ID

input​

FavoriteListsUpdateInput

Favorite list update input

Returns​

Promise<FavoriteList>