@gofynd/fdk-client-javascript 3.3.5 → 3.4.0

package/sdk/platform/Cart/CartPlatformModel.js

@@ -207,7 +207,7 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @property {string} [next_id] - The identifier for the next page.
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
  * @property {boolean} [has_next] - Indicates whether there is a next page.
@@ -1035,6 +1035,43 @@ const Joi = require("joi");
  *   often used for internal reference
  */
 
+/**
+ * @typedef FulfillmentOptionSchema
+ * @property {string} [slug] - Unique identifier for the delivery type.
+ * @property {string} [description] - Description of the delivery service.
+ * @property {boolean} [is_default] - Indicates if this is the default delivery option.
+ * @property {string} [id] - Unique ID of the delivery service.
+ * @property {string} [type] - Type of fulfillment option.
+ * @property {string} [name] - Name of the delivery service.
+ */
+
+/**
+ * @typedef StoreTimingSchema
+ * @property {number} [hour] - The hour of the store in 24-hour format (e.g., 9 for 9 AM).
+ * @property {number} [minute] - The minute of the store (e.g., 30 for 9:30 AM).
+ */
+
+/**
+ * @typedef StoreHoursSchema
+ * @property {string} [weekday] - The day of the week (e.g., "Monday", "Tuesday").
+ * @property {StoreTimingSchema} [opening]
+ * @property {StoreTimingSchema} [closing]
+ * @property {boolean} [open] - Indicates whether the store is open on the
+ *   specified weekday.
+ */
+
+/**
+ * @typedef PickupStoreDetailSchema
+ * @property {number} [store_id] - A unique identifier for the store.
+ * @property {string} [name] - The name of the store or pickup location.
+ * @property {string} [pincode] - The postal code of the store's location.
+ * @property {number} [distance] - The distance between the store and the
+ *   customer's location.
+ * @property {string} [address] - The full address of the store.
+ * @property {Object} [store_hours] - The store's operational hours for each day
+ *   of the week.
+ */
+
 /**
  * @typedef ProductArticle
  * @property {string} [seller_identifier] - List of identifiers used by sellers
@@ -1066,6 +1103,9 @@ const Joi = require("joi");
  * @property {Object} [meta] - Meta data of article in cart
  * @property {string} [size] - Size of the article added in cart
  * @property {StoreInfo} [store]
+ * @property {FulfillmentOptionSchema} [fulfillment_option]
+ * @property {PickupStoreDetailSchema} [pickup_store_detail]
+ * @property {number} [item_index] - Specify the index of article in cart.
  * @property {string[]} [tags] - A list of article tags
  */
 
@@ -1510,6 +1550,17 @@ const Joi = require("joi");
  * @property {DeliveryChargesConfig} [delivery_charges_config]
  */
 
+/**
+ * @typedef PlatformAlternatePickupPerson
+ * @property {boolean} [enabled] - Indicates whether an alternate pickup person
+ *   is enabled.
+ * @property {string} [name] - Name of the alternate pickup person.
+ * @property {string} [email] - Email address of the alternate pickup person.
+ * @property {string} [phone] - Phone number of the alternate pickup person.
+ * @property {string} [country_phone_code] - Country phone code of the alternate
+ *   pickup person (e.g., "+91").
+ */
+
 /**
  * @typedef CartDetailResult
  * @property {number} [cart_id] - Unique identifier of the user cart
@@ -1551,6 +1602,7 @@ const Joi = require("joi");
  * @property {string} [pan_no] - Permanent Account Number of the user
  * @property {Object} [custom_cart_meta] - Custom meta details added cart
  *   checkout API payload
+ * @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
  * @property {boolean} [free_gift_selection_available] - Determines if the cart
  *   has available promotion free gift items to choose on its added items
  */
@@ -1583,6 +1635,10 @@ const Joi = require("joi");
  * @property {boolean} [pos] - Filed to determine whether user is making request
  *   from pos or not
  * @property {string} [seller_identifier] - Add items using seller identifier for store os
+ * @property {string} [fulfillment_option_slug] - Specifies the fulfillment
+ *   method, indicating whether an order is for home delivery or store pickup
+ * @property {number} [pickup_store_id] - Unique identifier of the pickup store
+ *   selected by the user from which user wants to pickup the product.
  */
 
 /**
@@ -1633,6 +1689,10 @@ const Joi = require("joi");
  *   product falls to be updated
  * @property {CartProductIdentifer} identifiers
  * @property {string} [article_id] - Article id of the product in cart
+ * @property {string} [fulfillment_option_slug] - Specifies the fulfillment
+ *   method, indicating whether an order is for home delivery or store pickup
+ * @property {number} [pickup_store_id] - Unique identifier of the pickup store
+ *   selected by the user from which user
  */
 
 /**
@@ -1895,10 +1955,17 @@ const Joi = require("joi");
  * @property {number} [user_cart_items_count] - Item count present in cart
  */
 
+/**
+ * @typedef DiscountRules
+ * @property {number} [discounted_price] - Discount will be reflected in the
+ *   cart upon adding the product.
+ */
+
 /**
  * @typedef Coupon
  * @property {string} [title] - Coupon Title of the coupon applied denotes name
  *   of the coupon
+ * @property {DiscountRules[]} [rule] - Discount rules of coupons
  * @property {number} [max_discount_value] - Maximum discount value of the
  *   coupon applied to cart
  * @property {string} [coupon_code] - Coupon code of the coupon applied on cart
@@ -2061,6 +2128,7 @@ const Joi = require("joi");
  * @property {string} [dp_id] - Delivery partner id of the shipment
  * @property {string} [fulfillment_type] - Fulfilment type of shipment
  * @property {ShipmentArticle[]} [articles] - List of articles in shipment
+ * @property {FulfillmentOptionSchema} [fulfillment_option]
  */
 
 /**
@@ -2105,6 +2173,8 @@ const Joi = require("joi");
  * @property {number} [quantity] - Quantity of product in shipment
  * @property {string} shipment_type - Shipment delivery type
  * @property {string} article_uid - Article unique id for shipment
+ * @property {number} [item_index] - Item index determines the position in the
+ *   list where the product should be updated.
  */
 
 /**
@@ -2119,6 +2189,7 @@ const Joi = require("joi");
  * @property {string} [gstin] - GSTIN number to be added in user cart
  * @property {Object} [pick_up_customer_details] - Customer contact details for
  *   customer pickup at store
+ * @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
  * @property {string} [checkout_mode] - Checkout mode of user cart
  * @property {Object} [gift_details] - Gift details is open json which can
  *   include gift message
@@ -2363,6 +2434,8 @@ const Joi = require("joi");
  *   mode selected to do the payment
  * @property {string} [merchant_code] - Merchant code of the payment mode
  *   selected to do the payment
+ * @property {string[]} [payment_source_bag_id] - Previous bag IDs for which an
+ *   exchange has been performed.
  */
 
 /**
@@ -3636,6 +3709,48 @@ class CartPlatformModel {
     });
   }
 
+  /** @returns {FulfillmentOptionSchema} */
+  static FulfillmentOptionSchema() {
+    return Joi.object({
+      slug: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      is_default: Joi.boolean(),
+      id: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {StoreTimingSchema} */
+  static StoreTimingSchema() {
+    return Joi.object({
+      hour: Joi.number(),
+      minute: Joi.number(),
+    });
+  }
+
+  /** @returns {StoreHoursSchema} */
+  static StoreHoursSchema() {
+    return Joi.object({
+      weekday: Joi.string().allow(""),
+      opening: CartPlatformModel.StoreTimingSchema(),
+      closing: CartPlatformModel.StoreTimingSchema(),
+      open: Joi.boolean(),
+    });
+  }
+
+  /** @returns {PickupStoreDetailSchema} */
+  static PickupStoreDetailSchema() {
+    return Joi.object({
+      store_id: Joi.number(),
+      name: Joi.string().allow(""),
+      pincode: Joi.string().allow(""),
+      distance: Joi.number(),
+      address: Joi.string().allow(""),
+      store_hours: Joi.any(),
+    });
+  }
+
   /** @returns {ProductArticle} */
   static ProductArticle() {
     return Joi.object({
@@ -3658,6 +3773,9 @@ class CartPlatformModel {
       meta: Joi.object().pattern(/\S/, Joi.any()),
       size: Joi.string().allow(""),
       store: CartPlatformModel.StoreInfo(),
+      fulfillment_option: CartPlatformModel.FulfillmentOptionSchema(),
+      pickup_store_detail: CartPlatformModel.PickupStoreDetailSchema(),
+      item_index: Joi.number(),
       tags: Joi.array().items(Joi.string().allow("")),
     });
   }
@@ -4138,6 +4256,17 @@ class CartPlatformModel {
     });
   }
 
+  /** @returns {PlatformAlternatePickupPerson} */
+  static PlatformAlternatePickupPerson() {
+    return Joi.object({
+      enabled: Joi.boolean(),
+      name: Joi.string().allow(""),
+      email: Joi.string().allow(""),
+      phone: Joi.string().allow(""),
+      country_phone_code: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {CartDetailResult} */
   static CartDetailResult() {
     return Joi.object({
@@ -4170,6 +4299,7 @@ class CartPlatformModel {
       ),
       pan_no: Joi.string().allow(""),
       custom_cart_meta: Joi.object().pattern(/\S/, Joi.any()),
+      alternate_pickup_person: CartPlatformModel.PlatformAlternatePickupPerson(),
       free_gift_selection_available: Joi.boolean(),
     });
   }
@@ -4195,6 +4325,8 @@ class CartPlatformModel {
       meta: Joi.object().pattern(/\S/, Joi.any()),
       pos: Joi.boolean(),
       seller_identifier: Joi.string().allow(""),
+      fulfillment_option_slug: Joi.string().allow(""),
+      pickup_store_id: Joi.number(),
     });
   }
 
@@ -4243,6 +4375,8 @@ class CartPlatformModel {
       item_index: Joi.number(),
       identifiers: CartPlatformModel.CartProductIdentifer().required(),
       article_id: Joi.string().allow(""),
+      fulfillment_option_slug: Joi.string().allow(""),
+      pickup_store_id: Joi.number(),
     });
   }
 
@@ -4513,10 +4647,18 @@ class CartPlatformModel {
     });
   }
 
