ce-storefront 0.0.4 → 0.1.0

package/docs/sdks/auth/README.md

@@ -35,7 +35,7 @@ async function run() {
   const result = await ceStorefront.auth.loginAnonymously({
     xApiKey: "<YOUR_API_KEY_HERE>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -108,7 +108,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.loginWithPhone();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -181,7 +181,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.loginWithEmail();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -254,7 +254,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.loginWithWhatsapp();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -327,7 +327,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.loginWithPassword();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -400,7 +400,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.verifyOtp();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -473,7 +473,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.registerWithPhone();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -547,7 +547,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.registerWithEmail();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -622,7 +622,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.registerWithWhatsapp();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -696,7 +696,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.registerWithPassword();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -769,7 +769,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.refreshToken();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -842,7 +842,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.generateOtp();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -915,7 +915,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.verifyEmailPhone();
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/carts/README.md

@@ -25,7 +25,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.carts.create();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -100,7 +100,7 @@ async function run() {
   const result = await ceStorefront.carts.get({
     userId: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -179,7 +179,7 @@ async function run() {
   const result = await ceStorefront.carts.delete({
     userId: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -258,7 +258,7 @@ async function run() {
   const result = await ceStorefront.carts.addItem({
     id: "<id>",
   });
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/categories/README.md

@@ -25,7 +25,7 @@ async function run() {
     parentCategoryId: "a847641353e947d3bed69a4eea975634",
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/cestorefrontpayments/README.md

@@ -24,7 +24,7 @@ async function run() {
   const result = await ceStorefront.orders.payments.list({
     orderNumber: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/cestorefrontreviews/README.md

@@ -26,7 +26,7 @@ async function run() {
     productId: "<value>",
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -106,7 +106,7 @@ async function run() {
   const result = await ceStorefront.catalog.products.reviews.create({
     productId: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/cestorefrontuser/README.md

@@ -34,7 +34,7 @@ async function run() {
   const result = await ceStorefront.auth.user.get({
     id: "<id>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -111,7 +111,7 @@ async function run() {
   const result = await ceStorefront.auth.user.update({
     id: "<id>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -188,7 +188,7 @@ async function run() {
   const result = await ceStorefront.auth.user.addProfileImage({
     id: "<id>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -265,7 +265,7 @@ async function run() {
   const result = await ceStorefront.auth.user.updateProfileImage({
     id: "<id>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -342,7 +342,7 @@ async function run() {
   const result = await ceStorefront.auth.user.deleteProfileImage({
     id: "<id>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -419,7 +419,7 @@ async function run() {
   const result = await ceStorefront.auth.user.getProfileImage({
     id: "<id>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -496,7 +496,7 @@ async function run() {
   const result = await ceStorefront.auth.user.deactivateAccount({
     id: "<id>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -571,7 +571,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.user.changePassword();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -646,7 +646,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.user.forgotPassword();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -719,7 +719,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.user.resetPassword();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -793,7 +793,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.auth.user.logout();
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/checkout/README.md

@@ -29,7 +29,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.checkout.updateAddress();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -108,7 +108,7 @@ async function run() {
     cartId: "01F3Z7KG06J4ACWH1C4926KJEB",
     couponCode: "FLAT100OFF",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -188,7 +188,7 @@ async function run() {
   const result = await ceStorefront.checkout.removeCoupon({
     cartId: "01F3Z7KG06J4ACWH1C4926KJEB",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -268,7 +268,7 @@ async function run() {
     cartId: "01F3Z7KG06J4ACWH1C4926KJEB",
     loyaltyPointRedeemed: 1000,
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -348,7 +348,7 @@ async function run() {
   const result = await ceStorefront.checkout.removeLoyaltyPoints({
     cartId: "01F3Z7KG06J4ACWH1C4926KJEB",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -428,7 +428,7 @@ async function run() {
     cartId: "01F3Z7KG06J4ACWH1C4926KJEB",
     creditBalanceUsed: 200,
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -508,7 +508,7 @@ async function run() {
   const result = await ceStorefront.checkout.removeCreditBalance({
     cartId: "01F3Z7KG06J4ACWH1C4926KJEB",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -585,7 +585,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.checkout.redeemGiftCard();
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/coupons/README.md

@@ -22,7 +22,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.offers.coupons.list();
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/customersapi/README.md

@@ -8,6 +8,9 @@ Customers API
 ### Available Operations
 
 * [getRecommendedProducts](#getrecommendedproducts) - List all recommended products
+* [postCustomers](#postcustomers) - Create customer
+* [getCustomersId](#getcustomersid) - Retrieve customer detail
+* [putCustomersId](#putcustomersid) - Update customer detail
 
 ## getRecommendedProducts
 
@@ -26,7 +29,7 @@ async function run() {
   const result = await ceStorefront.customersAPI.getRecommendedProducts({
     id: "<id>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -86,3 +89,234 @@ run();
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
 | errors.SDKError     | 4xx-5xx             | */*                 |
+
+
+## postCustomers
+
+Create 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.customersAPI.postCustomers();
+  
+  // 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 { customersAPIPostCustomers } from "ce-storefront/funcs/customersAPIPostCustomers.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 customersAPIPostCustomers(ceStorefront);
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result)
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.CreateCustomer](../../models/components/createcustomer.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.PostCustomersResponseBody](../../models/operations/postcustomersresponsebody.md)\>**
+
+### Errors
+
+| Error Object        | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.BadRequest   | 400                 | application/json    |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.SDKError     | 4xx-5xx             | */*                 |
+
+
+## getCustomersId
+
+Retrieve customer detail.
+
+### Example Usage
+
+```typescript
+import { CeStorefront } from "ce-storefront";
+
+const ceStorefront = new CeStorefront({
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await ceStorefront.customersAPI.getCustomersId({
+    id: "<id>",
+  });
+  
+  // 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 { customersAPIGetCustomersId } from "ce-storefront/funcs/customersAPIGetCustomersId.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 customersAPIGetCustomersId(ceStorefront, {
+    id: "<id>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result)
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetCustomersIdRequest](../../models/operations/getcustomersidrequest.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.GetCustomersIdResponseBody](../../models/operations/getcustomersidresponsebody.md)\>**
+
+### Errors
+
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 4xx-5xx         | */*             |
+
+
+## putCustomersId
+
+Update customer detail
+
+### Example Usage
+
+```typescript
+import { CeStorefront } from "ce-storefront";
+
+const ceStorefront = new CeStorefront({
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await ceStorefront.customersAPI.putCustomersId({
+    id: "<id>",
+  });
+  
+  // 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 { customersAPIPutCustomersId } from "ce-storefront/funcs/customersAPIPutCustomersId.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 customersAPIPutCustomersId(ceStorefront, {
+    id: "<id>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result)
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.PutCustomersIdRequest](../../models/operations/putcustomersidrequest.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.PutCustomersIdResponseBody](../../models/operations/putcustomersidresponsebody.md)\>**
+
+### Errors
+
+| Error Object        | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.BadRequest   | 400                 | application/json    |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.SDKError     | 4xx-5xx             | */*                 |

package/docs/sdks/loyalty/README.md

@@ -25,7 +25,7 @@ async function run() {
   const result = await ceStorefront.customers.loyalty.get({
     userId: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -105,7 +105,7 @@ async function run() {
     userId: "<value>",
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/newsletter/README.md

@@ -22,7 +22,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.campaigns.newsletter.subscribe();
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/notificationpreferences/README.md

@@ -26,7 +26,7 @@ async function run() {
   const result = await ceStorefront.user.notificationPreferences.get({
     id: "<id>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -103,7 +103,7 @@ async function run() {
   const result = await ceStorefront.user.notificationPreferences.create({
     id: "<id>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -180,7 +180,7 @@ async function run() {
   const result = await ceStorefront.user.notificationPreferences.update({
     id: "<id>",
   });
-
+  
   // Handle the result
   console.log(result)
 }