@gofynd/fdk-client-javascript 1.4.10 → 1.4.12-beta.1

package/sdk/platform/Order/OrderPlatformModel.js

@@ -494,6 +494,36 @@ const Joi = require("joi");
  * @property {AffiliateStoreIdMapping[]} affiliate_store_id_mapping
  */
 
+/**
+ * @typedef DPConfiguration
+ * @property {string} [shipping_by] - Shipping_by denotes dp assignment
+ *   strategy- if shipping_by is fynd dp assignment would be handled by OMS
+ */
+
+/**
+ * @typedef PaymentConfig
+ * @property {string} [mode_of_payment] - Specifies the mode through which the
+ *   payment was collected, serving as an identifier for the payment's origin.
+ * @property {string} [source] - The source field identifies the channel through
+ *   which the order was placed, such as MARKETPLACE, ECOMM.
+ */
+
+/**
+ * @typedef CreateOrderConfig
+ * @property {DPConfiguration} [dp_configuration]
+ * @property {string} [integration_type] - Flag denotes integration type which
+ *   is used to retrieve specific configurations and application details
+ *   relevant to channel fulfillment.
+ * @property {boolean} [location_reassignment] - Flag denotes if the location
+ *   for the store needs to be reassigned post cancellation.
+ * @property {PaymentConfig} [payment]
+ * @property {boolean} [optimal_shipment_creation] - Denotes the shipment
+ *   breaking strategy. If the flag is set true, the shipment is created using
+ *   optimal shipment creation strategy based on the servicability & packaging
+ *   dimensions by OMS .If false, shipment details, including location_id, must
+ *   be passed to FDK for processing.
+ */
+
 /**
  * @typedef CreateOrderPayload
  * @property {string} affiliate_id
@@ -693,6 +723,14 @@ const Joi = require("joi");
  * @property {OrderDetails} order_details
  * @property {string[]} [errors]
  * @property {ShipmentDetail[]} [shipment_details]
+ * @property {string} [text] - A label or description of the delivery status,
+ *   such as 'Expected Delivery Date'.
+ * @property {string} [value] - The detailed delivery status or time
+ *   information, such as 'Arriving on 24 Nov 2022 15:54:00'.
+ * @property {string} [color_code] - Hex code for the color representing the
+ *   delivery status.
+ * @property {string} [expected_delivery_date] - The ISO 8601 formatted date and
+ *   time when the delivery is expected, e.g., '2022-11-24T22:15:54+00:00'.
  */
 
 /**
@@ -770,8 +808,12 @@ const Joi = require("joi");
  * @property {ProcessingDates} [processing_dates]
  * @property {Object} [meta] - Meta data of the shipment.
  * @property {number} [priority] - Integer value indicating high and low priority.
- * @property {number} location_id - Location Identifier or Store/Fulfillment
- *   Identifier of the shipment.
+ * @property {number} [location_id] - Location Identifier or Store/Fulfillment
+ *   Identifier of the shipment- This field is mandatory when
+ *   optimal_shipment_creation flag is set to false, indicating that shipments
+ *   must be associated with a specific location. When
+ *   `optimal_shipment_creation` is true, the optimal location for order
+ *   creation would be assigned, location_id becomes optional.
  * @property {string} [order_type] - The order type of shipment HomeDelivery -
  *   If the customer wants the order home-delivered PickAtStore - If the
  *   customer wants the handover of an order at the store itself.
@@ -804,17 +846,6 @@ const Joi = require("joi");
  * @property {ShipmentGstDetails} [gst]
  */
 
-/**
- * @typedef ShipmentRequestData
- * @property {LineItem[]} line_items
- * @property {ProcessingDates} [processing_dates]
- * @property {Object} [meta] - Meta data of the shipment.
- * @property {number} [priority] - Integer value indicating high and low priority.
- * @property {string} [order_type] - The order type of shipment HomeDelivery -
- *   If the customer wants the order home-delivered PickAtStore - If the
- *   customer wants the handover of an order at the store itself.
- */
-
 /**
  * @typedef ShippingInfo
  * @property {string} [alternate_mobile_number]
@@ -915,7 +946,6 @@ const Joi = require("joi");
 /**
  * @typedef CreateOrderAPI
  * @property {Shipment[]} shipments
- * @property {ShipmentRequestData} [shipment_request_data]
  * @property {ShippingInfo} shipping_info
  * @property {BillingInfo} billing_info
  * @property {Object} [currency_info]
@@ -924,7 +954,7 @@ const Joi = require("joi");
  * @property {string} [external_creation_date]
  * @property {Object} [meta]
  * @property {TaxInfo} [tax_info]
- * @property {Object} [config]
+ * @property {CreateOrderConfig} [config]
  * @property {PaymentInfo} payment_info
  * @property {UserInfo} [user_info]
  * @property {number} [ordering_store_id]
@@ -2784,6 +2814,7 @@ const Joi = require("joi");
  * @property {InvoiceInfo} [invoice]
  * @property {string} [shipment_status]
  * @property {GSTDetailsData} [gst_details]
+ * @property {OrderStatusData} [order_status]
  * @property {Object} [delivery_slot]
  * @property {OrderDetailsData} [order]
  * @property {UserDataInfo} [user]
@@ -3814,7 +3845,7 @@ class OrderPlatformModel {
       dp_options: Joi.any().allow(null),
       lock_status: Joi.boolean().allow(null),
       action_to_status: Joi.any().allow(null),
-    });
+    }).allow(null);
   }
 
   /** @returns {ShipmentConfig} */
@@ -4016,6 +4047,32 @@ class OrderPlatformModel {
     });
   }
 
+  /** @returns {DPConfiguration} */
+  static DPConfiguration() {
+    return Joi.object({
+      shipping_by: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {PaymentConfig} */
+  static PaymentConfig() {
+    return Joi.object({
+      mode_of_payment: Joi.string().allow(""),
+      source: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CreateOrderConfig} */
+  static CreateOrderConfig() {
+    return Joi.object({
+      dp_configuration: OrderPlatformModel.DPConfiguration(),
+      integration_type: Joi.string().allow(""),
+      location_reassignment: Joi.boolean(),
+      payment: OrderPlatformModel.PaymentConfig(),
+      optimal_shipment_creation: Joi.boolean(),
+    });
+  }
+
   /** @returns {CreateOrderPayload} */
   static CreateOrderPayload() {
     return Joi.object({
@@ -4255,6 +4312,10 @@ class OrderPlatformModel {
       order_details: OrderPlatformModel.OrderDetails().required(),
       errors: Joi.array().items(Joi.string().allow("")),
       shipment_details: Joi.array().items(OrderPlatformModel.ShipmentDetail()),
+      text: Joi.string().allow(""),
+      value: Joi.string().allow(""),
+      color_code: Joi.string().allow(""),
+      expected_delivery_date: Joi.string().allow(""),
     });
   }
 
@@ -4346,7 +4407,7 @@ class OrderPlatformModel {
       processing_dates: OrderPlatformModel.ProcessingDates(),
       meta: Joi.any().allow(null),
       priority: Joi.number(),
-      location_id: Joi.number().required(),
+      location_id: Joi.number(),
       order_type: Joi.string().allow(""),
       parent_type: Joi.string().allow("").allow(null),
       store_invoice_id: Joi.string().allow("").allow(null),
@@ -4378,17 +4439,6 @@ class OrderPlatformModel {
     });
   }
 
-  /** @returns {ShipmentRequestData} */
-  static ShipmentRequestData() {
-    return Joi.object({
-      line_items: Joi.array().items(OrderPlatformModel.LineItem()).required(),
-      processing_dates: OrderPlatformModel.ProcessingDates(),
-      meta: Joi.any(),
-      priority: Joi.number(),
-      order_type: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {ShippingInfo} */
   static ShippingInfo() {
     return Joi.object({
@@ -4502,7 +4552,6 @@ class OrderPlatformModel {
   static CreateOrderAPI() {
     return Joi.object({
       shipments: Joi.array().items(OrderPlatformModel.Shipment()).required(),
-      shipment_request_data: OrderPlatformModel.ShipmentRequestData(),
       shipping_info: OrderPlatformModel.ShippingInfo().required(),
       billing_info: OrderPlatformModel.BillingInfo().required(),
       currency_info: Joi.any(),
@@ -4511,7 +4560,7 @@ class OrderPlatformModel {
       external_creation_date: Joi.string().allow(""),
       meta: Joi.any(),
       tax_info: OrderPlatformModel.TaxInfo(),
-      config: Joi.any(),
+      config: OrderPlatformModel.CreateOrderConfig(),
       payment_info: OrderPlatformModel.PaymentInfo().required(),
       user_info: OrderPlatformModel.UserInfo(),
       ordering_store_id: Joi.number(),
@@ -5710,7 +5759,7 @@ class OrderPlatformModel {
       contact_person: Joi.string().allow("").allow(null),
       state: Joi.string().allow("").allow(null),
       city: Joi.string().allow("").allow(null),
-    });
+    }).allow(null);
   }
 
   /** @returns {ShipmentListingChannel} */
@@ -6638,6 +6687,7 @@ class OrderPlatformModel {
       invoice: OrderPlatformModel.InvoiceInfo(),
       shipment_status: Joi.string().allow("").allow(null),
       gst_details: OrderPlatformModel.GSTDetailsData(),
+      order_status: OrderPlatformModel.OrderStatusData(),
       delivery_slot: Joi.any().allow(null),
       order: OrderPlatformModel.OrderDetailsData(),
       user: OrderPlatformModel.UserDataInfo(),
@@ -7099,7 +7149,7 @@ class OrderPlatformModel {
       mall_name: Joi.string().allow("").allow(null),
       latitude: Joi.number().allow(null),
       address2: Joi.string().allow("").allow(null),
-    });
+    }).allow(null);
   }
 
   /** @returns {Brand} */
@@ -7183,7 +7233,7 @@ class OrderPlatformModel {
       brand_calculated_amount: Joi.number().allow(null),
       tax_collected_at_source: Joi.number().allow(null),
       gstin_code: Joi.string().allow("").allow(null),
-    });
+    }).allow(null);
   }
 
   /** @returns {DeliverySlotDetails} */
@@ -7194,7 +7244,7 @@ class OrderPlatformModel {
       lower_bound: Joi.string().allow("").allow(null),
       date: Joi.string().allow("").allow(null),
       type: Joi.string().allow("").allow(null),
-    });
+    }).allow(null);
   }
 
   /** @returns {InvoiceDetails} */
@@ -7204,7 +7254,7 @@ class OrderPlatformModel {
       store_invoice_id: Joi.string().allow("").allow(null),
       invoice_url: Joi.string().allow("").allow(null),
       label_url: Joi.string().allow("").allow(null),
-    });
+    }).allow(null);
   }
 
   /** @returns {UserDetails} */
@@ -7220,7 +7270,7 @@ class OrderPlatformModel {
       gender: Joi.string().allow("").allow(null),
       mongo_user_id: Joi.string().allow("").allow(null),
       meta: Joi.any().allow(null),
-    });
+    }).allow(null);
   }
 
   /** @returns {WeightData} */
@@ -7228,7 +7278,7 @@ class OrderPlatformModel {
     return Joi.object({
       value: Joi.number().allow(null),
       unit: Joi.string().allow("").allow(null),
-    });
+    }).allow(null);
   }
 
   /** @returns {BagDetails} */
@@ -7335,7 +7385,7 @@ class OrderPlatformModel {
     return Joi.object({
       items: Joi.array().items(OrderPlatformModel.BagDetails()),
       page: OrderPlatformModel.BagsPage(),
-    });
+    }).allow(null);
   }
 
   /** @returns {GetBagsPlatformResponse} */

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

@@ -387,10 +387,16 @@ export = PaymentPlatformModel;
 /**
  * @typedef MultiTenderPaymentMeta
  * @property {Object} [extra_meta]
- * @property {string} [order_id]
- * @property {string} [payment_id]
- * @property {string} [current_status]
- * @property {string} [payment_gateway]
+ * @property {string} [order_id] - Fynd Platform order ID
+ * @property {string} [payment_id] - A unique identifier associated with a
+ *   specific payment transaction
+ * @property {string} [current_status] - Represents the current state or
+ *   condition of an object, such as an order or payment.
+ * @property {string} [payment_gateway] - Specifies the name or identifier of
+ *   the payment gateway. This will deprecated in future version. We recommend
+ *   switching to `payment_gateway_slug` to ensure uninterrupted payment processing.
+ * @property {string} [payment_gateway_slug] - A simplified, URL-friendly string
+ *   that represents the name of the payment gateway and it will used for refund PG.
  */
 /**
  * @typedef MultiTenderPaymentMethod
@@ -1003,6 +1009,8 @@ export = PaymentPlatformModel;
  * @property {Object[]} articles - List of articles that are added in cart
  * @property {number} cart_value - Total cart value i.e. amount to be paid
  * @property {number} [total_quantity] - Total number of items in cart
+ * @property {Object} [custom_cart_meta] - This field is used to add and
+ *   retrieve custom data fields to cart items.
  */
 /**
  * @typedef RefundDetailsSerializer
@@ -2193,10 +2201,31 @@ type OrderBeneficiaryResponse = {
 declare function MultiTenderPaymentMeta(): MultiTenderPaymentMeta;
 type MultiTenderPaymentMeta = {
     extra_meta?: any;
+    /**
+     * - Fynd Platform order ID
+     */
     order_id?: string;
+    /**
+     * - A unique identifier associated with a
+     * specific payment transaction
+     */
     payment_id?: string;
+    /**
+     * - Represents the current state or
+     * condition of an object, such as an order or payment.
+     */
     current_status?: string;
+    /**
+     * - Specifies the name or identifier of
+     * the payment gateway. This will deprecated in future version. We recommend
+     * switching to `payment_gateway_slug` to ensure uninterrupted payment processing.
+     */
     payment_gateway?: string;
+    /**
+     * - A simplified, URL-friendly string
+     * that represents the name of the payment gateway and it will used for refund PG.
+     */
+    payment_gateway_slug?: string;
 };
 /** @returns {MultiTenderPaymentMethod} */
 declare function MultiTenderPaymentMethod(): MultiTenderPaymentMethod;
@@ -3849,6 +3878,11 @@ type CartDetailsSerializer = {
      * - Total number of items in cart
      */
     total_quantity?: number;
+    /**
+     * - This field is used to add and
+     * retrieve custom data fields to cart items.
+     */
+    custom_cart_meta?: any;
 };
 /** @returns {RefundDetailsSerializer} */
 declare function RefundDetailsSerializer(): RefundDetailsSerializer;

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -435,10 +435,16 @@ const Joi = require("joi");
 /**
  * @typedef MultiTenderPaymentMeta
  * @property {Object} [extra_meta]
- * @property {string} [order_id]
- * @property {string} [payment_id]
- * @property {string} [current_status]
- * @property {string} [payment_gateway]
+ * @property {string} [order_id] - Fynd Platform order ID
+ * @property {string} [payment_id] - A unique identifier associated with a
+ *   specific payment transaction
+ * @property {string} [current_status] - Represents the current state or
+ *   condition of an object, such as an order or payment.
+ * @property {string} [payment_gateway] - Specifies the name or identifier of
+ *   the payment gateway. This will deprecated in future version. We recommend
+ *   switching to `payment_gateway_slug` to ensure uninterrupted payment processing.
+ * @property {string} [payment_gateway_slug] - A simplified, URL-friendly string
+ *   that represents the name of the payment gateway and it will used for refund PG.
  */
 
 /**
@@ -1116,6 +1122,8 @@ const Joi = require("joi");
  * @property {Object[]} articles - List of articles that are added in cart
  * @property {number} cart_value - Total cart value i.e. amount to be paid
  * @property {number} [total_quantity] - Total number of items in cart
+ * @property {Object} [custom_cart_meta] - This field is used to add and
+ *   retrieve custom data fields to cart items.
  */
 
 /**
@@ -1506,7 +1514,7 @@ class PaymentPlatformModel {
       payment_flow_data: Joi.any().allow(null),
       payment_flow: Joi.string().allow("").allow(null),
       api_link: Joi.string().allow("").allow(null),
-    });
+    }).allow(null);
   }
 
   /** @returns {PaymentDefaultSelection} */
@@ -1564,7 +1572,7 @@ class PaymentPlatformModel {
         .items(Joi.string().allow("").allow(null))
         .allow(null, ""),
       allow_custom_advance_amount: Joi.boolean().allow(null),
-    });
+    }).allow(null);
   }
 
   /** @returns {SplitObject} */
@@ -1573,7 +1581,7 @@ class PaymentPlatformModel {
       total_number_of_splits: Joi.number().allow(null),
       splits_remaining: Joi.number().allow(null),
       amount_remaining: Joi.number().allow(null),
-    });
+    }).allow(null);
   }
 
   /** @returns {AdvancePaymentObject} */
@@ -1868,6 +1876,7 @@ class PaymentPlatformModel {
       payment_id: Joi.string().allow(""),
       current_status: Joi.string().allow(""),
       payment_gateway: Joi.string().allow(""),
+      payment_gateway_slug: Joi.string().allow(""),
     });
   }
 
@@ -2642,6 +2651,7 @@ class PaymentPlatformModel {
       articles: Joi.array().items(Joi.any()).required(),
       cart_value: Joi.number().required(),
       total_quantity: Joi.number(),
+      custom_cart_meta: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 

package/sdk/platform/Theme/ThemePlatformModel.d.ts

@@ -584,7 +584,8 @@ export = ThemePlatformModel;
  *   | "register"
  *   | "shipping-policy"
  *   | "return-policy"
- *   | "order-status"} PageType
+ *   | "order-status"
+ *   | "locate-us"} PageType
  */
 declare class ThemePlatformModel {
 }
@@ -1617,4 +1618,4 @@ type ActionPage = {
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status";
+type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us";

package/sdk/platform/Theme/ThemePlatformModel.js

@@ -665,7 +665,8 @@ const Joi = require("joi");
  *   | "register"
  *   | "shipping-policy"
  *   | "return-policy"
- *   | "order-status"} PageType
+ *   | "order-status"
+ *   | "locate-us"} PageType
  */
 
 class ThemePlatformModel {
@@ -1551,7 +1552,9 @@ class ThemePlatformModel {
 
       "return-policy",
 
-      "order-status"
+      "order-status",
+
+      "locate-us"
     );
   }
 }

package/sdk/platform/Webhook/WebhookPlatformModel.js

@@ -483,7 +483,7 @@ class WebhookPlatformModel {
   static UploadServiceObject() {
     return Joi.object({
       cdn: WebhookPlatformModel.CdnObject(),
-    });
+    }).allow(null);
   }
 
   /** @returns {HistoryAssociation} */