@gofynd/fdk-client-javascript 1.4.15-beta.6 → 1.4.16-beta.1

package/sdk/application/Cart/CartApplicationClient.js

@@ -15,6 +15,7 @@ class Cart {
       addItems: "/service/application/cart/v1.0/detail",
       applyCoupon: "/service/application/cart/v1.0/coupon",
       applyRewardPoints: "/service/application/cart/v1.0/redeem/points/",
+      checkoutCart: "/service/application/cart/v1.0/checkout",
       checkoutCartV2: "/service/application/cart/v2.0/checkout",
       deleteCart: "/service/application/cart/v1.0/cart_archive",
       getAddressById: "/service/application/cart/v1.0/address/{id}",
@@ -30,6 +31,7 @@ class Cart {
       getPromotionOffers: "/service/application/cart/v1.0/available-promotions",
       getPromotionPaymentOffers:
         "/service/application/cart/v1.0/available-payment-offers",
+      getPromotions: "/service/application/cart/v1.0/promotion",
       getShipments: "/service/application/cart/v1.0/shipment",
       removeAddress: "/service/application/cart/v1.0/address/{id}",
       removeCoupon: "/service/application/cart/v1.0/coupon",
@@ -62,7 +64,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<SaveAddressResponse>} - Success response
+   * @returns {Promise<SaveAddressResult>} - Success response
    * @name addAddress
    * @summary: Creates a new address for a customer
    * @description: Add a new address to their cart to save details such as name, email, contact information, and address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/addAddress/).
@@ -107,7 +109,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<AddCartDetailResponse>} - Success response
+   * @returns {Promise<AddCartDetailResult>} - Success response
    * @name addItems
    * @summary: Add items to a cart
    * @description: Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/addItems/).
@@ -160,7 +162,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CartDetailResponse>} - Success response
+   * @returns {Promise<CartDetailResult>} - Success response
    * @name applyCoupon
    * @summary: Apply coupon
    * @description: Apply a coupon code to the cart to trigger discounts on eligible items. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/applyCoupon/).
@@ -213,7 +215,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CartDetailResponse>} - Success response
+   * @returns {Promise<CartDetailResult>} - Success response
    * @name applyRewardPoints
    * @summary: Use reward points
    * @description: Users can redeem their accumulated reward points and apply them to the items in their cart, thereby availing discounts on their current purchases. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/applyRewardPoints/).
@@ -262,7 +264,54 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CartCheckoutResponse>} - Success response
+   * @returns {Promise<CartCheckoutResult>} - Success response
+   * @name checkoutCart
+   * @summary: Checkout cart
+   * @description: The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/checkoutCart/).
+   */
+  async checkoutCart(
+    { body, buyNow, cartType, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    let invalidInput = [];
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["buy_now"] = buyNow;
+    query_params["cart_type"] = cartType;
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["checkoutCart"],
+        params: {},
+      }),
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<CartCheckoutResult>} - Success response
    * @name checkoutCartV2
    * @summary: Checkout cart
    * @description: The checkout cart initiates the order creation process based on the items in the user’s cart,  their selected address, and chosen payment methods. It also supports multiple payment method  options and revalidates the cart details to ensure a secure and seamless order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/checkoutCartV2/).
@@ -309,7 +358,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<DeleteCartDetailResponse>} - Success response
+   * @returns {Promise<DeleteCartDetailResult>} - Success response
    * @name deleteCart
    * @summary: Delete a cart
    * @description: Delete all items from the user's cart and resets it to its initial state, providing a clean slate for new selections. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/deleteCart/).
@@ -422,7 +471,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<GetAddressesResponse>} - Success response
+   * @returns {Promise<GetAddressesResult>} - Success response
    * @name getAddresses
    * @summary: Get a list of addresses for a customer
    * @description: List all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getAddresses/).
@@ -481,7 +530,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<BulkPriceResponse>} - Success response
+   * @returns {Promise<BulkPriceResult>} - Success response
    * @name getBulkDiscountOffers
    * @summary: List bulk discounts
    * @description: List offer discounts with information about quantity and seller. One offer is marked with a "best" flag, indicating it as the best offer among the list. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getBulkDiscountOffers/).
@@ -530,7 +579,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CartDetailResponse>} - Success response
+   * @returns {Promise<CartDetailResult>} - Success response
    * @name getCart
    * @summary: Get a cart
    * @description: Get details of a cart linked to a specific customer using a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getCart/).
@@ -639,7 +688,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<GetShareCartLinkResponse>} - Success response
+   * @returns {Promise<GetShareCartLinkResult>} - Success response
    * @name getCartShareLink
    * @summary: Create share cart link
    * @description: Generate a unique shareable link for the customer's cart for a specific sales channel. This link enables easy sharing of the cart contents with other users, facilitating collaborative shopping experiences. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getCartShareLink/).
@@ -684,7 +733,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<SharedCartResponse>} - Success response
+   * @returns {Promise<SharedCartResult>} - Success response
    * @name getCartSharedItems
    * @summary: List shared cart items
    * @description: Get cart items from the shared cart link based on unique token. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getCartSharedItems/).
