@gofynd/fdk-client-javascript 3.4.0 → 3.4.1

package/sdk/platform/Order/OrderPlatformModel.js

@@ -296,6 +296,43 @@ const Joi = require("joi");
  *   modifications applied to the order.
  */
 
+/**
+ * @typedef SellerQCDetailsSchema
+ * @property {number} line_number - Line_number of the product/bag.
+ * @property {number} good_quantity - The number of units marked as good during
+ *   the seller QC process for the given line_number/bag item.
+ * @property {number} bad_quantity - The number of units marked as bad during
+ *   the seller QC process for the given line_number/bag item.
+ */
+
+/**
+ * @typedef EntityStatusDataSchema
+ * @property {SellerQCDetailsSchema[]} [seller_qc_details] - An array of QC
+ *   results provided by the seller to indicate the condition of returned items
+ *   (e.g., good vs. bad quantity) for each line item. Pass this field such that
+ *   if inventory-related data is included, it will be updated accordingly
+ *   during the transition.
+ */
+
+/**
+ * @typedef DataUpdatesFiltersSchema
+ * @property {number} [line_number] - Line number of the product/bag.
+ * @property {number} [quantity] - Quantity of the line number item.
+ * @property {string} [identifier] - Seller identifier of the product/bag.
+ */
+
+/**
+ * @typedef EntityStatusDataUpdates
+ * @property {DataUpdatesFiltersSchema[]} [filters] - A list of filters used to
+ *   specify the target for this update. For shipment level or shipment-status
+ *   level updates, this should be an empty array ([]) as no filters are
+ *   required during shipment/shipment_status transitions. But is still
+ *   mandatory due to schema requirements. For product-level updates,
+ *   appropriate filters must be provided as per the schema to accurately target
+ *   specific items.
+ * @property {EntityStatusDataSchema} [data]
+ */
+
 /**
  * @typedef DataUpdates
  * @property {OrderItemDataUpdates[]} [order_item_status] - A list of updates
@@ -305,6 +342,10 @@ const Joi = require("joi");
  * @property {EntitiesDataUpdates[]} [entities] - A list of updates related to
  *   the properties of any relevant entities.
  * @property {OrderDataUpdates[]} [order]
+ * @property {EntityStatusDataUpdates[]} [entity_status] - A list of updates to
+ *   entity_status properties associated with specific shipment status
+ *   transitions (e.g., bag_confirmed, return_accepted). These updates are
+ *   optional. Update e.g., inventory-affecting data (like QC data) to be updated.
  */
 
 /**
@@ -920,7 +961,7 @@ const Joi = require("joi");
  *   your order was placed. This field will be phased out after version 2.4.0.
  *   Please use ordering_source instead to ensure accurate order tracking and processing.
  * @property {string} [ordering_source] - To uniquely identify the source
- *   through which order has been placed.
+ *   through which order has been placed (e.g, marketplace, gofynd).
  * @property {Object} [meta] - Meta data of the order data contains additional,
  *   potentially dynamic information about the order data.
  * @property {number} [cod_charges]
@@ -2550,7 +2591,7 @@ const Joi = require("joi");
  *   your order was placed. This field will be phased out after version 2.4.0.
  *   Please use ordering_source instead to ensure accurate order tracking and processing.
  * @property {string} [ordering_source] - To uniquely identify the source
- *   through which order has been placed.
+ *   through which order has been placed (e.g, marketplace, gofynd).
  * @property {string} entity - The type of entity that the configuration pertains to.
  */
 
@@ -2945,7 +2986,7 @@ const Joi = require("joi");
  *   for the address.
  * @property {string} [country_phone_code] - The country-specific phone code for
  *   formatting phone numbers.
- * @property {string} [delivery_address_id] - A unique identifier for the
+ * @property {number} [delivery_address_id] - A unique identifier for the
  *   delivery address.
  * @property {Object} [geo_location] - An object containing additional
  *   geographical information related to the address.
@@ -3628,13 +3669,13 @@ const Joi = require("joi");
  * @property {string} [order_date] - Denotes the date and time when an order was
  *   placed by the customer. This timestamp is crucial for tracking the order'
  * @property {string} [order_created_ts] - The timestamp indicating when the
