@gofynd/fdk-client-javascript 1.6.1 → 1.6.3

package/README.md

@@ -237,7 +237,7 @@ console.log("Active Theme: ", response.information.name);
 The above code will log the curl command in the console
 
 ```bash
-curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.6.1' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
+curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.6.3' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
 Active Theme: Emerge
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "1.6.1",
+  "version": "1.6.3",
   "description": "",
   "main": "index.js",
   "scripts": {

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

@@ -401,7 +401,7 @@ declare class Order {
      * @summary: List shipments
      * @description: Get a list of shipments based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
      */
-    getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, fulfillmentType, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
+    getShipments({ lane, bagStatus, statusAssigned, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, statusAssignedStartDate, statusAssignedEndDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, fulfillmentType, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
     /**
      * @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/Order/OrderPlatformClient.js

@@ -3337,6 +3337,7 @@ class Order {
     {
       lane,
       bagStatus,
+      statusAssigned,
       statusOverrideLane,
       timeToDispatch,
       searchType,
@@ -3345,6 +3346,8 @@ class Order {
       toDate,
       startDate,
       endDate,
+      statusAssignedStartDate,
+      statusAssignedEndDate,
       dpIds,
       stores,
       salesChannels,
@@ -3377,6 +3380,7 @@ class Order {
       {
         lane,
         bagStatus,
+        statusAssigned,
         statusOverrideLane,
         timeToDispatch,
         searchType,
@@ -3385,6 +3389,8 @@ class Order {
         toDate,
         startDate,
         endDate,
+        statusAssignedStartDate,
+        statusAssignedEndDate,
         dpIds,
         stores,
         salesChannels,
@@ -3421,6 +3427,7 @@ class Order {
       {
         lane,
         bagStatus,
+        statusAssigned,
         statusOverrideLane,
         timeToDispatch,
         searchType,
@@ -3429,6 +3436,8 @@ class Order {
         toDate,
         startDate,
         endDate,
+        statusAssignedStartDate,
+        statusAssignedEndDate,
         dpIds,
         stores,
         salesChannels,
@@ -3466,6 +3475,7 @@ class Order {
     const query_params = {};
     query_params["lane"] = lane;
     query_params["bag_status"] = bagStatus;
+    query_params["status_assigned"] = statusAssigned;
     query_params["status_override_lane"] = statusOverrideLane;
     query_params["time_to_dispatch"] = timeToDispatch;
     query_params["search_type"] = searchType;
@@ -3474,6 +3484,8 @@ class Order {
     query_params["to_date"] = toDate;
     query_params["start_date"] = startDate;
     query_params["end_date"] = endDate;
+    query_params["status_assigned_start_date"] = statusAssignedStartDate;
+    query_params["status_assigned_end_date"] = statusAssignedEndDate;
     query_params["dp_ids"] = dpIds;
     query_params["stores"] = stores;
     query_params["sales_channels"] = salesChannels;

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

@@ -2629,7 +2629,7 @@ export = OrderPlatformModel;
  * @property {string} [last_name] - The last name of the user.
  * @property {string} [mobile] - The mobile phone number of the user.
  * @property {string} [email] - The email address of the user.
- * @property {string} [meta] - Additional metadata related to the user.
+ * @property {Object} [meta] - Additional metadata related to the user.
  * @property {boolean} [is_anonymous_user] - Indicates whether the user is an
  *   anonymous user (true) or registered (false).
  * @property {string} [name] - A full name of the user, which may be a
@@ -10202,7 +10202,7 @@ type UserDataInfo = {
     /**
      * - Additional metadata related to the user.
      */
-    meta?: string;
+    meta?: any;
     /**
      * - Indicates whether the user is an
      * anonymous user (true) or registered (false).

package/sdk/platform/Order/OrderPlatformModel.js

@@ -2867,7 +2867,7 @@ const Joi = require("joi");
  * @property {string} [last_name] - The last name of the user.
  * @property {string} [mobile] - The mobile phone number of the user.
  * @property {string} [email] - The email address of the user.
- * @property {string} [meta] - Additional metadata related to the user.
+ * @property {Object} [meta] - Additional metadata related to the user.
  * @property {boolean} [is_anonymous_user] - Indicates whether the user is an
  *   anonymous user (true) or registered (false).
  * @property {string} [name] - A full name of the user, which may be a
@@ -7924,7 +7924,7 @@ class OrderPlatformModel {
       last_name: Joi.string().allow("").allow(null),
       mobile: Joi.string().allow("").allow(null),
       email: Joi.string().allow("").allow(null),
-      meta: Joi.string().allow("").allow(null),
+      meta: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
       is_anonymous_user: Joi.boolean().allow(null),
       name: Joi.string().allow("").allow(null),
       gender: Joi.string().allow("").allow(null),

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

@@ -292,6 +292,9 @@ export = OrderPlatformValidator;
  * @typedef GetShipmentsParam
  * @property {string} [lane] - Name of lane for which data is to be fetched
  * @property {string} [bagStatus] - Comma separated values of bag statuses.
+ * @property {string} [statusAssigned] - Used to filter shipments based on
+ *   status present in shipment_status_history. For more information on these
+ *   statuses, refer to the Fynd Partners documentation.
  * @property {boolean} [statusOverrideLane] - Use this flag to fetch by
  *   bag_status and override lane.
  * @property {number} [timeToDispatch] - Indicates the time to dispatch.
@@ -305,6 +308,15 @@ export = OrderPlatformValidator;
  *   (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
  * @property {string} [endDate] - The UTC end date in ISO format
  *   (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
+ * @property {string} [statusAssignedStartDate] - Specifies the starting UTC
+ *   date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the lower
+ *   boundary for filtering shipments based on the `created_at` timestamp of
+ *   statuses in the shipment's status history. It allows filtering statuses
+ *   that were created within a specific time range.
+ * @property {string} [statusAssignedEndDate] - Specifies the ending UTC date
+ *   and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper boundary
+ *   for filtering shipments based on the `created_at` timestamp of statuses in
+ *   the shipment's status history.
  * @property {string} [dpIds] - A comma-separated list of delivery partner IDs
  *   to filter results by specific delivery partners.
  * @property {string} [stores] - A comma-separated list of store IDs used to
@@ -1150,6 +1162,12 @@ type GetShipmentsParam = {
      * - Comma separated values of bag statuses.
      */
     bagStatus?: string;
+    /**
+     * - Used to filter shipments based on
+     * status present in shipment_status_history. For more information on these
+     * statuses, refer to the Fynd Partners documentation.
+     */
+    statusAssigned?: string;
     /**
      * - Use this flag to fetch by
      * bag_status and override lane.
@@ -1187,6 +1205,21 @@ type GetShipmentsParam = {
      * (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
      */
     endDate?: string;
+    /**
+     * - Specifies the starting UTC
+     * date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the lower
+     * boundary for filtering shipments based on the `created_at` timestamp of
+     * statuses in the shipment's status history. It allows filtering statuses
+     * that were created within a specific time range.
+     */
+    statusAssignedStartDate?: string;
+    /**
+     * - Specifies the ending UTC date
+     * and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper boundary
+     * for filtering shipments based on the `created_at` timestamp of statuses in
+     * the shipment's status history.
+     */
+    statusAssignedEndDate?: string;
     /**
      * - A comma-separated list of delivery partner IDs
      * to filter results by specific delivery partners.

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -331,6 +331,9 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @typedef GetShipmentsParam
  * @property {string} [lane] - Name of lane for which data is to be fetched
  * @property {string} [bagStatus] - Comma separated values of bag statuses.
+ * @property {string} [statusAssigned] - Used to filter shipments based on
+ *   status present in shipment_status_history. For more information on these
+ *   statuses, refer to the Fynd Partners documentation.
  * @property {boolean} [statusOverrideLane] - Use this flag to fetch by
  *   bag_status and override lane.
  * @property {number} [timeToDispatch] - Indicates the time to dispatch.
@@ -344,6 +347,15 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  *   (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
  * @property {string} [endDate] - The UTC end date in ISO format
  *   (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
+ * @property {string} [statusAssignedStartDate] - Specifies the starting UTC
+ *   date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the lower
+ *   boundary for filtering shipments based on the `created_at` timestamp of
+ *   statuses in the shipment's status history. It allows filtering statuses
+ *   that were created within a specific time range.
+ * @property {string} [statusAssignedEndDate] - Specifies the ending UTC date
+ *   and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper boundary
+ *   for filtering shipments based on the `created_at` timestamp of statuses in
+ *   the shipment's status history.
  * @property {string} [dpIds] - A comma-separated list of delivery partner IDs
  *   to filter results by specific delivery partners.
  * @property {string} [stores] - A comma-separated list of store IDs used to
@@ -856,6 +868,7 @@ class OrderPlatformValidator {
     return Joi.object({
       lane: Joi.string().allow(""),
       bagStatus: Joi.string().allow(""),
+      statusAssigned: Joi.string().allow(""),
       statusOverrideLane: Joi.boolean(),
       timeToDispatch: Joi.number(),
       searchType: Joi.string().allow(""),
@@ -864,6 +877,8 @@ class OrderPlatformValidator {
       toDate: Joi.string().allow(""),
       startDate: Joi.string().allow(""),
       endDate: Joi.string().allow(""),
+      statusAssignedStartDate: Joi.string().allow(""),
+      statusAssignedEndDate: Joi.string().allow(""),
       dpIds: Joi.string().allow(""),
       stores: Joi.string().allow(""),
       salesChannels: Joi.string().allow(""),