Skip to main content

Function: favoriteListService()

favoriteListService(client): object

Defined in: service/FavoriteListService.ts:21

Service for managing favorite lists

Parameters​

client​

GraphQLClient

Returns​

addFavoriteListItems()​

addFavoriteListItems(id, input): Promise<FavoriteList>

Adds items to a favorite list *

Parameters​

id​

string

Favorite list ID *

input​

FavoriteListsItemsInput

Items to add via FavoriteListsItemsInput *

Returns​

Promise<FavoriteList>

Promise<FavoriteList> The updated favorite list

clearFavoriteListItems()​

clearFavoriteListItems(id, products?, clusters?): Promise&lt;FavoriteList>

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&lt;FavoriteList>

Promise<FavoriteList> The updated favorite list

createFavoriteList()​

createFavoriteList(input): Promise&lt;FavoriteList>

Creates a new favorite list *

Parameters​

input​

FavoriteListsCreateInput

Favorite list creation input *

Returns​

Promise&lt;FavoriteList>

Promise<FavoriteList> The created favorite list

deleteFavoriteList()​

deleteFavoriteList(id): Promise&lt;boolean>

Deletes a favorite list *

Parameters​

id​

string

FavoriteList ID to delete *

Returns​

Promise&lt;boolean>

Promise<boolean> Success status

getFavoriteList()​

getFavoriteList(variables): Promise&lt;FavoriteList>

Retrieves a specific favorite list *

Parameters​

variables​

FavoriteListVariables

    • id: String - Favorite list ID
    • language: String - language to fetch the list data in
    • priceCalculateProductInput: PriceCalculateProductInput - Price calculation input
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • imageVariantFilters: TransformationsInput - Image transformation filters

Returns​

Promise&lt;FavoriteList>

Promise<FavoriteList> Favorite list data

getFavoriteLists()​

getFavoriteLists(input?): Promise&lt;FavoriteListsResponse>

Retrieves favorite lists with search *

Parameters​

input?​

FavoriteListsSearchInput

Search input parameters *

Returns​

Promise&lt;FavoriteListsResponse>

Promise<FavoriteListsResponse> Favorite lists response

removeFavoriteListItems()​

removeFavoriteListItems(id, input): Promise&lt;FavoriteList>

Removes items from a favorite list *

Parameters​

id​

string

Favorite list ID *

input​

FavoriteListsItemsInput

Items to remove via FavoriteListsItemsInput *

Returns​

Promise&lt;FavoriteList>

Promise<FavoriteList> The updated favorite list

updateFavoriteList()​

updateFavoriteList(id, input): Promise&lt;FavoriteList>

Updates an existing favorite list *

Parameters​

id​

string

Favorite list ID *

input​

FavoriteListsUpdateInput

Favorite list update input *

Returns​

Promise&lt;FavoriteList>

Promise<FavoriteList> The updated favorite list