- *   order was created.
+ *   order was created in UTC format.
  * @property {ShipmentStatus} [shipment_status]
  * @property {UserDataInfo} [user]
  * @property {string} [estimated_sla_time] - The estimated Service Level
  *   Agreement (SLA) time for the shipment.
  * @property {string} [estimated_sla_ts] - The timestamp for the estimated SLA,
- *   providing a specific time for expected delivery.
+ *   providing a specific time for expected delivery in UTC format.
  * @property {Address} [delivery_address]
  * @property {Address} [billing_address]
  * @property {AffiliateDetails} [affiliate_details]
@@ -3686,7 +3727,7 @@ const Joi = require("joi");
  *   your order was placed. This field will be phased out after version 2.4.0.
  *   Please use ordering_source instead to ensure accurate order tracking and processing.
  * @property {string} [ordering_source] - To uniquely identify the source
- *   through which order has been placed.
+ *   through which order has been placed (e.g, marketplace, gofynd).
  * @property {string} [shipment_id] - The unique identifier for the shipment itself.
  * @property {string} [customer_note] - Any special notes or instructions
  *   provided by the customer related to the shipment.
@@ -3790,7 +3831,7 @@ const Joi = require("joi");
  *   your order was placed. This field will be phased out after version 2.4.0.
  *   Please use ordering_source instead to ensure accurate order tracking and processing.
  * @property {string} [ordering_source] - To uniquely identify the source
- *   through which order has been placed.
+ *   through which order has been placed (e.g, marketplace, gofynd).
  * @property {Object} [meta] - Meta data of the order contains additional,
  *   potentially dynamic information about the order.
  */
@@ -4603,7 +4644,7 @@ const Joi = require("joi");
  *   your order was placed. This field will be phased out after version 2.4.0.
  *   Please use ordering_source instead to ensure accurate order tracking and processing.
  * @property {string} [ordering_source] - To uniquely identify the source
- *   through which order has been placed.
+ *   through which order has been placed (e.g, marketplace, gofynd).
  * @property {string} order_date - Specifies the exact date and time when the
  *   order was placed by the customer, serving as a key timestamp for the
  *   initiation of the order processing cycle.
@@ -5320,6 +5361,96 @@ const Joi = require("joi");
  * @property {string} [error]
  */
 
+/**
+ * @typedef {| "storefront"
+ *   | "store_os_pos"
+ *   | "kiosk"
+ *   | "scan_go"
+ *   | "smart_trolley"
+ *   | "gofynd"
+ *   | "uniket"
+ *   | "marketplace"
+ *   | "social_commerce"
+ *   | "ondc"
+ *   | "nexus"
+ *   | "nykaa_fashion"
+ *   | "etsy"
+ *   | "vuivui"
+ *   | "zilingo"
+ *   | "firstcry"
+ *   | "bukalapak"
+ *   | "myntra_ppmp"
+ *   | "lazada"
+ *   | "tiktok"
+ *   | "sfcc"
+ *   | "debenhams"
+ *   | "prestomall"
+ *   | "meesho"
+ *   | "amazon_vdf"
+ *   | "bigcommerce"
+ *   | "sendo"
+ *   | "storehippo"
+ *   | "cdiscount"
+ *   | "nykaa"
+ *   | "trendyol"
+ *   | "weloveshopping"
+ *   | "jollee"
+ *   | "wish"
+ *   | "tiki"
+ *   | "central_online"
+ *   | "q10"
+ *   | "cred"
+ *   | "walmart"
+ *   | "snapdeal"
+ *   | "flipkart"
+ *   | "blibli"
+ *   | "ajio_jit"
+ *   | "pharmeasy"
+ *   | "ezmall"
+ *   | "adobe_commerce"
+ *   | "kartmax"
+ *   | "shopee"
+ *   | "zalora"
+ *   | "prestashop"
+ *   | "smytten"
+ *   | "amazon_sc"
+ *   | "urbanpiper"
+ *   | "flipkart_quick"
+ *   | "woocommerce"
+ *   | "zivame"
+ *   | "lelong"
+ *   | "facebook"
+ *   | "jiomart"
+ *   | "gmc"
+ *   | "robins"
+ *   | "akulaku"
+ *   | "noon"
+ *   | "tatacliq"
+ *   | "kartrocket"
+ *   | "inorbit"
+ *   | "ajio_business"
+ *   | "swiggy"
+ *   | "asos"
+ *   | "tokopedia"
+ *   | "limeroad"
+ *   | "myntra_omni"
+ *   | "spoyl"
+ *   | "amazon_mlf"
+ *   | "fulfilled_by_lazada"
+ *   | "ebay"
+ *   | "jd"
+ *   | "amazon_pharmacy"
+ *   | "ajio_vms"
+ *   | "daraz"
+ *   | "oker"
+ *   | "flipkart_b2b"
+ *   | "amazon_mlf_ss"
+ *   | "woovly"
+ *   | "tata1mg"
+ *   | "zomato"
+ *   | "shopify"} OrderingSource
+ */
+
 class OrderPlatformModel {
   /** @returns {InvalidateShipmentCachePayload} */
   static InvalidateShipmentCachePayload() {
@@ -5606,6 +5737,41 @@ class OrderPlatformModel {
     });
   }
 
