ce-storefront 0.0.1 → 0.0.4

package/docs/sdks/{common → coupons}/README.md

@@ -1,15 +1,15 @@
-# Common
-(*common*)
+# Coupons
+(*offers.coupons*)
 
 ## Overview
 
 ### Available Operations
 
-* [getCountries](#getcountries) - Retrieve all countries
+* [list](#list) - Retrieve all coupons
 
-## getCountries
+## list
 
-Retrieve all countries
+Retrieve active coupons
 
 ### Example Usage
 
@@ -21,7 +21,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.common.getCountries();
+  const result = await ceStorefront.offers.coupons.list();
 
   // Handle the result
   console.log(result)
@@ -36,7 +36,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { commonGetCountries } from "ce-storefront/funcs/commonGetCountries.js";
+import { offersCouponsList } from "ce-storefront/funcs/offersCouponsList.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -45,7 +45,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await commonGetCountries(ceStorefront);
+  const res = await offersCouponsList(ceStorefront);
 
   if (!res.ok) {
     throw res.error;
@@ -70,7 +70,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.GetCommonCountriesResponseBody](../../models/operations/getcommoncountriesresponsebody.md)\>**
+**Promise\<[operations.GetCouponsResponseBody](../../models/operations/getcouponsresponsebody.md)\>**
 
 ### Errors
 

package/docs/sdks/customers/README.md

@@ -1,84 +1,2 @@
 # Customers
-(*customers*)
-
-## Overview
-
-### Available Operations
-
-* [getAddresses](#getaddresses) - Retrieve all addresses
-
-## getAddresses
-
-Retrieve billing and shipping address of particular customer
-
-### Example Usage
-
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.customers.getAddresses({
-    userId: "<value>",
-  });
-
-  // Handle the result
-  console.log(result)
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { customersGetAddresses } from "ce-storefront/funcs/customersGetAddresses.js";
-
-// Use `CeStorefrontCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const ceStorefront = new CeStorefrontCore({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const res = await customersGetAddresses(ceStorefront, {
-    userId: "<value>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result)
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetAddressRequest](../../models/operations/getaddressrequest.md)                                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.GetAddressResponseBody](../../models/operations/getaddressresponsebody.md)\>**
-
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+(*customers*)

package/docs/sdks/{upsell → customersapi}/README.md

@@ -1,15 +1,17 @@
-# UpSell
-(*catalog.products.upSell*)
+# CustomersAPI
+(*customersAPI*)
 
 ## Overview
 
+Customers API
+
 ### Available Operations
 
-* [list](#list) - Retrieve up-sell products
+* [getRecommendedProducts](#getrecommendedproducts) - List all recommended products
 
-## list
+## getRecommendedProducts
 
-Retrieves a list of products specified for upsell. The upsell products are returned based on product ids specified in request param.
+Retrieves a list of recommended products for a specified user based on their browsing history, past purchases, and indicated preferences. The recommended products are returned sorted by relevance, providing a personalized shopping experience for each user.
 
 ### Example Usage
 
@@ -21,7 +23,9 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.catalog.products.upSell.list({});
+  const result = await ceStorefront.customersAPI.getRecommendedProducts({
+    id: "<id>",
+  });
 
   // Handle the result
   console.log(result)
@@ -36,7 +40,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogProductsUpSellList } from "ce-storefront/funcs/catalogProductsUpSellList.js";
+import { customersAPIGetRecommendedProducts } from "ce-storefront/funcs/customersAPIGetRecommendedProducts.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -45,7 +49,9 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await catalogProductsUpSellList(ceStorefront, {});
+  const res = await customersAPIGetRecommendedProducts(ceStorefront, {
+    id: "<id>",
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -64,14 +70,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetUpSellRequest](../../models/operations/getupsellrequest.md)                                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.GetRecommendedProductsRequest](../../models/operations/getrecommendedproductsrequest.md)                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.GetUpSellResponseBody](../../models/operations/getupsellresponsebody.md)\>**
+**Promise\<[operations.GetRecommendedProductsResponseBody](../../models/operations/getrecommendedproductsresponsebody.md)\>**
 
 ### Errors
 

package/docs/sdks/{otp → newsletter}/README.md

@@ -1,15 +1,15 @@
-# Otp
-(*auth.otp*)
+# Newsletter
+(*campaigns.newsletter*)
 
 ## Overview
 
 ### Available Operations
 
-* [generate](#generate) - Generate OTP
+* [subscribe](#subscribe) - Subscribe to newsletter
 
-## generate
+## subscribe
 
-Generating a One-Time Password (OTP) typically involves creating a random code that is sent to a user for authentication or verification purposes.
+Subscribe to newsletter
 
 ### Example Usage
 
@@ -21,7 +21,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.auth.otp.generate();
+  const result = await ceStorefront.campaigns.newsletter.subscribe();
 
   // Handle the result
   console.log(result)
@@ -36,7 +36,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { authOtpGenerate } from "ce-storefront/funcs/authOtpGenerate.js";
+import { campaignsNewsletterSubscribe } from "ce-storefront/funcs/campaignsNewsletterSubscribe.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -45,7 +45,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await authOtpGenerate(ceStorefront);
+  const res = await campaignsNewsletterSubscribe(ceStorefront);
 
   if (!res.ok) {
     throw res.error;
@@ -64,14 +64,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.PostAuthGenerateOtpRequestBody](../../models/operations/postauthgenerateotprequestbody.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.PostCustomersNewsletterSubscriptionRequestBody](../../models/operations/postcustomersnewslettersubscriptionrequestbody.md)                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.PostAuthGenerateOtpResponseBody](../../models/operations/postauthgenerateotpresponsebody.md)\>**
+**Promise\<[operations.PostCustomersNewsletterSubscriptionResponseBody](../../models/operations/postcustomersnewslettersubscriptionresponsebody.md)\>**
 
 ### Errors
 

package/docs/sdks/{returns → notificationpreferences}/README.md

@@ -1,17 +1,17 @@
-# Returns
-(*orders.returns*)
+# NotificationPreferences
+(*user.notificationPreferences*)
 
 ## Overview
 
 ### Available Operations
 
-* [create](#create) - Create order return
-* [list](#list) - List all order returns
-* [get](#get) - Retrieve order return detail
+* [get](#get) - Retrieve user notification preferences
+* [create](#create) - Create user notification preferences
+* [update](#update) - Update user notification preferences
 
-## create
+## get
 
-Create order return
+The Retrieve Notification Preferences API allows clients to fetch a user's notification preferences based on their unique user identifier (user_id).
 
 ### Example Usage
 
@@ -23,8 +23,8 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.orders.returns.create({
-    orderNumber: "<value>",
+  const result = await ceStorefront.user.notificationPreferences.get({
+    id: "<id>",
   });
 
   // Handle the result
@@ -40,7 +40,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { ordersReturnsCreate } from "ce-storefront/funcs/ordersReturnsCreate.js";
+import { userNotificationPreferencesGet } from "ce-storefront/funcs/userNotificationPreferencesGet.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -49,8 +49,8 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await ordersReturnsCreate(ceStorefront, {
-    orderNumber: "<value>",
+  const res = await userNotificationPreferencesGet(ceStorefront, {
+    id: "<id>",
   });
 
   if (!res.ok) {
@@ -70,27 +70,25 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.PostOrdersOrderNumberReturnRequest](../../models/operations/postordersordernumberreturnrequest.md)                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.GetAuthUserIdNotificationPreferencesRequest](../../models/operations/getauthuseridnotificationpreferencesrequest.md)                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.PostOrdersOrderNumberReturnResponseBody](../../models/operations/postordersordernumberreturnresponsebody.md)\>**
+**Promise\<[operations.GetAuthUserIdNotificationPreferencesResponseBody](../../models/operations/getauthuseridnotificationpreferencesresponsebody.md)\>**
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 4xx-5xx         | */*             |
 
 
-## list
+## create
 
-List all order returns
+Create user notification preferences API allows clients to create a user's notification preferences based on their unique user identifier (user_id).
 
 ### Example Usage
 
@@ -102,8 +100,8 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.orders.returns.list({
-    orderNumber: "<value>",
+  const result = await ceStorefront.user.notificationPreferences.create({
+    id: "<id>",
   });
 
   // Handle the result
@@ -119,7 +117,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { ordersReturnsList } from "ce-storefront/funcs/ordersReturnsList.js";
+import { userNotificationPreferencesCreate } from "ce-storefront/funcs/userNotificationPreferencesCreate.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -128,8 +126,8 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await ordersReturnsList(ceStorefront, {
-    orderNumber: "<value>",
+  const res = await userNotificationPreferencesCreate(ceStorefront, {
+    id: "<id>",
   });
 
   if (!res.ok) {
@@ -149,14 +147,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetOrdersOrderNumberReturnRequest](../../models/operations/getordersordernumberreturnrequest.md)                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.PostAuthUserIdNotificationPreferencesRequest](../../models/operations/postauthuseridnotificationpreferencesrequest.md)                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.GetOrdersOrderNumberReturnResponseBody](../../models/operations/getordersordernumberreturnresponsebody.md)\>**
+**Promise\<[operations.PostAuthUserIdNotificationPreferencesResponseBody](../../models/operations/postauthuseridnotificationpreferencesresponsebody.md)\>**
 
 ### Errors
 
@@ -165,9 +163,9 @@ run();
 | errors.SDKError | 4xx-5xx         | */*             |
 
 
-## get
+## update
 
-Retrieve order return detail
+Update Notification Preferences API allows clients to update a user's notification preferences based on their unique user identifier (user_id).
 
 ### Example Usage
 
@@ -179,9 +177,8 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.orders.returns.get({
-    orderNumber: "<value>",
-    returnId: "<value>",
+  const result = await ceStorefront.user.notificationPreferences.update({
+    id: "<id>",
   });
 
   // Handle the result
@@ -197,7 +194,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { ordersReturnsGet } from "ce-storefront/funcs/ordersReturnsGet.js";
+import { userNotificationPreferencesUpdate } from "ce-storefront/funcs/userNotificationPreferencesUpdate.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -206,9 +203,8 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await ordersReturnsGet(ceStorefront, {
-    orderNumber: "<value>",
-    returnId: "<value>",
+  const res = await userNotificationPreferencesUpdate(ceStorefront, {
+    id: "<id>",
   });
 
   if (!res.ok) {
@@ -228,14 +224,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetOrdersOrderNumberReturnReturnIdRequest](../../models/operations/getordersordernumberreturnreturnidrequest.md)                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.PutAuthUserIdNotificationPreferencesRequest](../../models/operations/putauthuseridnotificationpreferencesrequest.md)                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.GetOrdersOrderNumberReturnReturnIdResponseBody](../../models/operations/getordersordernumberreturnreturnidresponsebody.md)\>**
+**Promise\<[operations.PutAuthUserIdNotificationPreferencesResponseBody](../../models/operations/putauthuseridnotificationpreferencesresponsebody.md)\>**
 
 ### Errors