ce-storefront 0.1.0 → 0.2.0

package/docs/sdks/notificationpreferences/README.md

@@ -26,9 +26,9 @@ async function run() {
   const result = await ceStorefront.user.notificationPreferences.get({
     id: "<id>",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -60,7 +60,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -81,10 +81,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## create
 
@@ -102,10 +101,11 @@ const ceStorefront = new CeStorefront({
 async function run() {
   const result = await ceStorefront.user.notificationPreferences.create({
     id: "<id>",
+    requestBody: {},
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -128,6 +128,7 @@ const ceStorefront = new CeStorefrontCore({
 async function run() {
   const res = await userNotificationPreferencesCreate(ceStorefront, {
     id: "<id>",
+    requestBody: {},
   });
 
   if (!res.ok) {
@@ -137,7 +138,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -158,10 +159,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## update
 
@@ -179,10 +179,11 @@ const ceStorefront = new CeStorefront({
 async function run() {
   const result = await ceStorefront.user.notificationPreferences.update({
     id: "<id>",
+    requestBody: {},
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -205,6 +206,7 @@ const ceStorefront = new CeStorefrontCore({
 async function run() {
   const res = await userNotificationPreferencesUpdate(ceStorefront, {
     id: "<id>",
+    requestBody: {},
   });
 
   if (!res.ok) {
@@ -214,7 +216,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -235,6 +237,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/offers/README.md

@@ -1,2 +1,6 @@
 # Offers
-(*offers*)
+(*offers*)
+
+## Overview
+
+### Available Operations

package/docs/sdks/orders/README.md

@@ -25,10 +25,12 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.orders.create();
-  
+  const result = await ceStorefront.orders.create({
+    cartId: "<id>",
+  });
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -49,7 +51,9 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await ordersCreate(ceStorefront);
+  const res = await ordersCreate(ceStorefront, {
+    cartId: "<id>",
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -58,7 +62,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -79,13 +83,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            | \*/\*               |
 
 ## list
 
@@ -105,9 +108,9 @@ async function run() {
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
     userId: "<value>",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -140,7 +143,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -161,10 +164,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## get
 
@@ -183,9 +185,9 @@ async function run() {
   const result = await ceStorefront.orders.get({
     orderNumber: "<value>",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -217,7 +219,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -238,12 +240,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## cancel
 
@@ -261,10 +262,14 @@ const ceStorefront = new CeStorefront({
 async function run() {
   const result = await ceStorefront.orders.cancel({
     orderNumber: "<value>",
+    requestBody: {
+      cancellationReason: "<value>",
+      refundMode: "original_payment_mode",
+    },
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -287,6 +292,10 @@ const ceStorefront = new CeStorefrontCore({
 async function run() {
   const res = await ordersCancel(ceStorefront, {
     orderNumber: "<value>",
+    requestBody: {
+      cancellationReason: "<value>",
+      refundMode: "original_payment_mode",
+    },
   });
 
   if (!res.ok) {
@@ -296,7 +305,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -317,12 +326,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## retryPayment
 
@@ -340,10 +348,11 @@ const ceStorefront = new CeStorefront({
 async function run() {
   const result = await ceStorefront.orders.retryPayment({
     orderNumber: "<value>",
+    requestBody: {},
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -366,6 +375,7 @@ const ceStorefront = new CeStorefrontCore({
 async function run() {
   const res = await ordersRetryPayment(ceStorefront, {
     orderNumber: "<value>",
+    requestBody: {},
   });
 
   if (!res.ok) {
@@ -375,7 +385,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -396,6 +406,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/payments/README.md

@@ -22,10 +22,13 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.payments.generateHash();
-  
+  const result = await ceStorefront.payments.generateHash({
+    paymentGateway: "payu",
+    plainText: "<value>",
+  });
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -46,7 +49,10 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await paymentsGenerateHash(ceStorefront);
+  const res = await paymentsGenerateHash(ceStorefront, {
+    paymentGateway: "payu",
+    plainText: "<value>",
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -55,7 +61,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -76,10 +82,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## getMethods
 
@@ -98,9 +103,9 @@ async function run() {
   const result = await ceStorefront.payments.getMethods({
     paymentGateway: "PAYU",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -132,7 +137,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -153,6 +158,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/products/README.md

@@ -28,9 +28,9 @@ async function run() {
   const result = await ceStorefront.catalog.products.list({
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -62,7 +62,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -83,12 +83,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## get
 
@@ -107,9 +106,9 @@ async function run() {
   const result = await ceStorefront.catalog.products.get({
     productId: "41",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -141,7 +140,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -162,12 +161,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## getSimilar
 
@@ -184,9 +182,9 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.catalog.products.getSimilar({});
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -216,7 +214,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -237,12 +235,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## getUpsells
 
@@ -259,9 +256,9 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.catalog.products.getUpsells({});
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -291,7 +288,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -312,12 +309,11 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
-
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |
 
 ## getCrossSells
 
@@ -334,9 +330,9 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.catalog.products.getCrossSells({});
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -366,7 +362,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -387,8 +383,8 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |

package/docs/sdks/promotions/README.md

@@ -22,9 +22,9 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.offers.promotions.list();
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -54,7 +54,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -74,7 +74,7 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |

package/docs/sdks/refunds/README.md

@@ -24,9 +24,9 @@ async function run() {
   const result = await ceStorefront.orders.refunds.list({
     orderNumber: "<value>",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -58,7 +58,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -79,8 +79,8 @@ run();
 
 ### Errors
 
-| Error Object        | Status Code         | Content Type        |
+| Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
+| errors.SDKError     | 4XX, 5XX            | \*/\*               |

package/docs/sdks/reviews/README.md

@@ -24,9 +24,9 @@ async function run() {
   const result = await ceStorefront.customers.reviews.list({
     userId: "<value>",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -58,7 +58,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -79,6 +79,6 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |