ce-storefront 0.15.3 → 0.15.6

package/README.md

@@ -170,6 +170,14 @@ run();
 * [cancelOrder](docs/sdks/orders/README.md#cancelorder) - Cancel order
 * [retryOrderPayment](docs/sdks/orders/README.md#retryorderpayment) - Retry payment
 
+### [pos](docs/sdks/pos/README.md)
+
+* [pairPosDevice](docs/sdks/pos/README.md#pairposdevice) - Pair POS device
+* [loginToPosDevice](docs/sdks/pos/README.md#logintoposdevice) - Login to POS device
+* [refreshPosAccessToken](docs/sdks/pos/README.md#refreshposaccesstoken) - Refresh POS access token
+* [createPosCart](docs/sdks/pos/README.md#createposcart) - Create cart
+* [updatePosCart](docs/sdks/pos/README.md#updateposcart) - Add/update/delete cart item
+
 ### [shipping](docs/sdks/shipping/README.md)
 
 * [shippingMethods](docs/sdks/shipping/README.md#shippingmethods) - List available shipping methods
@@ -240,6 +248,11 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`ordersListOrders`](docs/sdks/orders/README.md#listorders) - Retrieve all orders
 - [`ordersListOrderShipments`](docs/sdks/orders/README.md#listordershipments) - Retrieve order shipments
 - [`ordersRetryOrderPayment`](docs/sdks/orders/README.md#retryorderpayment) - Retry payment
+- [`posCreatePosCart`](docs/sdks/pos/README.md#createposcart) - Create cart
+- [`posLoginToPosDevice`](docs/sdks/pos/README.md#logintoposdevice) - Login to POS device
+- [`posPairPosDevice`](docs/sdks/pos/README.md#pairposdevice) - Pair POS device
+- [`posRefreshPosAccessToken`](docs/sdks/pos/README.md#refreshposaccesstoken) - Refresh POS access token
+- [`posUpdatePosCart`](docs/sdks/pos/README.md#updateposcart) - Add/update/delete cart item
 - [`shippingShippingMethods`](docs/sdks/shipping/README.md#shippingmethods) - List available shipping methods
 
 </details>
@@ -382,8 +395,8 @@ run();
 
 
 **Inherit from [`CeStorefrontError`](./src/models/errors/cestorefronterror.ts)**:
-* [`NotFound`](./src/models/errors/notfound.ts): Requested resource not found. Status code `404`. Applicable to 39 of 49 methods.*
-* [`BadRequest`](./src/models/errors/badrequest.ts): Bad request. Status code `400`. Applicable to 28 of 49 methods.*
+* [`NotFound`](./src/models/errors/notfound.ts): Requested resource not found. Status code `404`. Applicable to 39 of 54 methods.*
+* [`BadRequest`](./src/models/errors/badrequest.ts): Bad request. Status code `400`. Applicable to 28 of 54 methods.*
 * [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
 
 </details>

package/docs/sdks/auth/README.md

@@ -23,6 +23,7 @@ To interact with the system, each anonymous user is issued an access token. This
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="get-anonymous-token" method="post" path="/auth/anonymous" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -93,6 +94,7 @@ This API enables users to authenticate into the system using their phone number.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="login-with-phone" method="post" path="/auth/login/phone" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -168,6 +170,7 @@ This API enables users to authenticate into the system using their email address
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="login-with-email" method="post" path="/auth/login/email" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -243,6 +246,7 @@ This API enables users to authenticate into the system using their WhatsApp Numb
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="login-with-whatsapp" method="post" path="/auth/login/whatsapp" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -317,6 +321,7 @@ This API endpoint allows you to verify a one-time password (OTP) for authenticat
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="verify-otp" method="post" path="/auth/verify-otp" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -396,6 +401,7 @@ The Retrieve User API is designed to facilitate the retrieval of comprehensive u
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="get-user-detail" method="get" path="/auth/user/{id}" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -471,6 +477,7 @@ The Update User API helps to efficiently modify and enhance user information wit
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="update-user" method="put" path="/auth/user/{id}" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -601,6 +608,7 @@ The Refresh Access Token API is an integral component designed to enhance securi
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="refresh-token" method="post" path="/auth/refresh-token" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -675,6 +683,7 @@ Generating a One-Time Password (OTP) typically involves creating a random code t
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="generate-otp" method="post" path="/auth/generate-otp" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -753,6 +762,7 @@ The Logout User API initiate the logout process for a user. Upon a successful re
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="logout" method="post" path="/auth/logout" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 

package/docs/sdks/carts/README.md

@@ -24,6 +24,7 @@ Create cart
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="create-cart" method="post" path="/carts" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -131,6 +132,7 @@ Retrieve cart detail
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="get-cart" method="get" path="/carts/{id}" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -205,6 +207,7 @@ delete all items from the cart.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="delete-cart" method="delete" path="/carts/{id}" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -279,6 +282,7 @@ Retrieve cart detail using user id
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="get-user-cart" method="get" path="/carts/users/{user_id}" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -353,6 +357,7 @@ delete all items from the cart using user id.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="delete-user-cart" method="delete" path="/carts/users/{user_id}" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -427,6 +432,7 @@ Add Item to cart. To delete item from cart, pass quantity = 0
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="update-cart" method="post" path="/carts/{id}/items" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -512,6 +518,7 @@ Update billing and shipping address
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="create-cart-address" method="post" path="/carts/{id}/address" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -595,6 +602,7 @@ Update preferred shipping method and courier.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="update-shipping-method" method="post" path="/carts/{id}/shipping-method" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -678,6 +686,7 @@ Apply coupon
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="apply-coupon" method="post" path="/carts/{id}/coupon" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -759,6 +768,7 @@ remove coupon from cart
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="remove-coupon" method="delete" path="/carts/{id}/coupon" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -833,6 +843,7 @@ Redeem loyalty points
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="redeem-loyalty-points" method="post" path="/carts/{id}/loyalty-points" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -913,6 +924,7 @@ Remove loyalty points applied in cart
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="remove-loyalty-points" method="delete" path="/carts/{id}/loyalty-points" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 

package/docs/sdks/catalog/README.md

@@ -23,6 +23,7 @@ Returns a list of your products. The products are returned sorted by creation da
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="list-products" method="get" path="/catalog/products" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -97,6 +98,7 @@ Returns a list of SKUs. The SKUs are returned sorted by creation date, with the
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="list-skus" method="get" path="/catalog/skus" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -171,6 +173,7 @@ Retrieves the details of an existing product. Supply either the unique product I
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="get-product-detail" method="get" path="/catalog/products/{product_id_or_slug}" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -245,6 +248,7 @@ Retrieves the variants of an existing product. Supply the unique product ID, and
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="list-product-variants" method="get" path="/catalog/products/{product_id}/variants" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -319,6 +323,7 @@ Retrieves the details of a particular variant. Supply the unique product ID, and
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="get-variant-detail" method="get" path="/catalog/products/{product_id}/variants/{variant_id}" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -395,6 +400,7 @@ Returns a list of your product categories. The categories are returned sorted by
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="list-categories" method="get" path="/catalog/categories" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -474,6 +480,7 @@ List of reviews for a specified product. The reviews are returned sorted by subm
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="list-product-reviews" method="get" path="/catalog/products/{product_id}/reviews" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -550,6 +557,7 @@ Retrieves a list of products similar to a specified product based on their attri
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="list-similar-products" method="get" path="/catalog/products/similar" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -620,6 +628,7 @@ Retrieves a list of products specified for upsell. The upsell products are retur
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="list-upsell-products" method="get" path="/catalog/products/up-sell" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -690,6 +699,7 @@ Retrieves a list of products specified for cross selling. The cross-sell product
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="list-crosssell-products" method="get" path="/catalog/products/cross-sell" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -760,6 +770,7 @@ Search for products matching a specific words or characters given.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="search-products" method="post" path="/catalog/products/search" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 

package/docs/sdks/common/README.md

@@ -13,6 +13,7 @@ Retrieve pincodes
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="list-country-pincodes" method="get" path="/common/countries/{country_iso_code}/pincodes" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 

package/docs/sdks/customers/README.md

@@ -19,6 +19,7 @@ Retrieve billing and shipping address of particular customer
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="list-addresses" method="get" path="/customers/{user_id}/addresses" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -94,6 +95,7 @@ Add new address
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="create-address" method="post" path="/customers/{user_id}/addresses" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -198,6 +200,7 @@ Retrieve address
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="get-address-detail" method="get" path="/customers/{user_id}/addresses/{address_id}" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -274,6 +277,7 @@ Update address
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="update-address-detail" method="put" path="/customers/{user_id}/addresses/{address_id}" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -381,6 +385,7 @@ Delete address
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="delete-address" method="delete" path="/customers/{user_id}/addresses/{address_id}" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -457,6 +462,7 @@ Retrieve loyalty details
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="get-loyalty-details" method="get" path="/customers/{user_id}/loyalty" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -531,6 +537,7 @@ Retrieve all reviews
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="list-user-reviews" method="get" path="/customers/{user_id}/reviews" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 

package/docs/sdks/orders/README.md

@@ -19,6 +19,7 @@ Create new order
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="create-order" method="post" path="/orders" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -110,6 +111,7 @@ list customers all orders
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="list-orders" method="get" path="/orders" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -184,6 +186,7 @@ view particular order details
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="get-order-detail" method="get" path="/orders/{order_number}" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -258,6 +261,7 @@ Retrieve payment status of a paricular order.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="get-payment-status" method="get" path="/orders/{order_number}/payment-status" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -333,6 +337,7 @@ Retrieve order shipments
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="list-order-shipments" method="get" path="/orders/{order_number}/shipments" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -407,6 +412,7 @@ Order cancellation
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="cancel-order" method="post" path="/orders/{order_number}/cancel" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
@@ -489,6 +495,7 @@ To generate new payment request if first payment request is failed or expired. R
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="retry-order-payment" method="post" path="/orders/{order_number}/retry-payment" -->
 ```typescript
 import { CeStorefront } from "ce-storefront";