+  /** @returns {DiscountRules} */
+  static DiscountRules() {
+    return Joi.object({
+      discounted_price: Joi.number(),
+    });
+  }
+
   /** @returns {Coupon} */
   static Coupon() {
     return Joi.object({
       title: Joi.string().allow(""),
+      rule: Joi.array().items(CartPlatformModel.DiscountRules()),
       max_discount_value: Joi.number(),
       coupon_code: Joi.string().allow(""),
       is_applied: Joi.boolean(),
@@ -4681,6 +4823,7 @@ class CartPlatformModel {
       dp_id: Joi.string().allow("").allow(null),
       fulfillment_type: Joi.string().allow(""),
       articles: Joi.array().items(CartPlatformModel.ShipmentArticle()),
+      fulfillment_option: CartPlatformModel.FulfillmentOptionSchema(),
     });
   }
 
@@ -4722,6 +4865,7 @@ class CartPlatformModel {
       quantity: Joi.number(),
       shipment_type: Joi.string().allow("").required(),
       article_uid: Joi.string().allow("").required(),
+      item_index: Joi.number(),
     });
   }
 
@@ -4739,6 +4883,7 @@ class CartPlatformModel {
     return Joi.object({
       gstin: Joi.string().allow(""),
       pick_up_customer_details: Joi.object().pattern(/\S/, Joi.any()),
+      alternate_pickup_person: CartPlatformModel.PlatformAlternatePickupPerson(),
       checkout_mode: Joi.string().allow(""),
       gift_details: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
       pan_no: Joi.string().allow(""),
@@ -4991,6 +5136,7 @@ class CartPlatformModel {
       type: Joi.string().allow(""),
       payment_identifier: Joi.string().allow("").allow(null),
       merchant_code: Joi.string().allow(""),
+      payment_source_bag_id: Joi.array().items(Joi.string().allow("")),
     });
   }