ce-storefront 0.3.10 → 0.3.17

package/docs/sdks/cestorefrontusers/README.md

@@ -0,0 +1,92 @@
+# CeStorefrontUsers
+(*auth.users*)
+
+## Overview
+
+### Available Operations
+
+* [addProfileImage](#addprofileimage) - Add profile image
+
+## addProfileImage
+
+The Profile Image API streamlines the process of uploading profile images associating with user accounts, offering a user-centric approach to visual identity customization. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution. Overall, the Profile Image API enhances user engagement by seamlessly integrating personalized visual elements into digital platforms.
+
+### Example Usage
+
+```typescript
+import { CeStorefront } from "ce-storefront";
+import { openAsBlob } from "node:fs";
+
+const ceStorefront = new CeStorefront({
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await ceStorefront.auth.users.addProfileImage({
+    id: "<id>",
+    requestBody: {
+      image: await openAsBlob("example.file"),
+    },
+  });
+
+  // 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 { authUsersAddProfileImage } from "ce-storefront/funcs/authUsersAddProfileImage.js";
+import { openAsBlob } from "node:fs";
+
+// 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 authUsersAddProfileImage(ceStorefront, {
+    id: "<id>",
+    requestBody: {
+      image: await openAsBlob("example.file"),
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.PostAuthUserIdProfileImageRequest](../../models/operations/postauthuseridprofileimagerequest.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.PostAuthUserIdProfileImageResponseBody](../../models/operations/postauthuseridprofileimageresponsebody.md)\>**
+
+### Errors
+
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |

package/docs/sdks/countries/README.md

@@ -0,0 +1,79 @@
+# Countries
+(*utils.countries*)
+
+## Overview
+
+### Available Operations
+
+* [get](#get) - Retrieve all countries
+
+## get
+
+Retrieve all countries
+
+### Example Usage
+
+```typescript
+import { CeStorefront } from "ce-storefront";
+
+const ceStorefront = new CeStorefront({
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await ceStorefront.utils.countries.get();
+
+  // 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 { utilsCountriesGet } from "ce-storefront/funcs/utilsCountriesGet.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 utilsCountriesGet(ceStorefront);
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `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.GetCommonCountriesResponseBody](../../models/operations/getcommoncountriesresponsebody.md)\>**
+
+### Errors
+
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |

package/docs/sdks/customers/README.md

@@ -3,15 +3,15 @@
 
 ## Overview
 
-Customers
-
 ### Available Operations
 
-* [postCustomers](#postcustomers) - Create customer
-* [getCustomersId](#getcustomersid) - Retrieve customer detail
-* [putCustomersId](#putcustomersid) - Update customer detail
+* [create](#create) - Create customer
+* [get](#get) - Retrieve customer detail
+* [update](#update) - Update customer detail
+* [addAddress](#addaddress) - Add address
+* [getReviews](#getreviews) - Retrieve all reviews
 
-## postCustomers
+## create
 
 Create customer
 
@@ -25,7 +25,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.customers.postCustomers({});
+  const result = await ceStorefront.customers.create({});
 
   // Handle the result
   console.log(result);
@@ -40,7 +40,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { customersPostCustomers } from "ce-storefront/funcs/customersPostCustomers.js";
+import { customersCreate } from "ce-storefront/funcs/customersCreate.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -49,7 +49,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await customersPostCustomers(ceStorefront, {});
+  const res = await customersCreate(ceStorefront, {});
 
   if (!res.ok) {
     throw res.error;
@@ -85,7 +85,7 @@ run();
 | errors.Unauthorized | 401                 | application/json    |
 | errors.CeError      | 4XX, 5XX            | \*/\*               |
 
-## getCustomersId
+## get
 
 Retrieve customer detail.
 
@@ -99,7 +99,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.customers.getCustomersId({
+  const result = await ceStorefront.customers.get({
     id: "<id>",
   });
 
@@ -116,7 +116,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { customersGetCustomersId } from "ce-storefront/funcs/customersGetCustomersId.js";
+import { customersGet } from "ce-storefront/funcs/customersGet.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -125,7 +125,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await customersGetCustomersId(ceStorefront, {
+  const res = await customersGet(ceStorefront, {
     id: "<id>",
   });
 
@@ -161,7 +161,7 @@ run();
 | -------------- | -------------- | -------------- |
 | errors.CeError | 4XX, 5XX       | \*/\*          |
 
-## putCustomersId
+## update
 
 Update customer detail
 
@@ -175,7 +175,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.customers.putCustomersId({
+  const result = await ceStorefront.customers.update({
     id: "<id>",
     updateCustomer: {},
   });
@@ -193,7 +193,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { customersPutCustomersId } from "ce-storefront/funcs/customersPutCustomersId.js";
+import { customersUpdate } from "ce-storefront/funcs/customersUpdate.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -202,7 +202,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await customersPutCustomersId(ceStorefront, {
+  const res = await customersUpdate(ceStorefront, {
     id: "<id>",
     updateCustomer: {},
   });
@@ -239,4 +239,178 @@ run();
 | ------------------- | ------------------- | ------------------- |
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
+
+## addAddress
+
+Add new address
+
+### 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.addAddress({
+    userId: "<id>",
+    requestBody: {
+      firstName: "Katlynn",
+      phone: "895-711-7545 x3085",
+      email: "Daphney.Balistreri@gmail.com",
+      addressLine1: "1207 Railway Street",
+      pincode: "<value>",
+      city: "Lake Isaacside",
+      state: "Iowa",
+      country: "India",
+    },
+  });
+
+  // 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 { customersAddAddress } from "ce-storefront/funcs/customersAddAddress.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 customersAddAddress(ceStorefront, {
+    userId: "<id>",
+    requestBody: {
+      firstName: "Katlynn",
+      phone: "895-711-7545 x3085",
+      email: "Daphney.Balistreri@gmail.com",
+      addressLine1: "1207 Railway Street",
+      pincode: "<value>",
+      city: "Lake Isaacside",
+      state: "Iowa",
+      country: "India",
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.PostAddressRequest](../../models/operations/postaddressrequest.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.PostAddressResponseBody](../../models/operations/postaddressresponsebody.md)\>**
+
+### Errors
+
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.BadRequest   | 400                 | application/json    |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
+
+## getReviews
+
+Retrieve all reviews
+
+### 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.getReviews({
+    userId: "<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 { customersGetReviews } from "ce-storefront/funcs/customersGetReviews.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 customersGetReviews(ceStorefront, {
+    userId: "<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.GetCustomersUserIdReviewsRequest](../../models/operations/getcustomersuseridreviewsrequest.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.GetCustomersUserIdReviewsResponseBody](../../models/operations/getcustomersuseridreviewsresponsebody.md)\>**
+
+### Errors
+
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |

package/docs/sdks/juspay/README.md

@@ -7,11 +7,11 @@ Juspay Payments
 
 ### Available Operations
 
-* [postPaymentsJuspayCreateOrder](#postpaymentsjuspaycreateorder) - Create order in juspay
-* [postPaymentsJuspayCreateCustomer](#postpaymentsjuspaycreatecustomer) - Create customer in juspay
-* [getPaymentsJuspayCustomer](#getpaymentsjuspaycustomer) - Retrieve customer from juspay
+* [createOrder](#createorder) - Create order in juspay
+* [createCustomer](#createcustomer) - Create customer in juspay
+* [getCustomer](#getcustomer) - Retrieve customer from juspay
 
-## postPaymentsJuspayCreateOrder
+## createOrder
 
 Creates an order in the Juspay system and fetches the corresponding client_auth_token.
 To be used for Express Checkout integration.
@@ -26,7 +26,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.juspay.postPaymentsJuspayCreateOrder({});
+  const result = await ceStorefront.juspay.createOrder({});
 
   // Handle the result
   console.log(result);
@@ -41,7 +41,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { juspayPostPaymentsJuspayCreateOrder } from "ce-storefront/funcs/juspayPostPaymentsJuspayCreateOrder.js";
+import { juspayCreateOrder } from "ce-storefront/funcs/juspayCreateOrder.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -50,7 +50,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await juspayPostPaymentsJuspayCreateOrder(ceStorefront, {});
+  const res = await juspayCreateOrder(ceStorefront, {});
 
   if (!res.ok) {
     throw res.error;
@@ -87,7 +87,7 @@ run();
 | errors.NotFound     | 404                 | application/json    |
 | errors.CeError      | 4XX, 5XX            | \*/\*               |
 
-## postPaymentsJuspayCreateCustomer
+## createCustomer
 
 Create customer in juspay.
 
@@ -101,7 +101,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.juspay.postPaymentsJuspayCreateCustomer({});
+  const result = await ceStorefront.juspay.createCustomer({});
 
   // Handle the result
   console.log(result);
@@ -116,7 +116,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { juspayPostPaymentsJuspayCreateCustomer } from "ce-storefront/funcs/juspayPostPaymentsJuspayCreateCustomer.js";
+import { juspayCreateCustomer } from "ce-storefront/funcs/juspayCreateCustomer.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -125,7 +125,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await juspayPostPaymentsJuspayCreateCustomer(ceStorefront, {});
+  const res = await juspayCreateCustomer(ceStorefront, {});
 
   if (!res.ok) {
     throw res.error;
@@ -162,7 +162,7 @@ run();
 | errors.NotFound     | 404                 | application/json    |
 | errors.CeError      | 4XX, 5XX            | \*/\*               |
 
-## getPaymentsJuspayCustomer
+## getCustomer
 
 Retrieve customer from juspay.
 
@@ -176,7 +176,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.juspay.getPaymentsJuspayCustomer({
+  const result = await ceStorefront.juspay.getCustomer({
     userId: "<id>",
   });
 
@@ -193,7 +193,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { juspayGetPaymentsJuspayCustomer } from "ce-storefront/funcs/juspayGetPaymentsJuspayCustomer.js";
+import { juspayGetCustomer } from "ce-storefront/funcs/juspayGetCustomer.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -202,7 +202,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await juspayGetPaymentsJuspayCustomer(ceStorefront, {
+  const res = await juspayGetCustomer(ceStorefront, {
     userId: "<id>",
   });