@@ -736,7 +785,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<GetCouponResponse>} - Success response
+   * @returns {Promise<GetCouponResult>} - Success response
    * @name getCoupons
    * @summary: List available coupons
    * @description: List all available coupons that customer can apply to their carts. It provides details about each coupon, including its code, discount amount, and applicable conditions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getCoupons/).
@@ -785,7 +834,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CartItemCountResponse>} - Success response
+   * @returns {Promise<CartItemCountResult>} - Success response
    * @name getItemCount
    * @summary: Get a cart items count
    * @description: Get total count of items currently present in the customer's cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getItemCount/).
@@ -890,15 +939,21 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<PromotionOffersResponse>} - Success response
+   * @returns {Promise<PromotionOffersResult>} - Success response
    * @name getPromotionOffers
    * @summary: List available promotion offers
    * @description: List all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getPromotionOffers/).
    */
   async getPromotionOffers(
-    { slug, pageSize, promotionGroup, storeId, cartType, requestHeaders } = {
-      requestHeaders: {},
-    },
+    {
+      slug,
+      pageSize,
+      promotionGroup,
+      storeId,
+      cartType,
+      sortBy,
+      requestHeaders,
+    } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     let invalidInput = [];
@@ -915,6 +970,7 @@ class Cart {
     query_params["promotion_group"] = promotionGroup;
     query_params["store_id"] = storeId;
     query_params["cart_type"] = cartType;
+    query_params["sort_by"] = sortBy;
 
     const xHeaders = {};
 
@@ -942,7 +998,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<PromotionPaymentOffersResponse>} - Success response
+   * @returns {Promise<PromotionPaymentOffersResult>} - Success response
    * @name getPromotionPaymentOffers
    * @summary: Fetch available promotions payment offers
    * @description: Use this API to get top 5 payment offers available for current product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getPromotionPaymentOffers/).
@@ -989,7 +1045,54 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CartShipmentsResponse>} - Success response
+   * @returns {Promise<Promotions>} - Success response
+   * @name getPromotions
+   * @summary: List all available promotions of the sales channel
+   * @description: List all promotional offers available for the sales channel, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getPromotions/).
+   */
+  async getPromotions(
+    { pageSize, pageNo, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    let invalidInput = [];
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_size"] = pageSize;
+    query_params["page_no"] = pageNo;
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getPromotions"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<CartShipmentsResult>} - Success response
    * @name getShipments
    * @summary: List shipments
    * @description: Get shipment details for the items in a cart, specific to the selected address. Shipment details include delivery promises, seller information, item details, and other relevant information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getShipments/).
@@ -1042,7 +1145,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<DeleteAddressResponse>} - Success response
+   * @returns {Promise<DeleteAddressResult>} - Success response
    * @name removeAddress
    * @summary: Removes an address from a customer's address list
    * @description: Delete an existing customer address from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/removeAddress/).
@@ -1094,7 +1197,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CartDetailResponse>} - Success response
+   * @returns {Promise<CartDetailResult>} - Success response
    * @name removeCoupon
    * @summary: Remove coupon
    * @description: Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/removeCoupon/).
@@ -1141,7 +1244,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CartDetailResponse>} - Success response
+   * @returns {Promise<CartDetailResult>} - Success response
    * @name selectAddress
    * @summary: Select customer address for order processing
    * @description: Select an address from the saved customer addresses and validates the availability of items in the cart. Additionally, it verifies and updates the delivery promise based on the selected address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/selectAddress/).
@@ -1190,7 +1293,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CartDetailResponse>} - Success response
+   * @returns {Promise<CartDetailResult>} - Success response
    * @name selectPaymentMode
    * @summary: Select payment mode
    * @description: Select a preferred payment mode from available options during the cart checkout process to securely and efficiently complete their transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/selectPaymentMode/).
@@ -1237,7 +1340,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<UpdateAddressResponse>} - Success response
+   * @returns {Promise<UpdateAddressResult>} - Success response
    * @name updateAddress
    * @summary: Updates an existing customer address
    * @description: Customer can modify the details of a previously saved addresses. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/updateAddress/).
@@ -1289,7 +1392,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<UpdateCartDetailResponse>} - Success response
+   * @returns {Promise<UpdateCartDetailResult>} - Success response
    * @name updateCart
    * @summary: Update cart items
    * @description: Update cart. Customers can modify added product attributes such as quantity and size, as well as remove items from the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/updateCart/).
@@ -1351,7 +1454,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CartMetaResponse>} - Success response
+   * @returns {Promise<CartMetaResult>} - Success response
    * @name updateCartMeta
    * @summary: Update cart metadata
    * @description: Update metadata associated with a cart, which includes customer preferences, delivery instructions, or any special requirements related to the cart items. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/updateCartMeta/).
@@ -1398,7 +1501,7 @@ class Cart {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<SharedCartResponse>} - Success response
+   * @returns {Promise<SharedCartResult>} - Success response
    * @name updateCartWithSharedItems
    * @summary: Update with shared items
    * @description: Merge or replace shared cart items with existing cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/updateCartWithSharedItems/).