ce-storefront 0.0.1 → 0.0.4

package/docs/sdks/auth/README.md

@@ -5,6 +5,7 @@
 
 ### Available Operations
 
+* [loginAnonymously](#loginanonymously) - Anonymous user
 * [loginWithPhone](#loginwithphone) - Login with phone
 * [loginWithEmail](#loginwithemail) - Login with email
 * [loginWithWhatsapp](#loginwithwhatsapp) - Login with whatsapp
@@ -14,10 +15,84 @@
 * [registerWithEmail](#registerwithemail) - Register with email
 * [registerWithWhatsapp](#registerwithwhatsapp) - Register with whatsapp
 * [registerWithPassword](#registerwithpassword) - Register with password
-* [getUser](#getuser) - Retrieve a user
-* [updateUser](#updateuser) - Update a user
+* [refreshToken](#refreshtoken) - Refresh access token
+* [generateOtp](#generateotp) - Generate OTP
 * [verifyEmailPhone](#verifyemailphone) - Check verified email phone
 
+## loginAnonymously
+
+This API’s focus is on anonymous users who have not undergone the formal account creation process. These anonymous users are associated with a unique identifier called a ULID, ensuring that even in the absence of a fully realized account, there is a distinct and trackable identity for each user. 
+To interact with the system, each anonymous user is issued an access token. This access token plays a dual role in the system: it serves as a means of authenticating the user and it also acts as a tool for authorization, determining what actions the authenticated user is permitted to perform.
+
+### Example Usage
+
+```typescript
+import { CeStorefront } from "ce-storefront";
+
+const ceStorefront = new CeStorefront();
+
+async function run() {
+  const result = await ceStorefront.auth.loginAnonymously({
+    xApiKey: "<YOUR_API_KEY_HERE>",
+  });
+
+  // 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 { authLoginAnonymously } from "ce-storefront/funcs/authLoginAnonymously.js";
+
+// Use `CeStorefrontCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const ceStorefront = new CeStorefrontCore();
+
+async function run() {
+  const res = await authLoginAnonymously(ceStorefront, {
+    xApiKey: "<YOUR_API_KEY_HERE>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result)
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `security`                                                                                                                                                                     | [operations.PostAuthAnonymousSecurity](../../models/operations/postauthanonymoussecurity.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The security requirements 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.PostAuthAnonymousResponseBody](../../models/operations/postauthanonymousresponsebody.md)\>**
+
+### Errors
+
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 4xx-5xx         | */*             |
+
+
 ## loginWithPhone
 
 This API enables users to authenticate into the system using their phone number. It provides a secure way for users to log in by verifying their identity through a one-time password (OTP) sent to their registered phone.
@@ -679,9 +754,9 @@ run();
 | errors.SDKError | 4xx-5xx         | */*             |
 
 
-## getUser
+## refreshToken
 
-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.
+The Refresh Access Token API is an integral component designed to enhance security and user experience. It enables clients to refresh their access tokens seamlessly, extending user sessions without compromising security.
 
 ### Example Usage
 
@@ -693,9 +768,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.auth.getUser({
-    id: "<id>",
-  });
+  const result = await ceStorefront.auth.refreshToken();
 
   // Handle the result
   console.log(result)
@@ -710,7 +783,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { authGetUser } from "ce-storefront/funcs/authGetUser.js";
+import { authRefreshToken } from "ce-storefront/funcs/authRefreshToken.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -719,9 +792,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await authGetUser(ceStorefront, {
-    id: "<id>",
-  });
+  const res = await authRefreshToken(ceStorefront);
 
   if (!res.ok) {
     throw res.error;
@@ -740,14 +811,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetAuthUserIdRequest](../../models/operations/getauthuseridrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.PostAuthRefreshTokenRequestBody](../../models/operations/postauthrefreshtokenrequestbody.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)\>**
+**Promise\<[operations.PostAuthRefreshTokenResponseBody](../../models/operations/postauthrefreshtokenresponsebody.md)\>**
 
 ### Errors
 
@@ -756,9 +827,9 @@ run();
 | errors.SDKError | 4xx-5xx         | */*             |
 
 
-## updateUser
+## generateOtp
 
-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.
+Generating a One-Time Password (OTP) typically involves creating a random code that is sent to a user for authentication or verification purposes.
 
 ### Example Usage
 
@@ -770,9 +841,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.auth.updateUser({
-    id: "<id>",
-  });
+  const result = await ceStorefront.auth.generateOtp();
 
   // Handle the result
   console.log(result)
@@ -787,7 +856,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { authUpdateUser } from "ce-storefront/funcs/authUpdateUser.js";
+import { authGenerateOtp } from "ce-storefront/funcs/authGenerateOtp.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -796,9 +865,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await authUpdateUser(ceStorefront, {
-    id: "<id>",
-  });
+  const res = await authGenerateOtp(ceStorefront);
 
   if (!res.ok) {
     throw res.error;
@@ -817,14 +884,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.PutAuthUserIdRequest](../../models/operations/putauthuseridrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.PostAuthGenerateOtpRequestBody](../../models/operations/postauthgenerateotprequestbody.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)\>**
+**Promise\<[operations.PostAuthGenerateOtpResponseBody](../../models/operations/postauthgenerateotpresponsebody.md)\>**
 
 ### Errors
 

package/docs/sdks/campaigns/README.md

@@ -1,80 +1,2 @@
 # Campaigns
-(*campaigns*)
-
-## Overview
-
-### Available Operations
-
-* [subscribeNewsletter](#subscribenewsletter) - Subscribe to newsletter
-
-## subscribeNewsletter
-
-Subscribe to newsletter
-
-### Example Usage
-
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.campaigns.subscribeNewsletter();
-
-  // 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 { campaignsSubscribeNewsletter } from "ce-storefront/funcs/campaignsSubscribeNewsletter.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 campaignsSubscribeNewsletter(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.PostCustomersNewsletterSubscriptionRequestBody](../../models/operations/postcustomersnewslettersubscriptionrequestbody.md)                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.PostCustomersNewsletterSubscriptionResponseBody](../../models/operations/postcustomersnewslettersubscriptionresponsebody.md)\>**
-
-### Errors
-
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+(*campaigns*)