@gofynd/fdk-client-javascript 1.4.12 → 1.4.14

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

@@ -19,7 +19,7 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef BulkStateTransistionParam
- * @property {OrderPlatformModel.BulkStateTransistionRequest} body
+ * @property {OrderPlatformModel.BulkStateTransistionRequestSchema} body
  */
 /**
  * @typedef CheckOrderStatusParam
@@ -43,7 +43,7 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef DownloadLanesReportParam
- * @property {OrderPlatformModel.BulkReportsDownloadRequest} body
+ * @property {OrderPlatformModel.BulkReportsDownloadRequestSchema} body
  */
 /**
  * @typedef EInvoiceRetryParam
@@ -64,7 +64,7 @@ export = OrderPlatformValidator;
 /**
  * @typedef GenerateInvoiceIDParam
  * @property {string} invoiceType - Mention the type of invoice id to generate
- * @property {OrderPlatformModel.GenerateInvoiceIDRequest} body
+ * @property {OrderPlatformModel.GenerateInvoiceIDRequestSchema} body
  */
 /**
  * @typedef GeneratePOSReceiptByOrderIdParam
@@ -74,7 +74,7 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef GenerateProcessManifestParam
- * @property {OrderPlatformModel.ProcessManifestRequest} body
+ * @property {OrderPlatformModel.ProcessManifestRequestSchema} body
  */
 /**
  * @typedef GetAllowedStateTransitionParam
@@ -110,8 +110,8 @@ export = OrderPlatformValidator;
  * @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
@@ -126,7 +126,7 @@ export = OrderPlatformValidator;
  * @typedef GetFileByStatusParam
  * @property {string} batchId
  * @property {string} status
- * @property {string} fileType
+ * @property {string} fileType - It contains the type of file.
  * @property {string} [reportType]
  */
 /**
@@ -142,15 +142,27 @@ export = OrderPlatformValidator;
  * @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.
  */
 /**
  * @typedef GetManifestDetailsParam
@@ -208,10 +220,10 @@ export = OrderPlatformValidator;
  *   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]
@@ -226,6 +238,11 @@ export = OrderPlatformValidator;
  * @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 */
 /**
@@ -257,8 +274,9 @@ export = OrderPlatformValidator;
  * @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
@@ -285,7 +303,24 @@ export = OrderPlatformValidator;
  *   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.
  */
 /**
  * @typedef GetStateManagerConfigParam
@@ -344,30 +379,24 @@ export = OrderPlatformValidator;
  */
 /**
  * @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
  */
 /**
  * @typedef UpdatePackagingDimensionsParam
  * @property {OrderPlatformModel.UpdatePackagingDimensionsPayload} body
  */
+/**
+ * @typedef UpdatePaymentInfoParam
+ * @property {OrderPlatformModel.UpdateShipmentPaymentMode} body
+ */
 /**
  * @typedef UpdateShipmentLockParam
  * @property {OrderPlatformModel.UpdateShipmentLockPayload} body
  */
 /**
  * @typedef UpdateShipmentStatusParam
- * @property {OrderPlatformModel.UpdateShipmentStatusRequest} body
+ * @property {OrderPlatformModel.UpdateShipmentStatusRequestSchema} body
  */
 /**
  * @typedef UpdateShipmentTrackingParam
@@ -489,6 +518,8 @@ declare class OrderPlatformValidator {
     static updateAddress(): UpdateAddressParam;
     /** @returns {UpdatePackagingDimensionsParam} */
     static updatePackagingDimensions(): UpdatePackagingDimensionsParam;
+    /** @returns {UpdatePaymentInfoParam} */
+    static updatePaymentInfo(): UpdatePaymentInfoParam;
     /** @returns {UpdateShipmentLockParam} */
     static updateShipmentLock(): UpdateShipmentLockParam;
     /** @returns {UpdateShipmentStatusParam} */
