> For the complete documentation index, see [llms.txt](https://the-wishlist-documentation.gitbook.io/the-wishlist-documentation-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://the-wishlist-documentation.gitbook.io/the-wishlist-documentation-docs/javascript-apis/overview.md). # JavaScript Overview This page describes our Javascript APIs. For Shopify users, you will also need to set up our Shopify Proxy Authentication. ## Javascript APIs Refer [here](#Javascript-Installation) to install the TWC Javascript Library (package is at ) ### Table of contents #### customerService * [createBulkCustomers](#createbulkcustomers) * [createCustomer](#createcustomer) * [customerLookup](#customerlookup) * [deleteCustomer](#deletecustomer) * [deleteCustomerByID](#deletecustomerbyid) * [getCustomerByID](#getcustomerbyid) * [getCustomerByRef](#getcustomerbyref) * [updateCustomer](#updatecustomer) * [updateCustomerByID](#updatecustomerbyid) * [updateCustomerByRef](#updatecustomerbyref) #### wishlistService * [createWishlist](#createwishlist) * [createWishlistItem](#createwishlistitem) * [deleteAllWishlist](#deleteallwishlist) * [deleteWishlist](#deletewishlist) * [deleteWishlistByID](#deletewishlistbyid) * [deleteWishlistByRef](#deletewishlistbyref) * [deleteWishlistItemByID](#deletewishlistitembyid) * [deleteWishlistItemByRef](#deletewishlistitembyref) * [getCustomersWithFlag](#getcustomerswithflag) * [getWishlist](#getwishlist) * [getWishlistByCustomer](#getwishlistbycustomer) * [getWishlistByCustomerID](#getwishlistbycustomerid) * [getWishlistByCustomerRef](#getwishlistbycustomerref) * [getWishlistByID](#getwishlistbyid) * [getWishlistByRef](#getwishlistbyref) * [getWishlistItemByID](#getwishlistitembyid) * [getWishlistItemByRef](#getwishlistitembyref) * [getWishlistItems](#getwishlistitems) * [resetWishlistItemFlag](#resetwishlistitemflag) * [updateWishlist](#updatewishlist) * [updateWishlistByID](#updatewishlistbyid) * [updateWishlistByRef](#updatewishlistbyref) * [updateWishlistItem](#updatewishlistitem) * [updateWishlistItemByID](#updatewishlistitembyid) * [updateWishlistItemByRef](#updatewishlistitembyref) * [getItemsPopularity](#getItemsPopularity) ### customerService #### createBulkCustomers ▸ **createBulkCustomers**(`obj`): `void` Creates bulk customers. **Parameters** | Name | Type | Description | | ---------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.createBulkCustomerBody` | { `[key: string]`: `any`; }\[] | The body of the request containing the customer data. See CustomerRESTAPI.json for information on the fields. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful response. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | **Returns** `void` **Defined in** [customerService/createBulkCustomers.ts:15](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/customerService/createBulkCustomers.ts#L15) *** #### createCustomer ▸ **createCustomer**(`obj`): `void` Creates a new customer. **Parameters** | Name | Type | Description | | ------------------------ | ----------------------------- | ----------------------------------------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.createCustomerBody` | `Object` | The body of the request containing the customer data. See See CustomerRESTAPI.json for information on the fields. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called when an error occurs. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called when the request is successful. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | **Returns** `void` **Defined in** [customerService/createCustomer.ts:14](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/customerService/createCustomer.ts#L14) *** #### customerLookup ▸ **customerLookup**(`obj`): `void` Returns a list of customers with a matching email/mobile/phone/firstName/lastName. **Parameters** | Name | Type | Description | | ---------------- | ----------------------------- | -------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.email?` | `string` | The email of the customer. | | `obj.firstName?` | `string` | The first name of the customer. | | `obj.lastName?` | `string` | The last name of the customer. | | `obj.mobile?` | `string` | The mobile number of the customer. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on lookup error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful lookup. | | `obj.phone?` | `string` | The phone number of the customer. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | **Returns** `void` **Defined in** [customerService/customerLookup.ts:18](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/customerService/customerLookup.ts#L18) *** #### deleteCustomer ▸ **deleteCustomer**(`obj`): `void` Deletes a customer. **Parameters** | Name | Type | Description | | ------------------ | ----------------------------- | ------------------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.customerID?` | `string` | The ID of the customer to delete (either customerID or customerRef must be defined). | | `obj.customerRef?` | `string` | The reference of the customer to delete (either customerID or customerRef must be defined). | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful deletion. | | `obj.tenant` | `string` | The tenant ID. | | `obj.token` | `string` | The authentication token. | **Returns** `void` **Defined in** [customerService/deleteCustomer.ts:16](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/customerService/deleteCustomer.ts#L16) *** #### deleteCustomerByID ▸ **deleteCustomerByID**(`obj`): `void` Deletes a customer by their ID. **Parameters** | Name | Type | Description | | ---------------- | ----------------------------- | ------------------------------------------------------------------------ | | `obj` | `Object` | The configuration object. | | `obj.customerID` | `string` | The ID of the customer to delete. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called when an error occurs during deletion. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called when the deletion is successful. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | **Returns** `void` **Defined in** [customerService/deleteCustomerByID.ts:15](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/customerService/deleteCustomerByID.ts#L15) *** #### getCustomerByID ▸ **getCustomerByID**(`obj`): `void` Retrieves customer information by ID. **Parameters** | Name | Type | Description | | ---------------- | ----------------------------- | -------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.customerID` | `string` | The ID of the customer to retrieve. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to handle any errors. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to handle the successful response. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | **Returns** `void` **Defined in** [customerService/getCustomerByID.ts:14](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/customerService/getCustomerByID.ts#L14) *** #### getCustomerByRef ▸ **getCustomerByRef**(`obj`): `void` Retrieves customer information by customer reference. **Parameters** | Name | Type | Description | | ----------------- | ----------------------------- | -------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.customerRef` | `string` | The customer reference. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to handle any errors. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to handle the successful response. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | **Returns** `void` **Defined in** [customerService/getCusotmerByRef.ts:14](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/customerService/getCusotmerByRef.ts#L14) *** #### updateCustomer ▸ **updateCustomer**(`obj`): `void` Updates a customer using the provided data. **Parameters** | Name | Type | Description | | ------------------------ | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be executed when an error occurs during the request. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be executed when the request is successful. | | `obj.tenant` | `string` | The tenant identifier for the request. | | `obj.token` | `string` | The authentication token for the request. | | `obj.updateCustomerBody` | `Object` | The data to be sent in the request body for updating the customer. See CustomerRESTAPI.json/paths/~~1api~~1v2\~1customers/put for information on the fields. | **Returns** `void` **Defined in** [customerService/updateCustomer.ts:16](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/customerService/updateCustomer.ts#L16) *** #### updateCustomerByID ▸ **updateCustomerByID**(`obj`): `void` Updates a customer by their ID. **Parameters** | Name | Type | Description | | ------------------------ | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | `obj` | `Object` | The configuration object. | | `obj.customerID` | `string` | The ID of the customer to update. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful update. | | `obj.tenant` | `string` | The tenant ID. | | `obj.token` | `string` | The authentication token. | | `obj.updateCustomerBody` | `Object` | The updated customer data. See CustomerRESTAPI.json/paths/~~1api~~1v2~~1customers~~1id={id}/put for information on the fields. | **Returns** `void` **Defined in** [customerService/updateCustomerByID.ts:16](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/customerService/updateCustomerByID.ts#L16) *** #### updateCustomerByRef ▸ **updateCustomerByRef**(`obj`): `void` Updates a customer by reference. **Parameters** | Name | Type | Description | | ------------------------ | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `obj` | `Object` | The configuration object. | | `obj.customerRef` | `string` | The reference of the customer to update. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful update. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.updateCustomerBody` | `Object` | The updated customer data. See CustomerRESTAPI.json/paths/~~1api~~1v2~~1customers~~1customerRef={customerRef}/put for information on the fields. | **Returns** `void` **Defined in** [customerService/updateCustomerByRef.ts:16](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/customerService/updateCustomerByRef.ts#L16) ### wishlistService #### createWishlist ▸ **createWishlist**(`obj`): `void` Creates a new wishlist. **Parameters** | Name | Type | Description | | --------------------- | ----------------------------- | ------------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.newWishlistBody` | `Object` | The body of the new wishlist. See WishlistRESTAPI.json for information on the fields. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful creation. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | **Returns** `void` **Defined in** [wishlistService/createWishlist.ts:14](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/createWishlist.ts#L14) *** #### createWishlistItem ▸ **createWishlistItem**(`obj`): `void` **Parameters** | Name | Type | | ---------------------------- | ----------------------------- | | `obj` | `Object` | | `obj.createWishlistItembody` | `Object` | | `obj.onError` | (`error`: `any`) => `void` | | `obj.onSuccess` | (`response`: `any`) => `void` | | `obj.tenant` | `string` | | `obj.token` | `string` | **Returns** `void` **Defined in** [wishlistService/createWishlistItem.ts:14](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/createWishlistItem.ts#L14) *** #### deleteAllWishlist ▸ **deleteAllWishlist**(`obj`): `void` Deletes all wishlists for a customer. **Parameters** | Name | Type | Description | | ------------------ | ----------------------------- | --------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.customerID?` | `string` | The ID of the customer (either customerID or customerRef must be defined). | | `obj.customerRef?` | `string` | The reference of the customer (either customerID or customerRef must be defined). | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful deletion. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | **Returns** `void` **Defined in** [wishlistService/deleteAllWishlist.ts:15](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/deleteAllWishlist.ts#L15) *** #### deleteWishlist ▸ **deleteWishlist**(`obj`): `void` Deletes a wishlist by either ID or Ref. **Parameters** | Name | Type | Description | | ------------------ | ----------------------------- | ------------------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called when an error occurs during deletion. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called when the deletion is successful. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.wishlistID?` | `string` | The ID of the wishlist to delete (either wishlistID or wishlistRef must be defined). | | `obj.wishlistRef?` | `string` | The reference of the wishlist to delete (either wishlistID or wishlistRef must be defined). | **Returns** `void` **Defined in** [wishlistService/deleteWishlist.ts:16](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/deleteWishlist.ts#L16) *** #### deleteWishlistByID ▸ **deleteWishlistByID**(`obj`): `void` Deletes a wishlist by ID. **Parameters** | Name | Type | Description | | ---------------- | ----------------------------- | ------------------------------------------------------------------------ | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called when an error occurs during deletion. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called when the deletion is successful. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.wishlistID` | `string` | The ID of the wishlist to delete. | **Returns** `void` **Defined in** [wishlistService/deleteWishlistByID.ts:14](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/deleteWishlistByID.ts#L14) *** #### deleteWishlistByRef ▸ **deleteWishlistByRef**(`obj`): `void` Deletes a wishlist by its reference. **Parameters** | Name | Type | Description | | ----------------- | ----------------------------- | ----------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called when an error occurs during the deletion. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called when the wishlist is successfully deleted. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.wishlistRef` | `string` | The reference of the wishlist to delete. | **Returns** `void` **Defined in** [wishlistService/deleteWishlistByRef.ts:15](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/deleteWishlistByRef.ts#L15) *** #### deleteWishlistItemByID ▸ **deleteWishlistItemByID**(`obj`): `void` Deletes a wishlist item by ID. **Parameters** | Name | Type | Description | | -------------------- | ----------------------------- | ---------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful deletion. | | `obj.tenant` | `string` | The tenant. | | `obj.token` | `string` | The authorization token. | | `obj.wishlistItemID` | `string` | The ID of the wishlist item to delete. | **Returns** `void` **Defined in** [wishlistService/deleteWishlistItemByID.ts:15](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/deleteWishlistItemByID.ts#L15) *** #### deleteWishlistItemByRef ▸ **deleteWishlistItemByRef**(`obj`): `void` Deletes a wishlist item by its reference. **Parameters** | Name | Type | Description | | --------------------- | ----------------------------- | ---------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful deletion. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.wishlistItemRef` | `string` | The reference of the wishlist item to delete. | **Returns** `void` **Defined in** [wishlistService/deleteWishlistItemByRef.ts:14](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/deleteWishlistItemByRef.ts#L14) *** #### getCustomersWithFlag ▸ **getCustomersWithFlag**(`obj`): `void` Retrieves the wishlist customers which are enabled for notifyMe or preRelease. If the customers do not exist, this method returns an empty list. **Parameters** | Name | Type | Description | | ----------------- | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.notifyMe?` | `boolean` | A boolean indicating whether to retrieve customers with notifyMe enabled (either notifyMe or preRelease must be defined). | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called if an error occurs during retrieval. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful retrieval of customers. | | `obj.preRelease?` | `boolean` | A boolean indicating whether to retrieve customers with preRelease enabled (either notifyMe or preRelease must be defined). | | `obj.productRef?` | `string` | The product reference to filter the customers by (either productRef or variantRef must be defined). | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.variantRef?` | `string` | The variant reference to filter the customers by (either productRef or variantRef must be defined). | **Returns** `void` **Defined in** [wishlistService/getCustomersWithFlag.ts:23](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/getCustomersWithFlag.ts#L23) *** #### getWishlist ▸ **getWishlist**(`obj`): `void` Retrieves the wishlist data based on the provided parameters. **Parameters** | Name | Type | Description | | ------------------ | ----------------------------- | --------------------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.lastItemId?` | `string` | The ID of the last item retrieved. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to handle any errors. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to handle the successful response. | | `obj.pageSize?` | `string` | The number of items per page to retrieve. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.wishlistID?` | `string` | The ID of the wishlist to retrieve (either wishlistID or wishlistRef must be defined). | | `obj.wishlistRef?` | `string` | The reference of the wishlist to retrieve (either wishlistID or wishlistRef must be defined). | **Returns** `void` **Defined in** [wishlistService/getWishlist.ts:21](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/getWishlist.ts#L21) *** #### getWishlistByCustomer ▸ **getWishlistByCustomer**(`obj`): `void` Retrieves the wishlist for a customer. **Parameters** | Name | Type | Description | | ------------------ | ----------------------------- | --------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.customerID?` | `string` | The ID of the customer (either customerID or customerRef must be defined). | | `obj.customerRef?` | `string` | The reference of the customer (either customerID or customerRef must be defined). | | `obj.lastItemId?` | `string` | The ID of the last item retrieved. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to handle an error response. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to handle a successful response. | | `obj.pageSize?` | `string` | The number of items to retrieve per page. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | **Returns** `void` **Defined in** [wishlistService/getWishlistByCustomer.ts:19](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/getWishlistByCustomer.ts#L19) *** #### getWishlistByCustomerID ▸ **getWishlistByCustomerID**(`obj`): `void` Retrieves the wishlist for a specific customer ID. **Parameters** | Name | Type | Description | | ----------------- | ----------------------------- | -------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.customerID` | `any` | The ID of the customer. | | `obj.lastItemId?` | `string` | The ID of the last item retrieved. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to handle any errors. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to handle the successful response. | | `obj.pageSize?` | `number` | The number of items to retrieve per page (default: 10). | | `obj.tenant` | `string` | The tenant ID. | | `obj.token` | `string` | The authentication token. | **Returns** `void` **Defined in** [wishlistService/getWishlistByCustomerID.ts:16](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/getWishlistByCustomerID.ts#L16) *** #### getWishlistByCustomerRef ▸ **getWishlistByCustomerRef**(`obj`): `void` Retrieves the wishlist for a customer based on the customer reference. **Parameters** | Name | Type | Description | | ----------------- | ----------------------------- | ------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.customerRef` | `string` | The customer reference. | | `obj.lastItemId?` | `string` | The ID of the last item retrieved. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to handle an error response. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to handle a successful response. | | `obj.pageSize?` | `number` | The number of items to retrieve per page (default: 10). | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | **Returns** `void` **Defined in** [wishlistService/getWishlistByCustomerRef.ts:16](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/getWishlistByCustomerRef.ts#L16) *** #### getWishlistByID ▸ **getWishlistByID**(`obj`): `void` Retrieves a wishlist by its ID. **Parameters** | Name | Type | Description | | ----------------- | ----------------------------- | -------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.lastItemId?` | `string` | The ID of the last item. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to handle the error response. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to handle the successful response. | | `obj.pageSize?` | `number` | The number of items per page. | | `obj.tenant` | `string` | The tenant. | | `obj.token` | `string` | The authentication token. | | `obj.wishlistID` | `string` | The ID of the wishlist. | **Returns** `void` **Defined in** [wishlistService/getWishlistByID.ts:16](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/getWishlistByID.ts#L16) *** #### getWishlistByRef ▸ **getWishlistByRef**(`obj`): `void` Retrieves a wishlist by its reference. **Parameters** | Name | Type | Description | | ----------------- | ----------------------------- | ------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called when an error occurs during the retrieval. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called when the wishlist is successfully retrieved. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.wishlistRef` | `string` | The reference of the wishlist to retrieve. | **Returns** `void` **Defined in** [wishlistService/getWishlistByRef.ts:14](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/getWishlistByRef.ts#L14) *** #### getWishlistItemByID ▸ **getWishlistItemByID**(`obj`): `void` Retrieves a wishlist item by its ID. **Parameters** | Name | Type | Description | | -------------------- | ----------------------------- | ------------------------------------------------------------------ | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called when an error occurs. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called when the request is successful. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.wishlistItemID` | `string` | The ID of the wishlist item to retrieve. | **Returns** `void` **Defined in** [wishlistService/getWishlistItemByID.ts:16](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/getWishlistItemByID.ts#L16) *** #### getWishlistItemByRef ▸ **getWishlistItemByRef**(`obj`): `void` Retrieves a wishlist item by its reference. **Parameters** | Name | Type | Description | | --------------------- | ----------------------------- | ------------------------------------------------------------------ | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called when an error occurs. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called when the request is successful. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.wishlistItemRef` | `string` | The reference of the wishlist item to retrieve. | **Returns** `void` **Defined in** [wishlistService/getWishlistItemByRef.ts:15](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/getWishlistItemByRef.ts#L15) *** #### getWishlistItems ▸ **getWishlistItems**(`obj`): `void` Retrieves wishlist items based on the provided parameters. **Parameters** | Name | Type | Description | | ----------------- | ----------------------------- | --------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.lastItemId?` | `string` | The ID of the last item retrieved. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to handle error response. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to handle successful response. | | `obj.pageSize?` | `string` | The number of items to retrieve per page. | | `obj.tenant` | `string` | The tenant information. | | `obj.token` | `string` | The authentication token. | | `obj.wishlistID` | `string` | The ID of the wishlist (either wishlistID or wishlistRef must be defined). | | `obj.wishlistRef` | `string` | The reference of the wishlist (either wishlistID or wishlistRef must be defined). | **Returns** `void` **Defined in** [wishlistService/getWishlistItems.ts:20](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/getWishlistItems.ts#L20) *** #### resetWishlistItemFlag ▸ **resetWishlistItemFlag**(`obj`): `void` Resets the wishlist item flag. **Parameters** | Name | Type | Description | | ----------------- | ----------------------------- | -------------------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.notifyMe?` | `boolean` | Indicates whether to notify the user (either notifyMe or preRelease must be defined). | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on success. | | `obj.preRelease?` | `boolean` | Indicates whether the item is a pre-release (either notifyMe or preRelease must be defined). | | `obj.productRef?` | `string` | The product reference (either productRef or variantRef must be defined). | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.variantRef?` | `string` | The variant reference (either productRef or variantRef must be defined). | **Returns** `void` **Defined in** [wishlistService/resetWishlistItemFlag.ts:21](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/resetWishlistItemFlag.ts#L21) *** #### updateWishlist ▸ **updateWishlist**(`obj`): `void` Updates a wishlist. **Parameters** | Name | Type | Description | | ------------------------ | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful update. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.updateWishlistBody` | `Object` | The body of the wishlist update request. See for information on the fields. | **Returns** `void` **Defined in** [wishlistService/updateWishlist.ts:16](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/updateWishlist.ts#L16) *** #### updateWishlistByID ▸ **updateWishlistByID**(`obj`): `void` Updates a wishlist by its ID. **Parameters** | Name | Type | Description | | ---------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful update. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.updateWishlistByIDBody` | `Object` | The updated wishlist data. See for information on the fields. | | `obj.wishlistID` | `string` | The ID of the wishlist to update. | **Returns** `void` **Defined in** [wishlistService/updateWishlistByID.ts:15](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/updateWishlistByID.ts#L15) *** #### updateWishlistByRef ▸ **updateWishlistByRef**(`obj`): `void` Updates a wishlist by its reference. **Parameters** | Name | Type | Description | | ---------------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful update. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.updateWishlistByIDBody` | `Object` | The updated wishlist data. See WishlistRESTAPI.json/paths/~~1api~~1wishlists\~1ref={wishlistRef}/put for information on the fields. | | `obj.wishlistRef` | `string` | The reference of the wishlist to update. | **Returns** `void` **Defined in** [wishlistService/updateWishlistByRef.ts:15](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/updateWishlistByRef.ts#L15) *** #### updateWishlistItem ▸ **updateWishlistItem**(`obj`): `void` Updates a wishlist item. **Parameters** | Name | Type | Description | | ---------------------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called when an error occurs during the update. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called when the update is successful. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.updateWishlistItemBody` | `Object` | The body of the request containing the updated wishlist item data. See WishlistRESTAPI.json/paths/~~1api~~1wishlist\~1items/put for information on the fields. | **Returns** `void` **Defined in** [wishlistService/updateWishlistItem.ts:17](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/updateWishlistItem.ts#L17) *** #### updateWishlistItemByID ▸ **updateWishlistItemByID**(`obj`): `void` Updates a wishlist item by its ID. **Parameters** | Name | Type | Description | | ---------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful update. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.updateWishlistItemBody` | `Object` | The updated wishlist item data. See WishlistRESTAPI.json/paths/~~1api~~1wishlist~~1items~~1id={id}/put for information on the fields. | | `obj.wishlistItemID` | `string` | The ID of the wishlist item to update. | **Returns** `void` **Defined in** [wishlistService/updateWishlistItemByID.ts:16](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/updateWishlistItemByID.ts#L16) *** #### updateWishlistItemByRef ▸ **updateWishlistItemByRef**(`obj`): `void` Updates a wishlist item by its reference. **Parameters** | Name | Type | Description | | ---------------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called on error. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called on successful update. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | | `obj.updateWishlistItemBody` | `Object` | The updated wishlist item data. See WishlistRESTAPI.json/paths/~~1api~~1wishlist~~1items~~1ref\~1{wishlistItemRef}/get for information on the fields. | | `obj.wishlistItemRef` | `string` | The reference of the wishlist item to update. | **Returns** `void` **Defined in** [wishlistService/updateWishlistItemByRef.ts:16](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/a985eddd769ca9f14ba9c8dcd446668e7d26b8ac/src/wishlistService/updateWishlistItemByRef.ts#L16) *** #### getItemsPopularity ▸ **getItemsPopularity**(`obj`): `void` Show a count of the number of times an item has been wishlisted. **Parameters** | Name | Type | Description | | ------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `obj` | `Object` | The configuration object. | | `obj.itemsPopularityBody` | `Object` | The array of product or variant refs to get statistic. See for information on the fields. | | `obj.onError` | (`error`: `any`) => `void` | The callback function to be called when an error occurs during the update. | | `obj.onSuccess` | (`response`: `any`) => `void` | The callback function to be called when the update is successful. | | `obj.tenant` | `string` | The tenant identifier. | | `obj.token` | `string` | The authentication token. | **Returns** `void` **Defined in** [wishlistService/getItemsPopularity.ts:17](https://github.com/The-Wishlist-Co/JavascriptSDK/blob/28474c0a68121d356efe16d92a4b1995b2a10349/src/wishlistService/getItemsPopularity.ts#L17)