ce-storefront 0.3.17 → 0.4.0

package/docs/sdks/addresses/README.md

@@ -1,11 +1,189 @@
 # Addresses
-(*addresses*)
+(*customers.addresses*)
 
 ## Overview
 
 ### Available Operations
 
+* [list](#list) - Retrieve all addresses
+* [add](#add) - Add address
 * [get](#get) - Retrieve particular address
+* [update](#update) - Update particular address
+* [delete](#delete) - Remove particular address
+
+## list
+
+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.addresses.list({
+    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 { customersAddressesList } from "ce-storefront/funcs/customersAddressesList.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 customersAddressesList(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.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 Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
+
+## add
+
+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.addresses.add({
+    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 { customersAddressesAdd } from "ce-storefront/funcs/customersAddressesAdd.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 customersAddressesAdd(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            | \*/\*               |
 
 ## get
 
@@ -21,7 +199,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.addresses.get({
+  const result = await ceStorefront.customers.addresses.get({
     userId: "<id>",
     addressId: "<id>",
   });
@@ -39,7 +217,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { addressesGet } from "ce-storefront/funcs/addressesGet.js";
+import { customersAddressesGet } from "ce-storefront/funcs/customersAddressesGet.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -48,7 +226,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await addressesGet(ceStorefront, {
+  const res = await customersAddressesGet(ceStorefront, {
     userId: "<id>",
     addressId: "<id>",
   });
@@ -81,6 +259,187 @@ run();
 
 ### Errors
 
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
+
+## update
+
+Update 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.addresses.update({
+    userId: "<id>",
+    addressId: "<id>",
+    requestBody: {
+      firstName: "Ruthe",
+      phone: "(496) 590-8432 x1783",
+      email: "Olen75@yahoo.com",
+      addressLine1: "5123 The Square",
+      pincode: "<value>",
+      city: "Port St. Lucie",
+      state: "Montana",
+      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 { customersAddressesUpdate } from "ce-storefront/funcs/customersAddressesUpdate.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 customersAddressesUpdate(ceStorefront, {
+    userId: "<id>",
+    addressId: "<id>",
+    requestBody: {
+      firstName: "Ruthe",
+      phone: "(496) 590-8432 x1783",
+      email: "Olen75@yahoo.com",
+      addressLine1: "5123 The Square",
+      pincode: "<value>",
+      city: "Port St. Lucie",
+      state: "Montana",
+      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.PutCustomerAddressIdRequest](../../models/operations/putcustomeraddressidrequest.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.PutCustomerAddressIdResponseBody](../../models/operations/putcustomeraddressidresponsebody.md)\>**
+
+### Errors
+
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.BadRequest   | 400                 | application/json    |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
+
+## delete
+
+Delete 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.addresses.delete({
+    userId: "<id>",
+    addressId: "<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 { customersAddressesDelete } from "ce-storefront/funcs/customersAddressesDelete.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 customersAddressesDelete(ceStorefront, {
+    userId: "<id>",
+    addressId: "<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.DeleteCustomerAddressIdRequest](../../models/operations/deletecustomeraddressidrequest.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.DeleteCustomerAddressIdResponseBody](../../models/operations/deletecustomeraddressidresponsebody.md)\>**
+
+### Errors
+
 | Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |

package/docs/sdks/auth/README.md

@@ -17,7 +17,6 @@
 * [registerWithPassword](#registerwithpassword) - Register with password
 * [refreshToken](#refreshtoken) - Refresh access token
 * [generateOtp](#generateotp) - Generate OTP
-* [logout](#logout) - Logout user
 * [verifyEmailPhone](#verifyemailphone) - Check verified email phone
 
 ## loginAnonymously
@@ -953,77 +952,6 @@ run();
 | -------------- | -------------- | -------------- |
 | errors.CeError | 4XX, 5XX       | \*/\*          |
 
-## logout
-
-The Logout User API initiate the logout process for a user. Upon a successful request, the API responds with a confirmation message. If the user is not found or there's an issue with the request, an error response is returned with an appropriate message.
-
-### Example Usage
-
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.auth.logout();
-
-  // 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 { authLogout } from "ce-storefront/funcs/authLogout.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 authLogout(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.PostAuthLogoutResponseBody](../../models/operations/postauthlogoutresponsebody.md)\>**
-
-### Errors
-
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
-
 ## verifyEmailPhone
 
 The Check Verification Status API allows to verify the status of email and phone number verification for a specific user. Upon a successful request, the API responds with the verification status of the provided email and phone number. If the user is not found or there's an issue with the request, an error response is returned with an appropriate message.