@@ -501,7 +532,7 @@ declare class OrderPlatformValidator {
     static verifyMobileOTP(): VerifyMobileOTPParam;
 }
 declare namespace OrderPlatformValidator {
-    export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ProcessManifestsParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
+    export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ProcessManifestsParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdatePaymentInfoParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
 }
 type AddStateManagerConfigParam = {
     body: OrderPlatformModel.TransitionConfigPayload;
@@ -540,7 +571,7 @@ type BulkListingParam = {
     searchKey?: string;
 };
 type BulkStateTransistionParam = {
-    body: OrderPlatformModel.BulkStateTransistionRequest;
+    body: OrderPlatformModel.BulkStateTransistionRequestSchema;
 };
 type CheckOrderStatusParam = {
     body: OrderPlatformModel.OrderStatus;
@@ -561,7 +592,7 @@ type DownloadBulkActionTemplateParam = {
     templateSlug?: string;
 };
 type DownloadLanesReportParam = {
-    body: OrderPlatformModel.BulkReportsDownloadRequest;
+    body: OrderPlatformModel.BulkReportsDownloadRequestSchema;
 };
 type EInvoiceRetryParam = {
     body: OrderPlatformModel.EInvoiceRetry;
@@ -583,7 +614,7 @@ type GenerateInvoiceIDParam = {
      * - Mention the type of invoice id to generate
      */
     invoiceType: string;
-    body: OrderPlatformModel.GenerateInvoiceIDRequest;
+    body: OrderPlatformModel.GenerateInvoiceIDRequestSchema;
 };
 type GeneratePOSReceiptByOrderIdParam = {
     orderId: string;
@@ -591,7 +622,7 @@ type GeneratePOSReceiptByOrderIdParam = {
     documentType?: string;
 };
 type GenerateProcessManifestParam = {
-    body: OrderPlatformModel.ProcessManifestRequest;
+    body: OrderPlatformModel.ProcessManifestRequestSchema;
 };
 type GetAllowedStateTransitionParam = {
     /**
@@ -672,11 +703,11 @@ type GetBulkShipmentExcelFileParam = {
      */
     dpIds?: string;
     /**
-     * - UTC start date in ISO format
+     * - Date time in UTC timezone as per ISO format.
      */
     startDate?: string;
     /**
-     * - UTC end date in ISO format
+     * - Date time in UTC timezone as per ISO format.
      */
     endDate?: string;
     /**
@@ -709,6 +740,9 @@ type GetBulkShipmentExcelFileParam = {
 type GetFileByStatusParam = {
     batchId: string;
     status: string;
+    /**
+     * - It contains the type of file.
+     */
     fileType: string;
     reportType?: string;
 };
@@ -754,9 +788,16 @@ type GetLaneConfigParam = {
      * - Comma separated values of bag statuses
      */
     bagStatus?: string;
+    /**
+     * - Search_type refers to the field that will
+     * be used as the target for the search operation
+     */
     searchType?: string;
     searchValue?: string;
     tags?: string;
+    /**
+     * - Time_to_dispatch refers to estimated SLA time.
+     */
     timeToDispatch?: number;
     paymentMethods?: string;
     myOrders?: boolean;
@@ -765,6 +806,20 @@ type GetLaneConfigParam = {
      * company order
      */
     showCrossCompanyData?: boolean;
+    /**
+     * - 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.
+     */
     orderType?: string;
 };
 type GetManifestDetailsParam = {
@@ -892,9 +947,21 @@ type GetOrdersParam = {
      * specified by the search_type
      */
     searchValue?: string;
+    /**
+     * - Date time in UTC timezone as per ISO format.
+     */
     fromDate?: string;
+    /**
+     * - Date time in UTC timezone as per ISO format.
+     */
     toDate?: string;
+    /**
+     * - Date time in UTC timezone as per ISO format.
+     */
     startDate?: string;
+    /**
+     * - Date time in UTC timezone as per ISO format.
+     */
     endDate?: string;
     /**
      * - Delivery Partner IDs to which shipments are assigned.
@@ -919,6 +986,14 @@ type GetOrdersParam = {
      * shipments are allowed
      */
     allowInactive?: boolean;
+    /**
+     * - 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.
+     */
+    groupEntity?: string;
 };
 type GetShipmentByIdParam = {
     /**
@@ -981,9 +1056,13 @@ type GetShipmentsParam = {
      * bag_status and override lane
      */
     statusOverrideLane?: boolean;
+    /**
+     * - Time_to_dispatch refers to estimated SLA time.
+     */
     timeToDispatch?: number;
     /**
-     * - Search type key
+     * - Search_type refers to the field that will
+     * be used as the target for the search operation
      */
     searchType?: string;
     /**
@@ -1069,7 +1148,29 @@ type GetShipmentsParam = {
      */
     tags?: string;
     customerId?: string;
+    /**
+     * - 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.
+     */
     orderType?: string;
+    /**
+     * - 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.
+     */
+    groupEntity?: string;
 };
 type GetStateManagerConfigParam = {
     /**
@@ -1141,27 +1242,23 @@ type TrackShipmentParam = {
     pageSize?: number;
 };
 type UpdateAddressParam = {
+    /**
+     * - Unique shipment no. that is auto-generated
+     */
     shipmentId: string;
-    name?: string;
-    address?: string;
-    addressType?: string;
-    pincode?: string;
-    phone?: string;
-    email?: string;
-    landmark?: string;
-    addressCategory: string;
-    city?: string;
-    state?: string;
-    country?: string;
+    body: OrderPlatformModel.UpdateAddressRequestBody;
 };
 type UpdatePackagingDimensionsParam = {
     body: OrderPlatformModel.UpdatePackagingDimensionsPayload;
 };
+type UpdatePaymentInfoParam = {
+    body: OrderPlatformModel.UpdateShipmentPaymentMode;
+};
 type UpdateShipmentLockParam = {
     body: OrderPlatformModel.UpdateShipmentLockPayload;
 };
 type UpdateShipmentStatusParam = {
-    body: OrderPlatformModel.UpdateShipmentStatusRequest;
+    body: OrderPlatformModel.UpdateShipmentStatusRequestSchema;
 };
 type UpdateShipmentTrackingParam = {
     body: OrderPlatformModel.CourierPartnerTrackingDetails;