+  /** @returns {SellerQCDetailsSchema} */
+  static SellerQCDetailsSchema() {
+    return Joi.object({
+      line_number: Joi.number().required(),
+      good_quantity: Joi.number().required(),
+      bad_quantity: Joi.number().required(),
+    });
+  }
+
+  /** @returns {EntityStatusDataSchema} */
+  static EntityStatusDataSchema() {
+    return Joi.object({
+      seller_qc_details: Joi.array().items(
+        OrderPlatformModel.SellerQCDetailsSchema()
+      ),
+    });
+  }
+
+  /** @returns {DataUpdatesFiltersSchema} */
+  static DataUpdatesFiltersSchema() {
+    return Joi.object({
+      line_number: Joi.number(),
+      quantity: Joi.number(),
+      identifier: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {EntityStatusDataUpdates} */
+  static EntityStatusDataUpdates() {
+    return Joi.object({
+      filters: Joi.array().items(OrderPlatformModel.DataUpdatesFiltersSchema()),
+      data: OrderPlatformModel.EntityStatusDataSchema(),
+    });
+  }
+
   /** @returns {DataUpdates} */
   static DataUpdates() {
     return Joi.object({
@@ -5615,6 +5781,9 @@ class OrderPlatformModel {
       products: Joi.array().items(OrderPlatformModel.ProductsDataUpdates()),
       entities: Joi.array().items(OrderPlatformModel.EntitiesDataUpdates()),
       order: Joi.array().items(OrderPlatformModel.OrderDataUpdates()),
+      entity_status: Joi.array().items(
+        OrderPlatformModel.EntityStatusDataUpdates()
+      ),
     });
   }
 
@@ -6226,7 +6395,7 @@ class OrderPlatformModel {
       currency: Joi.string().allow(""),
       total_order_value: Joi.number(),
       ordering_channel: Joi.string().allow(""),
-      ordering_source: Joi.string().allow("").allow(null),
+      ordering_source: Joi.string().allow(""),
       meta: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
       cod_charges: Joi.number().allow(null),
       cashback_value: Joi.number().allow(null),
@@ -7689,7 +7858,7 @@ class OrderPlatformModel {
     return Joi.object({
       app_id: Joi.string().allow("").required(),
       ordering_channel: Joi.string().allow(""),
-      ordering_source: Joi.string().allow("").allow(null),
+      ordering_source: Joi.string().allow(""),
       entity: Joi.string().allow("").required(),
     });
   }
@@ -8017,7 +8186,7 @@ class OrderPlatformModel {
       country_code: Joi.string().allow("").allow(null),
       country_iso_code: Joi.string().allow("").allow(null),
       country_phone_code: Joi.string().allow("").allow(null),
-      delivery_address_id: Joi.string().allow(""),
+      delivery_address_id: Joi.number(),
       geo_location: Joi.object().pattern(/\S/, Joi.any()),
       name: Joi.string().allow(""),
       sector: Joi.string().allow(""),
@@ -8522,7 +8691,7 @@ class OrderPlatformModel {
       ordering_currency_prices: OrderPlatformModel.OrderingCurrencyPrices(),
       order_id: Joi.string().allow("").required(),
       ordering_channnel: Joi.string().allow("").allow(null),
-      ordering_source: Joi.string().allow("").allow(null),
+      ordering_source: Joi.string().allow(""),
       shipment_id: Joi.string().allow("").allow(null),
       customer_note: Joi.string().allow("").allow(null),
       total_bags: Joi.number().required(),
@@ -8590,7 +8759,7 @@ class OrderPlatformModel {
         .allow(null, ""),
       order_value: Joi.string().allow("").allow(null),
       ordering_channel: Joi.string().allow("").allow(null),
-      ordering_source: Joi.string().allow("").allow(null),
+      ordering_source: Joi.string().allow(""),
       meta: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
@@ -9209,7 +9378,7 @@ class OrderPlatformModel {
   static OrderData() {
     return Joi.object({
       ordering_channel: Joi.string().allow(""),
-      ordering_source: Joi.string().allow("").allow(null),
+      ordering_source: Joi.string().allow(""),
       order_date: Joi.string().allow("").required(),
       created_ts: Joi.string().allow(""),
       tax_details: OrderPlatformModel.TaxDetails(),
@@ -9880,5 +10049,188 @@ class OrderPlatformModel {
       error: Joi.string().allow(""),
     });
   }
+
+  /**
+   * Enum: OrderingSource Used By: Order
+   *
+   * @returns {OrderingSource}
+   */
+  static OrderingSource() {
+    return Joi.string().valid(
+      "storefront",
+
+      "store_os_pos",
+
+      "kiosk",
+
+      "scan_go",
+
+      "smart_trolley",
+
+      "gofynd",
+
+      "uniket",
+
+      "marketplace",
+
+      "social_commerce",
+
+      "ondc",
+
+      "nexus",
+
+      "nykaa_fashion",
+
+      "etsy",
+
+      "vuivui",
+
+      "zilingo",
+
+      "firstcry",
+
+      "bukalapak",
+
+      "myntra_ppmp",
+
+      "lazada",
+
+      "tiktok",
+
+      "sfcc",
+
+      "debenhams",
+
+      "prestomall",
+
+      "meesho",
+
+      "amazon_vdf",
+
+      "bigcommerce",
+
+      "sendo",
+
+      "storehippo",
+
+      "cdiscount",
+
+      "nykaa",
+
+      "trendyol",
+
+      "weloveshopping",
+
+      "jollee",
+
+      "wish",
+
+      "tiki",
+
+      "central_online",
+
+      "q10",
+
+      "cred",
+
+      "walmart",
+
+      "snapdeal",
+
+      "flipkart",
+
+      "blibli",
+
+      "ajio_jit",
+
+      "pharmeasy",
+
+      "ezmall",
+
+      "adobe_commerce",
+
+      "kartmax",
+
+      "shopee",
+
+      "zalora",
+
+      "prestashop",
+
+      "smytten",
+
+      "amazon_sc",
+
+      "urbanpiper",
+
+      "flipkart_quick",
+
+      "woocommerce",
+
+      "zivame",
+
+      "lelong",
+
+      "facebook",
+
+      "jiomart",
+
+      "gmc",
+
+      "robins",
+
+      "akulaku",
+
+      "noon",
+
+      "tatacliq",
+
+      "kartrocket",
+
+      "inorbit",
+
+      "ajio_business",
+
+      "swiggy",
+
+      "asos",
+
+      "tokopedia",
+
+      "limeroad",
+
+      "myntra_omni",
+
+      "spoyl",
+
+      "amazon_mlf",
+
+      "fulfilled_by_lazada",
+
+      "ebay",
+
+      "jd",
+
+      "amazon_pharmacy",
+
+      "ajio_vms",
+
+      "daraz",
+
+      "oker",
+
+      "flipkart_b2b",
+
+      "amazon_mlf_ss",
+
+      "woovly",
+
+      "tata1mg",
+
+      "zomato",
+
+      "shopify"
+    );
+  }
 }
 module.exports = OrderPlatformModel;

package/sdk/platform/Order/OrderPlatformValidator.d.ts

@@ -33,8 +33,8 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef CreateOrderParam
- * @property {string} [xOrderingSource] - To uniquely identify the source
- *   through which order has been placed.
+ * @property {OrderPlatformModel.OrderingSource} [xOrderingSource] - To uniquely
+ *   identify the source through which order has been placed.
  * @property {OrderPlatformModel.CreateOrderAPI} body
  */
 /**
@@ -89,8 +89,8 @@ export = OrderPlatformValidator;
  * @property {string} [orderingChannel] - The specific channel through which
  *   your order was placed. This field will be phased out after version 2.4.0.
  *   Please use ordering_source instead to ensure accurate order tracking and processing.
- * @property {string} [orderingSource] - To uniquely identify the source through
- *   which order has been placed.
+ * @property {OrderPlatformModel.OrderingSource} [orderingSource] - To uniquely
+ *   identify the source through which order has been placed.
  * @property {string} status - The status key indicates the current status for
  *   which the API will provide a list of possible next state transitions.
  */
@@ -384,8 +384,8 @@ export = OrderPlatformValidator;
  * @typedef GetStateManagerConfigParam
  * @property {string} [appId] - The unique identifier of the application.
  * @property {string} [orderingChannel] - The channel through which orders are placed.
- * @property {string} [orderingSource] - To uniquely identify the source through
- *   which order has been placed.
+ * @property {OrderPlatformModel.OrderingSource} [orderingSource] - To uniquely
+ *   identify the source through which order has been placed.
  * @property {string} [entity] - The entity for which the configuration is applied.
  */
 /** @typedef GetStateTransitionMapParam */
@@ -637,10 +637,10 @@ type CreateChannelConfigParam = {
 };
 type CreateOrderParam = {
     /**
-     * - To uniquely identify the source
-     * through which order has been placed.
+     * - To uniquely
+     * identify the source through which order has been placed.
      */
-    xOrderingSource?: string;
+    xOrderingSource?: OrderPlatformModel.OrderingSource;
     body: OrderPlatformModel.CreateOrderAPI;
 };
 type DispatchManifestsParam = {
@@ -712,10 +712,10 @@ type GetAllowedStateTransitionParam = {
      */
     orderingChannel?: string;
     /**
-     * - To uniquely identify the source through
-     * which order has been placed.
+     * - To uniquely
+     * identify the source through which order has been placed.
      */
-    orderingSource?: string;
+    orderingSource?: OrderPlatformModel.OrderingSource;
     /**
      * - The status key indicates the current status for
      * which the API will provide a list of possible next state transitions.
@@ -1403,10 +1403,10 @@ type GetStateManagerConfigParam = {
      */
     orderingChannel?: string;
     /**
-     * - To uniquely identify the source through
-     * which order has been placed.
+     * - To uniquely
+     * identify the source through which order has been placed.
      */
-    orderingSource?: string;
+    orderingSource?: OrderPlatformModel.OrderingSource;
     /**
      * - The entity for which the configuration is applied.
      */

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -42,8 +42,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef CreateOrderParam
- * @property {string} [xOrderingSource] - To uniquely identify the source
- *   through which order has been placed.
+ * @property {OrderPlatformModel.OrderingSource} [xOrderingSource] - To uniquely
+ *   identify the source through which order has been placed.
  * @property {OrderPlatformModel.CreateOrderAPI} body
  */
 
@@ -109,8 +109,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} [orderingChannel] - The specific channel through which
  *   your order was placed. This field will be phased out after version 2.4.0.
  *   Please use ordering_source instead to ensure accurate order tracking and processing.
- * @property {string} [orderingSource] - To uniquely identify the source through
- *   which order has been placed.
+ * @property {OrderPlatformModel.OrderingSource} [orderingSource] - To uniquely
+ *   identify the source through which order has been placed.
  * @property {string} status - The status key indicates the current status for
  *   which the API will provide a list of possible next state transitions.
  */
@@ -425,8 +425,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @typedef GetStateManagerConfigParam
  * @property {string} [appId] - The unique identifier of the application.
  * @property {string} [orderingChannel] - The channel through which orders are placed.
- * @property {string} [orderingSource] - To uniquely identify the source through
- *   which order has been placed.
+ * @property {OrderPlatformModel.OrderingSource} [orderingSource] - To uniquely
+ *   identify the source through which order has been placed.
  * @property {string} [entity] - The entity for which the configuration is applied.
  */
 
@@ -580,7 +580,7 @@ class OrderPlatformValidator {
   /** @returns {CreateOrderParam} */
   static createOrder() {
     return Joi.object({
-      xOrderingSource: Joi.string().allow(""),
+      xOrderingSource: OrderPlatformModel.OrderingSource(),
       body: OrderPlatformModel.CreateOrderAPI().required(),
     }).required();
   }
@@ -666,7 +666,7 @@ class OrderPlatformValidator {
   static getAllowedStateTransition() {
     return Joi.object({
       orderingChannel: Joi.string().allow(""),
-      orderingSource: Joi.string().allow(""),
+      orderingSource: OrderPlatformModel.OrderingSource(),
       status: Joi.string().allow("").required(),
     }).required();
   }
@@ -941,7 +941,7 @@ class OrderPlatformValidator {
     return Joi.object({
       appId: Joi.string().allow(""),
       orderingChannel: Joi.string().allow(""),
-      orderingSource: Joi.string().allow(""),
+      orderingSource: OrderPlatformModel.OrderingSource(),
       entity: Joi.string().allow(""),
     }).required();
   }

package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts

@@ -114,8 +114,9 @@ export = PaymentPlatformApplicationValidator;
  */
 /**
  * @typedef GetPosPaymentModeRoutesParam
- * @property {string} [xOrderingSource] - Optional header to identify the
- *   ordering source used to determine\ applicable payment options for business unit.
+ * @property {PaymentPlatformModel.OrderingSource} [xOrderingSource] - Optional
+ *   header to identify the ordering source used to determine\ applicable
+ *   payment options for business unit.
  * @property {number} amount - Payable amount.
  * @property {string} [cartId] - Identifier of the cart.
  * @property {string} pincode - The PIN Code of the destination address, e.g. 400059
@@ -495,10 +496,11 @@ type GetPaymentSessionParam = {
 };
 type GetPosPaymentModeRoutesParam = {
     /**
-     * - Optional header to identify the
-     * ordering source used to determine\ applicable payment options for business unit.
+     * - Optional
+     * header to identify the ordering source used to determine\ applicable
+     * payment options for business unit.
      */
-    xOrderingSource?: string;
+    xOrderingSource?: PaymentPlatformModel.OrderingSource;
     /**
      * - Payable amount.
      */

package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js

@@ -142,8 +142,9 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
 
 /**
  * @typedef GetPosPaymentModeRoutesParam
- * @property {string} [xOrderingSource] - Optional header to identify the
- *   ordering source used to determine\ applicable payment options for business unit.
+ * @property {PaymentPlatformModel.OrderingSource} [xOrderingSource] - Optional
+ *   header to identify the ordering source used to determine\ applicable
+ *   payment options for business unit.
  * @property {number} amount - Payable amount.
  * @property {string} [cartId] - Identifier of the cart.
  * @property {string} pincode - The PIN Code of the destination address, e.g. 400059
@@ -492,7 +493,7 @@ class PaymentPlatformApplicationValidator {
   /** @returns {GetPosPaymentModeRoutesParam} */
   static getPosPaymentModeRoutes() {
     return Joi.object({
-      xOrderingSource: Joi.string().allow(""),
+      xOrderingSource: PaymentPlatformModel.OrderingSource(),
 
       amount: Joi.number().required(),
       cartId: Joi.string().allow(""),