ce-storefront 0.0.5 → 0.2.0

package/docs/sdks/cestorefrontuser/README.md

@@ -36,7 +36,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -68,7 +68,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -89,10 +89,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## update
 
@@ -110,10 +109,11 @@ const ceStorefront = new CeStorefront({
 async function run() {
   const result = await ceStorefront.auth.user.update({
     id: "<id>",
+    user: {},
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -136,6 +136,7 @@ const ceStorefront = new CeStorefrontCore({
 async function run() {
   const res = await authUserUpdate(ceStorefront, {
     id: "<id>",
+    user: {},
   });
 
   if (!res.ok) {
@@ -145,7 +146,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -166,10 +167,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## addProfileImage
 
@@ -179,6 +179,7 @@ The Profile Image API streamlines the process of uploading profile images associ
 
 ```typescript
 import { CeStorefront } from "ce-storefront";
+import { openAsBlob } from "node:fs";
 
 const ceStorefront = new CeStorefront({
   authorization: "<YOUR_BEARER_TOKEN_HERE>",
@@ -187,10 +188,13 @@ const ceStorefront = new CeStorefront({
 async function run() {
   const result = await ceStorefront.auth.user.addProfileImage({
     id: "<id>",
+    requestBody: {
+      image: await openAsBlob("example.file"),
+    },
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -203,6 +207,7 @@ 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.
@@ -213,6 +218,9 @@ const ceStorefront = new CeStorefrontCore({
 async function run() {
   const res = await authUserAddProfileImage(ceStorefront, {
     id: "<id>",
+    requestBody: {
+      image: await openAsBlob("example.file"),
+    },
   });
 
   if (!res.ok) {
@@ -222,7 +230,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -243,10 +251,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## updateProfileImage
 
@@ -264,10 +271,11 @@ const ceStorefront = new CeStorefront({
 async function run() {
   const result = await ceStorefront.auth.user.updateProfileImage({
     id: "<id>",
+    requestBody: {},
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -290,6 +298,7 @@ const ceStorefront = new CeStorefrontCore({
 async function run() {
   const res = await authUserUpdateProfileImage(ceStorefront, {
     id: "<id>",
+    requestBody: {},
   });
 
   if (!res.ok) {
@@ -299,7 +308,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -320,10 +329,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## deleteProfileImage
 
@@ -344,7 +352,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -376,7 +384,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -397,10 +405,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## getProfileImage
 
@@ -421,7 +428,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -453,7 +460,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -474,10 +481,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## deactivateAccount
 
@@ -498,7 +504,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -530,7 +536,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -551,10 +557,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## changePassword
 
@@ -570,10 +575,14 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.auth.user.changePassword();
+  const result = await ceStorefront.auth.user.changePassword({
+    oldPassword: "<value>",
+    newPassword: "<value>",
+    confirmPassword: "<value>",
+  });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -594,7 +603,11 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await authUserChangePassword(ceStorefront);
+  const res = await authUserChangePassword(ceStorefront, {
+    oldPassword: "<value>",
+    newPassword: "<value>",
+    confirmPassword: "<value>",
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -603,7 +616,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -624,12 +637,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## forgotPassword
 
@@ -645,10 +657,10 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.auth.user.forgotPassword();
+  const result = await ceStorefront.auth.user.forgotPassword({});
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -669,7 +681,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await authUserForgotPassword(ceStorefront);
+  const res = await authUserForgotPassword(ceStorefront, {});
 
   if (!res.ok) {
     throw res.error;
@@ -678,7 +690,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -699,10 +711,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## resetPassword
 
@@ -718,10 +729,14 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.auth.user.resetPassword();
+  const result = await ceStorefront.auth.user.resetPassword({
+    newPassword: "<value>",
+    confirmPassword: "<value>",
+    otpToken: "<value>",
+  });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -742,7 +757,11 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await authUserResetPassword(ceStorefront);
+  const res = await authUserResetPassword(ceStorefront, {
+    newPassword: "<value>",
+    confirmPassword: "<value>",
+    otpToken: "<value>",
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -751,7 +770,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -772,11 +791,10 @@ run();
 
 ### Errors
 
-| Error Object      | Status Code       | Content Type      |
+| Error Type        | Status Code       | Content Type      |
 | ----------------- | ----------------- | ----------------- |
 | errors.BadRequest | 400               | application/json  |
-| errors.SDKError   | 4xx-5xx           | */*               |
-
+| errors.SDKError   | 4XX, 5XX          | \*/\*             |
 
 ## logout
 
@@ -795,7 +813,7 @@ async function run() {
   const result = await ceStorefront.auth.user.logout();
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -825,7 +843,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -845,6 +863,6 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |

package/docs/sdks/checkout/README.md

@@ -28,10 +28,12 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.checkout.updateAddress();
+  const result = await ceStorefront.checkout.updateAddress({
+    cartId: "<id>",
+  });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -52,7 +54,9 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await checkoutUpdateAddress(ceStorefront);
+  const res = await checkoutUpdateAddress(ceStorefront, {
+    cartId: "<id>",
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -61,7 +65,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -82,13 +86,12 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## applyCoupon
 
@@ -110,7 +113,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -143,7 +146,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -164,12 +167,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## removeCoupon
 
@@ -190,7 +192,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -222,7 +224,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -243,12 +245,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## redeemLoyaltyPoints
 
@@ -270,7 +271,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -303,7 +304,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -324,12 +325,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## removeLoyaltyPoints
 
@@ -350,7 +350,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -382,7 +382,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -403,12 +403,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## useCreditBalance
 
@@ -430,7 +429,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -463,7 +462,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -484,12 +483,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## removeCreditBalance
 
@@ -510,7 +508,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -542,7 +540,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -563,12 +561,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## redeemGiftCard
 
@@ -584,10 +581,10 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.checkout.redeemGiftCard();
+  const result = await ceStorefront.checkout.redeemGiftCard({});
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -608,7 +605,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await checkoutRedeemGiftCard(ceStorefront);
+  const res = await checkoutRedeemGiftCard(ceStorefront, {});
 
   if (!res.ok) {
     throw res.error;
@@ -617,7 +614,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -638,6 +635,6 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |