@gofynd/fdk-client-javascript 1.4.12 → 1.4.14

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -25,7 +25,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef BulkStateTransistionParam
- * @property {OrderPlatformModel.BulkStateTransistionRequest} body
+ * @property {OrderPlatformModel.BulkStateTransistionRequestSchema} body
  */
 
 /**
@@ -55,7 +55,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef DownloadLanesReportParam
- * @property {OrderPlatformModel.BulkReportsDownloadRequest} body
+ * @property {OrderPlatformModel.BulkReportsDownloadRequestSchema} body
  */
 
 /**
@@ -81,7 +81,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 /**
  * @typedef GenerateInvoiceIDParam
  * @property {string} invoiceType - Mention the type of invoice id to generate
- * @property {OrderPlatformModel.GenerateInvoiceIDRequest} body
+ * @property {OrderPlatformModel.GenerateInvoiceIDRequestSchema} body
  */
 
 /**
@@ -93,7 +93,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef GenerateProcessManifestParam
- * @property {OrderPlatformModel.ProcessManifestRequest} body
+ * @property {OrderPlatformModel.ProcessManifestRequestSchema} body
  */
 
 /**
@@ -136,8 +136,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @typedef GetBulkShipmentExcelFileParam
  * @property {string} [salesChannels] - Comma separated values of sales channel ids
  * @property {string} [dpIds] - Comma separated values of delivery partner ids
- * @property {string} [startDate] - UTC start date in ISO format
- * @property {string} [endDate] - UTC end date in ISO format
+ * @property {string} [startDate] - Date time in UTC timezone as per ISO format.
+ * @property {string} [endDate] - Date time in UTC timezone as per ISO format.
  * @property {string} [stores] - Comma separated values of store ids
  * @property {string} [tags] - Comma separated values of tags
  * @property {string} [bagStatus] - Comma separated values of bag statuses
@@ -154,7 +154,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @typedef GetFileByStatusParam
  * @property {string} batchId
  * @property {string} status
- * @property {string} fileType
+ * @property {string} fileType - It contains the type of file.
  * @property {string} [reportType]
  */
 
@@ -171,15 +171,27 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} [salesChannels]
  * @property {string} [paymentMode] - Comma separated values of payment modes
  * @property {string} [bagStatus] - Comma separated values of bag statuses
- * @property {string} [searchType]
+ * @property {string} [searchType] - Search_type refers to the field that will
+ *   be used as the target for the search operation
  * @property {string} [searchValue]
  * @property {string} [tags]
- * @property {number} [timeToDispatch]
+ * @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
  * @property {string} [paymentMethods]
  * @property {boolean} [myOrders]
  * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
  *   company order
- * @property {string} [orderType]
+ * @property {string} [orderType] - Defines the specific journey a shipment will
+ *   follow based on the application's operational needs and customer
+ *   preferences. This field categorizes orders into distinct types, each
+ *   associated with a unique processing flow. For example:
+ *
+ *   - "HomeDelivery": The order undergoes all state transitions typical for a
+ *       delivery, from processing the shipment to final delivery at the
+ *       customer's address.
+ *   - "PickAtStore": The order is prepared for pickup and moved to a state where it
+ *       is ready to be handed over directly to the customer at the store. This
+ *       type streamlines the process by bypassing traditional shipping stages
+ *       and facilitating a quicker transition to the final handover stage.
  */
 
 /**
@@ -243,10 +255,10 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  *   associated with the order
  * @property {string} [searchValue] - Search_value is matched against the field
  *   specified by the search_type
- * @property {string} [fromDate]
- * @property {string} [toDate]
- * @property {string} [startDate]
- * @property {string} [endDate]
+ * @property {string} [fromDate] - Date time in UTC timezone as per ISO format.
+ * @property {string} [toDate] - Date time in UTC timezone as per ISO format.
+ * @property {string} [startDate] - Date time in UTC timezone as per ISO format.
+ * @property {string} [endDate] - Date time in UTC timezone as per ISO format.
  * @property {string} [dpIds] - Delivery Partner IDs to which shipments are assigned.
  * @property {string} [stores]
  * @property {string} [salesChannels]
@@ -261,6 +273,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} [orderType]
  * @property {boolean} [allowInactive] - Flag indicating whether inactive
  *   shipments are allowed
+ * @property {string} [groupEntity] - Defines the grouping criterion for
+ *   retrieving shipments or orders. It specifies whether the results should be
+ *   organized based on shipment groups or order groups. For example, using
+ *   'shipments' groups results by shipment, while an invalid value like 'abcd'
+ *   may not be recognized, leading to errors or default behavior.
  */
 
 /** @typedef GetRoleBasedActionsParam */
@@ -297,8 +314,9 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} [bagStatus] - Comma separated values of bag statuses
  * @property {boolean} [statusOverrideLane] - Use this flag to fetch by
  *   bag_status and override lane
- * @property {number} [timeToDispatch]
- * @property {string} [searchType] - Search type key
+ * @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
+ * @property {string} [searchType] - Search_type refers to the field that will
+ *   be used as the target for the search operation
  * @property {string} [searchValue] - Search type value
  * @property {string} [fromDate] - Start Date in DD-MM-YYYY format
  * @property {string} [toDate] - End Date in DD-MM-YYYY format
@@ -325,7 +343,24 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  *   company order
  * @property {string} [tags] - Comma separated values of tags
  * @property {string} [customerId]
- * @property {string} [orderType]
+ * @property {string} [orderType] - Defines the specific journey a shipment will
+ *   follow based on the application's operational needs and customer
+ *   preferences. This field categorizes orders into distinct types, each
+ *   associated with a unique processing flow. For example:
+ *
+ *   - "HomeDelivery": The order undergoes all state transitions typical for a
+ *       delivery, from processing the shipment to final delivery at the
+ *       customer's address.
+ *   - "PickAtStore": The order is prepared for pickup and moved to a state where it
+ *       is ready to be handed over directly to the customer at the store. This
+ *       type streamlines the process by bypassing traditional shipping stages
+ *       and facilitating a quicker transition to the final handover stage.
+ *
+ * @property {string} [groupEntity] - Defines the grouping criterion for
+ *   retrieving shipments or orders. It specifies whether the results should be
+ *   organized based on shipment groups or order groups. For example, using
+ *   'shipments' groups results by shipment, while an invalid value like 'abcd'
+ *   may not be recognized, leading to errors or default behavior.
  */
 
 /**
@@ -398,18 +433,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef UpdateAddressParam
- * @property {string} shipmentId
- * @property {string} [name]
- * @property {string} [address]
- * @property {string} [addressType]
- * @property {string} [pincode]
- * @property {string} [phone]
- * @property {string} [email]
- * @property {string} [landmark]
- * @property {string} addressCategory
- * @property {string} [city]
- * @property {string} [state]
- * @property {string} [country]
+ * @property {string} shipmentId - Unique shipment no. that is auto-generated
+ * @property {OrderPlatformModel.UpdateAddressRequestBody} body
  */
 
 /**
@@ -417,6 +442,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {OrderPlatformModel.UpdatePackagingDimensionsPayload} body
  */
 
+/**
+ * @typedef UpdatePaymentInfoParam
+ * @property {OrderPlatformModel.UpdateShipmentPaymentMode} body
+ */
+
 /**
  * @typedef UpdateShipmentLockParam
  * @property {OrderPlatformModel.UpdateShipmentLockPayload} body
@@ -424,7 +454,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef UpdateShipmentStatusParam
- * @property {OrderPlatformModel.UpdateShipmentStatusRequest} body
+ * @property {OrderPlatformModel.UpdateShipmentStatusRequestSchema} body
  */
 
 /**
@@ -474,7 +504,7 @@ class OrderPlatformValidator {
   /** @returns {BulkStateTransistionParam} */
   static bulkStateTransistion() {
     return Joi.object({
-      body: OrderPlatformModel.BulkStateTransistionRequest().required(),
+      body: OrderPlatformModel.BulkStateTransistionRequestSchema().required(),
     }).required();
   }
 
@@ -516,7 +546,7 @@ class OrderPlatformValidator {
   /** @returns {DownloadLanesReportParam} */
   static downloadLanesReport() {
     return Joi.object({
-      body: OrderPlatformModel.BulkReportsDownloadRequest().required(),
+      body: OrderPlatformModel.BulkReportsDownloadRequestSchema().required(),
     }).required();
   }
 
@@ -552,7 +582,7 @@ class OrderPlatformValidator {
   static generateInvoiceID() {
     return Joi.object({
       invoiceType: Joi.string().allow("").required(),
-      body: OrderPlatformModel.GenerateInvoiceIDRequest().required(),
+      body: OrderPlatformModel.GenerateInvoiceIDRequestSchema().required(),
     }).required();
   }
 
@@ -568,7 +598,7 @@ class OrderPlatformValidator {
   /** @returns {GenerateProcessManifestParam} */
   static generateProcessManifest() {
     return Joi.object({
-      body: OrderPlatformModel.ProcessManifestRequest().required(),
+      body: OrderPlatformModel.ProcessManifestRequestSchema().required(),
     }).required();
   }
 
@@ -759,6 +789,7 @@ class OrderPlatformValidator {
       customerId: Joi.string().allow(""),
       orderType: Joi.string().allow(""),
       allowInactive: Joi.boolean(),
+      groupEntity: Joi.string().allow(""),
     }).required();
   }
 
@@ -828,6 +859,7 @@ class OrderPlatformValidator {
       tags: Joi.string().allow(""),
       customerId: Joi.string().allow(""),
       orderType: Joi.string().allow(""),
+      groupEntity: Joi.string().allow(""),
     }).required();
   }
 
@@ -930,17 +962,7 @@ class OrderPlatformValidator {
   static updateAddress() {
     return Joi.object({
       shipmentId: Joi.string().allow("").required(),
-      name: Joi.string().allow(""),
-      address: Joi.string().allow(""),
-      addressType: Joi.string().allow(""),
-      pincode: Joi.string().allow(""),
-      phone: Joi.string().allow(""),
-      email: Joi.string().allow(""),
-      landmark: Joi.string().allow(""),
-      addressCategory: Joi.string().allow("").required(),
-      city: Joi.string().allow(""),
-      state: Joi.string().allow(""),
-      country: Joi.string().allow(""),
+      body: OrderPlatformModel.UpdateAddressRequestBody().required(),
     }).required();
   }
 
@@ -951,6 +973,13 @@ class OrderPlatformValidator {
     }).required();
   }
 
+  /** @returns {UpdatePaymentInfoParam} */
+  static updatePaymentInfo() {
+    return Joi.object({
+      body: OrderPlatformModel.UpdateShipmentPaymentMode().required(),
+    }).required();
+  }
+
   /** @returns {UpdateShipmentLockParam} */
   static updateShipmentLock() {
     return Joi.object({
@@ -961,7 +990,7 @@ class OrderPlatformValidator {
   /** @returns {UpdateShipmentStatusParam} */
   static updateShipmentStatus() {
     return Joi.object({
-      body: OrderPlatformModel.UpdateShipmentStatusRequest().required(),
+      body: OrderPlatformModel.UpdateShipmentStatusRequestSchema().required(),
     }).required();
   }
 

package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts

@@ -7,22 +7,24 @@ declare class Partner {
      * @param {PartnerPlatformApplicationValidator.AddProxyPathParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
+     * @returns {Promise<PartnerPlatformModel.ExtensionProxyPathCreation>} -
+     *   Success response
      * @name addProxyPath
      * @summary: Create extension proxy
      * @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
      */
-    addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.AddProxyResponse>;
+    addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathCreation>;
     /**
      * @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
+     * @returns {Promise<PartnerPlatformModel.ExtensionProxyPathDelete>} -
+     *   Success response
      * @name removeProxyPath
      * @summary: Remove extension proxy
      * @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
      */
-    removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.RemoveProxyResponse>;
+    removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathDelete>;
 }
 import PartnerPlatformApplicationValidator = require("./PartnerPlatformApplicationValidator");
 import PartnerPlatformModel = require("./PartnerPlatformModel");

package/sdk/platform/Partner/PartnerPlatformApplicationClient.js

@@ -19,7 +19,8 @@ class Partner {
    * @param {PartnerPlatformApplicationValidator.AddProxyPathParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
+   * @returns {Promise<PartnerPlatformModel.ExtensionProxyPathCreation>} -
+   *   Success response
    * @name addProxyPath
    * @summary: Create extension proxy
    * @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
@@ -77,10 +78,10 @@ class Partner {
 
     const {
       error: res_error,
-    } = PartnerPlatformModel.AddProxyResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
+    } = PartnerPlatformModel.ExtensionProxyPathCreation().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -100,7 +101,8 @@ class Partner {
    * @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
+   * @returns {Promise<PartnerPlatformModel.ExtensionProxyPathDelete>} -
+   *   Success response
    * @name removeProxyPath
    * @summary: Remove extension proxy
    * @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
@@ -158,7 +160,7 @@ class Partner {
 
     const {
       error: res_error,
-    } = PartnerPlatformModel.RemoveProxyResponse().validate(responseData, {
+    } = PartnerPlatformModel.ExtensionProxyPathDelete().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });

package/sdk/platform/Partner/PartnerPlatformModel.d.ts

@@ -6,7 +6,7 @@ export = PartnerPlatformModel;
  *   will be generated
  */
 /**
- * @typedef AddProxyResponse
+ * @typedef ExtensionProxyPathCreation
  * @property {string} [_id]
  * @property {string} [attached_path]
  * @property {string} [proxy_url]
@@ -17,7 +17,7 @@ export = PartnerPlatformModel;
  * @property {string} [modified_at]
  */
 /**
- * @typedef RemoveProxyResponse
+ * @typedef ExtensionProxyPathDelete
  * @property {string} [message]
  * @property {Object} [data]
  */
@@ -32,7 +32,7 @@ export = PartnerPlatformModel;
 declare class PartnerPlatformModel {
 }
 declare namespace PartnerPlatformModel {
-    export { AddProxyReq, AddProxyResponse, RemoveProxyResponse, APIError };
+    export { AddProxyReq, ExtensionProxyPathCreation, ExtensionProxyPathDelete, APIError };
 }
 /** @returns {AddProxyReq} */
 declare function AddProxyReq(): AddProxyReq;
@@ -47,9 +47,9 @@ type AddProxyReq = {
      */
     proxy_url?: string;
 };
-/** @returns {AddProxyResponse} */
-declare function AddProxyResponse(): AddProxyResponse;
-type AddProxyResponse = {
+/** @returns {ExtensionProxyPathCreation} */
+declare function ExtensionProxyPathCreation(): ExtensionProxyPathCreation;
+type ExtensionProxyPathCreation = {
     _id?: string;
     attached_path?: string;
     proxy_url?: string;
@@ -59,9 +59,9 @@ type AddProxyResponse = {
     created_at?: string;
     modified_at?: string;
 };
-/** @returns {RemoveProxyResponse} */
-declare function RemoveProxyResponse(): RemoveProxyResponse;
-type RemoveProxyResponse = {
+/** @returns {ExtensionProxyPathDelete} */
+declare function ExtensionProxyPathDelete(): ExtensionProxyPathDelete;
+type ExtensionProxyPathDelete = {
     message?: string;
     data?: any;
 };

package/sdk/platform/Partner/PartnerPlatformModel.js

@@ -8,7 +8,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef AddProxyResponse
+ * @typedef ExtensionProxyPathCreation
  * @property {string} [_id]
  * @property {string} [attached_path]
  * @property {string} [proxy_url]
@@ -20,7 +20,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef RemoveProxyResponse
+ * @typedef ExtensionProxyPathDelete
  * @property {string} [message]
  * @property {Object} [data]
  */
@@ -43,8 +43,8 @@ class PartnerPlatformModel {
     });
   }
 
-  /** @returns {AddProxyResponse} */
-  static AddProxyResponse() {
+  /** @returns {ExtensionProxyPathCreation} */
+  static ExtensionProxyPathCreation() {
     return Joi.object({
       _id: Joi.string().allow(""),
       attached_path: Joi.string().allow(""),
@@ -57,11 +57,11 @@ class PartnerPlatformModel {
     });
   }
 
-  /** @returns {RemoveProxyResponse} */
-  static RemoveProxyResponse() {
+  /** @returns {ExtensionProxyPathDelete} */
+  static ExtensionProxyPathDelete() {
     return Joi.object({
       message: Joi.string().allow(""),
-      data: Joi.any(),
+      data: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
@@ -72,7 +72,7 @@ class PartnerPlatformModel {
       message: Joi.string().allow(""),
       info: Joi.string().allow(""),
       request_id: Joi.string().allow(""),
-      meta: Joi.any(),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 }