ce-storefront 0.11.0 → 0.11.2

package/README.md

@@ -320,15 +320,23 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-If the request fails due to, for example 4XX or 5XX status codes, it will throw a `CeError`.
+Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `listProducts` method may throw the following errors:
 
-| Error Type     | Status Code | Content Type |
-| -------------- | ----------- | ------------ |
-| errors.CeError | 4XX, 5XX    | \*/\*        |
+| Error Type          | Status Code | Content Type     |
+| ------------------- | ----------- | ---------------- |
+| errors.Unauthorized | 401         | application/json |
+| errors.NotFound     | 404         | application/json |
+| errors.CeError      | 4XX, 5XX    | \*/\*            |
+
+If the method throws an error and it is not captured by the known errors, it will default to throwing a `CeError`.
 
 ```typescript
 import { CeStorefront } from "ce-storefront";
-import { SDKValidationError } from "ce-storefront/models/errors";
+import {
+  NotFound,
+  SDKValidationError,
+  Unauthorized,
+} from "ce-storefront/models/errors";
 
 const ceStorefront = new CeStorefront({
   authorization: "<YOUR_BEARER_TOKEN_HERE>",
@@ -346,19 +354,21 @@ async function run() {
   } catch (err) {
     switch (true) {
       // The server response does not match the expected SDK schema
-      case (err instanceof SDKValidationError):
-        {
-          // Pretty-print will provide a human-readable multi-line error message
-          console.error(err.pretty());
-          // Raw value may also be inspected
-          console.error(err.rawValue);
-          return;
-        }
-        ceerror.js;
-      // Server returned an error status code or an unknown content type
-      case (err instanceof CeError): {
-        console.error(err.statusCode);
-        console.error(err.rawResponse.body);
+      case (err instanceof SDKValidationError): {
+        // Pretty-print will provide a human-readable multi-line error message
+        console.error(err.pretty());
+        // Raw value may also be inspected
+        console.error(err.rawValue);
+        return;
+      }
+      case (err instanceof Unauthorized): {
+        // Handle err.data$: UnauthorizedData
+        console.error(err);
+        return;
+      }
+      case (err instanceof NotFound): {
+        // Handle err.data$: NotFoundData
+        console.error(err);
         return;
       }
       default: {

package/docs/sdks/carts/README.md

@@ -194,13 +194,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.GetCartResponse](../../models/operations/getcartresponse.md)\>**
+**Promise\<[operations.GetCartResponseBody](../../models/operations/getcartresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## deleteCart
 
@@ -270,13 +272,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.DeleteCartResponse](../../models/operations/deletecartresponse.md)\>**
+**Promise\<[operations.DeleteCartResponseBody](../../models/operations/deletecartresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## getUserCart
 
@@ -346,13 +350,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.GetUserCartResponse](../../models/operations/getusercartresponse.md)\>**
+**Promise\<[operations.GetUserCartResponseBody](../../models/operations/getusercartresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## removeUserCart
 
@@ -422,13 +428,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.DeleteUserCartResponse](../../models/operations/deleteusercartresponse.md)\>**
+**Promise\<[operations.DeleteUserCartResponseBody](../../models/operations/deleteusercartresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## updateCart
 
@@ -508,13 +516,16 @@ run();
 
 ### Response
 
-**Promise\<[operations.UpdateCartResponse](../../models/operations/updatecartresponse.md)\>**
+**Promise\<[operations.UpdateCartResponseBody](../../models/operations/updatecartresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.BadRequest   | 400                 | application/json    |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## createCartAddress
 
@@ -592,13 +603,16 @@ run();
 
 ### Response
 
-**Promise\<[operations.CreateCartAddressResponse](../../models/operations/createcartaddressresponse.md)\>**
+**Promise\<[operations.CreateCartAddressResponseBody](../../models/operations/createcartaddressresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.BadRequest   | 400                 | application/json    |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## addShippingMethod
 
@@ -674,13 +688,16 @@ run();
 
 ### Response
 
-**Promise\<[operations.UpdateShippingMethodResponse](../../models/operations/updateshippingmethodresponse.md)\>**
+**Promise\<[operations.UpdateShippingMethodResponseBody](../../models/operations/updateshippingmethodresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.BadRequest   | 400                 | application/json    |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## applyCoupon
 
@@ -756,13 +773,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.ApplyCouponResponse](../../models/operations/applycouponresponse.md)\>**
+**Promise\<[operations.ApplyCouponResponseBody](../../models/operations/applycouponresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.BadRequest   | 400                 | application/json    |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## removeCoupon
 
@@ -832,13 +851,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.RemoveCouponResponse](../../models/operations/removecouponresponse.md)\>**
+**Promise\<[operations.RemoveCouponResponseBody](../../models/operations/removecouponresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.BadRequest   | 400                 | application/json    |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## redeemLoyaltyPoints
 
@@ -914,13 +935,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.RedeemLoyaltyPointsResponse](../../models/operations/redeemloyaltypointsresponse.md)\>**
+**Promise\<[operations.RedeemLoyaltyPointsResponseBody](../../models/operations/redeemloyaltypointsresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.BadRequest   | 400                 | application/json    |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## removeLoyaltyPoints
 
@@ -990,10 +1013,12 @@ run();
 
 ### Response
 
-**Promise\<[operations.RemoveLoyaltyPointsResponse](../../models/operations/removeloyaltypointsresponse.md)\>**
+**Promise\<[operations.RemoveLoyaltyPointsResponseBody](../../models/operations/removeloyaltypointsresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.BadRequest   | 400                 | application/json    |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |

package/docs/sdks/catalog/README.md

@@ -85,13 +85,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.ListProductsResponse](../../models/operations/listproductsresponse.md)\>**
+**Promise\<[operations.ListProductsResponseBody](../../models/operations/listproductsresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## listSkus
 
@@ -161,13 +163,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.ListSkusResponse](../../models/operations/listskusresponse.md)\>**
+**Promise\<[operations.ListSkusResponseBody](../../models/operations/listskusresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## getProductDetail
 
@@ -237,13 +241,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.GetProductDetailResponse](../../models/operations/getproductdetailresponse.md)\>**
+**Promise\<[operations.GetProductDetailResponseBody](../../models/operations/getproductdetailresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## listProductVariants
 
@@ -313,13 +319,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.ListProductVariantsResponse](../../models/operations/listproductvariantsresponse.md)\>**
+**Promise\<[operations.ListProductVariantsResponseBody](../../models/operations/listproductvariantsresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## getVariantDetail
 
@@ -391,13 +399,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.GetVariantDetailResponse](../../models/operations/getvariantdetailresponse.md)\>**
+**Promise\<[operations.GetVariantDetailResponseBody](../../models/operations/getvariantdetailresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## listCategories
 
@@ -547,13 +557,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.ListProductReviewsResponse](../../models/operations/listproductreviewsresponse.md)\>**
+**Promise\<[operations.ListProductReviewsResponseBody](../../models/operations/listproductreviewsresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## listSimilarProducts
 
@@ -619,13 +631,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.ListSimilarProductsResponse](../../models/operations/listsimilarproductsresponse.md)\>**
+**Promise\<[operations.ListSimilarProductsResponseBody](../../models/operations/listsimilarproductsresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## listUpsellProducts
 
@@ -691,13 +705,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.ListUpsellProductsResponse](../../models/operations/listupsellproductsresponse.md)\>**
+**Promise\<[operations.ListUpsellProductsResponseBody](../../models/operations/listupsellproductsresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## listCrosssellProducts
 
@@ -763,13 +779,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.ListCrosssellProductsResponse](../../models/operations/listcrosssellproductsresponse.md)\>**
+**Promise\<[operations.ListCrosssellProductsResponseBody](../../models/operations/listcrosssellproductsresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## searchProducts
 
@@ -839,10 +857,11 @@ run();
 
 ### Response
 
-**Promise\<[operations.SearchProductsResponse](../../models/operations/searchproductsresponse.md)\>**
+**Promise\<[operations.SearchProductsResponseBody](../../models/operations/searchproductsresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |

package/docs/sdks/customers/README.md

@@ -187,13 +187,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.CreateAddressResponse](../../models/operations/createaddressresponse.md)\>**
+**Promise\<[operations.CreateAddressResponseBody](../../models/operations/createaddressresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.BadRequest   | 400                 | application/json    |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## getAddressDetail
 
@@ -265,13 +267,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.GetAddressDetailResponse](../../models/operations/getaddressdetailresponse.md)\>**
+**Promise\<[operations.GetAddressDetailResponseBody](../../models/operations/getaddressdetailresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## updateAddressDetail
 
@@ -373,13 +377,16 @@ run();
 
 ### Response
 
-**Promise\<[operations.UpdateAddressDetailResponse](../../models/operations/updateaddressdetailresponse.md)\>**
+**Promise\<[operations.UpdateAddressDetailResponseBody](../../models/operations/updateaddressdetailresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.BadRequest   | 400                 | application/json    |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## deleteAddress
 
@@ -451,13 +458,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.DeleteAddressResponse](../../models/operations/deleteaddressresponse.md)\>**
+**Promise\<[operations.DeleteAddressResponseBody](../../models/operations/deleteaddressresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## getLoyaltyDetails
 
@@ -527,13 +536,15 @@ run();
 
 ### Response
 
-**Promise\<[operations.GetLoyaltyDetailsResponse](../../models/operations/getloyaltydetailsresponse.md)\>**
+**Promise\<[operations.GetLoyaltyDetailsResponseBody](../../models/operations/getloyaltydetailsresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## listUserReviews