ce-storefront 0.4.7 → 0.4.9

package/docs/sdks/cestorefrontuser/README.md

@@ -1,896 +0,0 @@
-# CeStorefrontUser
-(*auth.user*)
-
-## Overview
-
-### Available Operations
-
-* [get](#get) - Retrieve a user
-* [update](#update) - Update a user
-* [addProfileImage](#addprofileimage) - Add profile image
-* [updateProfileImage](#updateprofileimage) - Update profile image
-* [deleteProfileImage](#deleteprofileimage) - Delete profile image
-* [getProfileImage](#getprofileimage) - Retrieve a profile image
-* [deactivateAccount](#deactivateaccount) - Deactivate account
-* [changePassword](#changepassword) - Change password
-* [forgotPassword](#forgotpassword) - Forgot password
-* [resetPassword](#resetpassword) - Reset password
-* [logout](#logout) - Logout user
-
-## get
-
-The Retrieve User API is designed to facilitate the retrieval of comprehensive user information from the system. A required parameter is a user-id of the user whose information needs to be retrieved.
-
-### 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.user.get({
-    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 { authUserGet } from "ce-storefront/funcs/authUserGet.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 authUserGet(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.GetAuthUserIdRequest](../../models/operations/getauthuseridrequest.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.GetAuthUserIdResponseBody](../../models/operations/getauthuseridresponsebody.md)\>**
-
-### Errors
-
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
-
-## update
-
-The Update User API helps to efficiently modify and enhance user information within the system, ensuring that user profiles remain accurate and up-to-date. This API provides a secure and flexible mechanism for updating specific details while maintaining adherence to established conventions.
-
-### 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.user.update({
-    id: "<id>",
-    user: {
-      firstName: "Ruthe",
-      lastName: "Hegmann",
-      email: "Lizzie.Wyman@hotmail.com",
-      phone: "317-934-7640 x784",
-      countryCode: "KZ",
-      loginMethods: [
-        "email",
-      ],
-      notificationPreferences: {
-        transactional: {},
-        promotional: {},
-        newsletter: {},
-      },
-    },
-  });
-
-  // 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 { authUserUpdate } from "ce-storefront/funcs/authUserUpdate.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 authUserUpdate(ceStorefront, {
-    id: "<id>",
-    user: {
-      firstName: "Zelma",
-      lastName: "Huel",
-      email: "Houston_OHara69@gmail.com",
-      phone: "1-321-461-2304 x0484",
-      countryCode: "PE",
-      loginMethods: [
-        "whatsapp",
-      ],
-      notificationPreferences: {
-        transactional: {},
-        promotional: {},
-        newsletter: {},
-      },
-    },
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.PutAuthUserIdRequest](../../models/operations/putauthuseridrequest.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.PutAuthUserIdResponseBody](../../models/operations/putauthuseridresponsebody.md)\>**
-
-### Errors
-
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
-
-## 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.user.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 { authUserAddProfileImage } from "ce-storefront/funcs/authUserAddProfileImage.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 authUserAddProfileImage(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       | \*/\*          |
-
-## updateProfileImage
-
-The Profile Image API streamlines the process of updating 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";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.auth.user.updateProfileImage({
-    id: "<id>",
-    requestBody: {},
-  });
-
-  // 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 { authUserUpdateProfileImage } from "ce-storefront/funcs/authUserUpdateProfileImage.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 authUserUpdateProfileImage(ceStorefront, {
-    id: "<id>",
-    requestBody: {},
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.PutAuthUserIdProfileImageRequest](../../models/operations/putauthuseridprofileimagerequest.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.PutAuthUserIdProfileImageResponseBody](../../models/operations/putauthuseridprofileimageresponsebody.md)\>**
-
-### Errors
-
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
-
-## deleteProfileImage
-
-Delete profile image API streamlines the process of removing profile images associating with user accounts. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution.
-
-### 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.user.deleteProfileImage({
-    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 { authUserDeleteProfileImage } from "ce-storefront/funcs/authUserDeleteProfileImage.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 authUserDeleteProfileImage(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.DeleteAuthUserIdProfileImageRequest](../../models/operations/deleteauthuseridprofileimagerequest.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.DeleteAuthUserIdProfileImageResponseBody](../../models/operations/deleteauthuseridprofileimageresponsebody.md)\>**
-
-### Errors
-
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
-
-## getProfileImage
-
-Retrieve user profile image API streamlines the process of retriving profile images associating with user accounts. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution.
-
-### 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.user.getProfileImage({
-    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 { authUserGetProfileImage } from "ce-storefront/funcs/authUserGetProfileImage.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 authUserGetProfileImage(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.GetAuthUserIdProfileImageRequest](../../models/operations/getauthuseridprofileimagerequest.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.GetAuthUserIdProfileImageResponseBody](../../models/operations/getauthuseridprofileimageresponsebody.md)\>**
-
-### Errors
-
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
-
-## deactivateAccount
-
-The Deactivate Account API providing users with a straightforward method to deactivate their accounts. Upon successful deactivation, the API responds with a confirmation message. Error responses are detailed, aiding developers in addressing issues promptly.
-
-### 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.user.deactivateAccount({
-    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 { authUserDeactivateAccount } from "ce-storefront/funcs/authUserDeactivateAccount.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 authUserDeactivateAccount(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.PutAuthUserIdDeactivateRequest](../../models/operations/putauthuseriddeactivaterequest.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.PutAuthUserIdDeactivateResponseBody](../../models/operations/putauthuseriddeactivateresponsebody.md)\>**
-
-### Errors
-
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
-
-## changePassword
-
-The Change Password API is a key feature designed to provide a secure and standardized method for users to update their passwords.
-
-### 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.user.changePassword({
-    oldPassword: "<value>",
-    newPassword: "<value>",
-    confirmPassword: "<value>",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { authUserChangePassword } from "ce-storefront/funcs/authUserChangePassword.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 authUserChangePassword(ceStorefront, {
-    oldPassword: "<value>",
-    newPassword: "<value>",
-    confirmPassword: "<value>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.PostAuthChangePasswordRequestBody](../../models/operations/postauthchangepasswordrequestbody.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.PostAuthChangePasswordResponseBody](../../models/operations/postauthchangepasswordresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.BadRequest   | 400                 | application/json    |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
-## forgotPassword
-
-The Forgot Password API provides a secure mechanism for users to initiate the password recovery process. This API provides one-time password (OTP) token, which facilitas the resetting of user’s account password.
-
-### 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.user.forgotPassword({});
-
-  // 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 { authUserForgotPassword } from "ce-storefront/funcs/authUserForgotPassword.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 authUserForgotPassword(ceStorefront, {});
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.PostAuthForgotPasswordRequestBody](../../models/operations/postauthforgotpasswordrequestbody.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.PostAuthForgotPasswordResponseBody](../../models/operations/postauthforgotpasswordresponsebody.md)\>**
-
-### Errors
-
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
-
-## resetPassword
-
-Reset password
-
-### 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.user.resetPassword({
-    newPassword: "<value>",
-    confirmPassword: "<value>",
-    otpToken: "<value>",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { authUserResetPassword } from "ce-storefront/funcs/authUserResetPassword.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 authUserResetPassword(ceStorefront, {
-    newPassword: "<value>",
-    confirmPassword: "<value>",
-    otpToken: "<value>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.PostAuthResetPasswordRequestBody](../../models/operations/postauthresetpasswordrequestbody.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.PostAuthResetPasswordResponseBody](../../models/operations/postauthresetpasswordresponsebody.md)\>**
-
-### Errors
-
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.BadRequest | 400               | application/json  |
-| 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.user.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 { authUserLogout } from "ce-storefront/funcs/authUserLogout.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 authUserLogout(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       | \*/\*          |