@gofynd/fdk-client-javascript 1.4.12 → 1.4.13

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -14,18 +14,20 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef BulkListingParam
- * @property {number} pageSize - Page size
- * @property {number} pageNo - Page number
- * @property {string} startDate - UTC start date in ISO format
- * @property {string} endDate - UTC end date in ISO format
- * @property {string} [status] - Status for which to fetch the jobs.
- * @property {string} [bulkActionType] - Job type.
- * @property {string} [searchKey] - Search_key.
+ * @property {number} pageSize - The number of records to return per page in the response.
+ * @property {number} pageNo - The page number to fetch from the paginated results.
+ * @property {string} startDate - The start date for filtering the jobs,
+ *   expressed in UTC format
+ * @property {string} endDate - The end date for filtering the jobs, expressed
+ *   in UTC format
+ * @property {string} [status] - The status of the jobs to filter the results.
+ * @property {string} [bulkActionType] - Pecifies the type of job action being requested.
+ * @property {string} [searchKey] - A key or keyword used to search for specific jobs.
  */
 
 /**
  * @typedef BulkStateTransistionParam
- * @property {OrderPlatformModel.BulkStateTransistionRequest} body
+ * @property {OrderPlatformModel.BulkStateTransistionRequestSchema} body
  */
 
 /**
@@ -33,11 +35,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {OrderPlatformModel.OrderStatus} body
  */
 
-/**
- * @typedef CreateChannelConfigParam
- * @property {OrderPlatformModel.CreateChannelConfigData} body
- */
-
 /**
  * @typedef CreateOrderParam
  * @property {OrderPlatformModel.CreateOrderAPI} body
@@ -68,11 +65,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} logId - Log Error ID
  */
 
-/**
- * @typedef FetchCreditBalanceDetailParam
- * @property {OrderPlatformModel.FetchCreditBalanceRequestPayload} body
- */
-
 /**
  * @typedef FetchRefundModeConfigParam
  * @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
@@ -81,7 +73,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
  */
 
 /**
@@ -98,16 +90,16 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef GetAllowedStateTransitionParam
- * @property {string} orderingChannel - Ordering channel
- * @property {string} status - Current status of a shipment
+ * @property {string} orderingChannel - The channel through which orders are placed.
+ * @property {string} status - The status key indicates the current status for
+ *   which the API will provide a list of possible next state transitions.
  */
 
 /** @typedef GetAllowedTemplatesForBulkParam */
 
 /**
  * @typedef GetAnnouncementsParam
- * @property {string} [date] - Date On which the announcement is Active (Date
- *   should in ISO Datetime format IST Time)
+ * @property {string} [date] - Date On which the announcement is Active.
  */
 
 /**
@@ -148,14 +140,12 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {number} [pageSize]
  */
 
-/** @typedef GetChannelConfigParam */
-
 /**
  * @typedef GetFileByStatusParam
- * @property {string} batchId
- * @property {string} status
- * @property {string} fileType
- * @property {string} [reportType]
+ * @property {string} batchId - Batch Id to identify the bulk operation request.
+ * @property {string} status - The status of the jobs to filter the results.
+ * @property {string} fileType - The type of file to be downloaded.
+ * @property {string} [reportType] - The type of report to be downloaded.
  */
 
 /**
@@ -184,21 +174,27 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef GetManifestDetailsParam
- * @property {string} manifestId
+ * @property {string} manifestId - The unique identifier assigned to the manifest.
+ * @property {string} [dpIds] - Filter shipments with the specific Courier
+ *   partner Ids which is a combination of courier partner extension and scheme Ids.
+ * @property {string} [endDate] - End date for the shipment search range in manifest.
+ * @property {string} [startDate] - Start date for the shipment search range in manifest.
+ * @property {number} [pageNo] - Page number for pagination.
+ * @property {number} [pageSize] - Number of records per page for pagination.
  */
 
 /**
  * @typedef GetManifestShipmentsParam
  * @property {string} dpIds - Filter shipments with the specific Courier partner
  *   Ids which is a combination of courier partner extension and scheme Ids.
- * @property {number} stores - Filter with the specific store.
+ * @property {number} stores - Filter results based on specific store IDs.
  * @property {string} toDate - End date for the shipment search range.
  * @property {string} fromDate - Start date for the shipment search range.
- * @property {string} [dpName] - Filter with the specific courier partner name.
- * @property {string} [salesChannels] - Comma-separated list of sales channels.
- * @property {string} [searchType] - Type of search (e.g., by shipment ID, order
- *   ID, AWB number).
- * @property {string} [searchValue] - Value to search for based on the search type.
+ * @property {string} [dpName] - Filter results based on specific courier partner name.
+ * @property {string} [salesChannels] - Filter results based on comma-separated
+ *   list of sales channels.
+ * @property {string} [searchType] - Filter results based on search type.
+ * @property {string} [searchValue] - Filter results based on the search value.
  * @property {number} [pageNo] - Page number for pagination.
  * @property {number} [pageSize] - Number of records per page for pagination.
  */
@@ -210,16 +206,20 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef GetManifestsParam
- * @property {string} [status] - Possible Status [ active, closed ]
- * @property {string} [startDate] - UTC Start Date in ISO format
- * @property {string} [endDate] - UTC End Date in ISO format
- * @property {string} [searchType] - Search type options [ fynd_order_id,
- *   shipment_id, manifest_id, dp_name, awb_no ]
- * @property {number} [storeId] - Fetch manifests for a Store.
- * @property {string} [searchValue] - Search value for selected search type
- * @property {string} [dpIds] - DP Ids separated by ',' (comma)
- * @property {number} [pageNo]
- * @property {number} [pageSize]
+ * @property {string} [status] - Filter for the status of manifests.
+ * @property {string} [startDate] - The starting date for filtering manifests in
+ *   ISO format
+ * @property {string} [endDate] - The end date for filtering manifests in ISO format
+ * @property {string} [searchType] - Specifies the type of search to perform.
+ * @property {number} [storeId] - Filter to fetch manifests for a specific store
+ *   by its ID.
+ * @property {string} [searchValue] - The value to search for based on the
+ *   selected search type.
+ * @property {string} [dpIds] - A comma-separated list of courier partner IDs
+ *   (DP IDs) to filter the manifests.
+ * @property {number} [pageNo] - The number of the page to fetch data.
+ * @property {number} [pageSize] - The number of records to return per page for
+ *   pagination.
  */
 
 /**
@@ -277,8 +277,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef GetShipmentHistoryParam
- * @property {string} [shipmentId] - Shipment Id
- * @property {number} [bagId] - Bag/Product Id
+ * @property {string} [shipmentId] - Identifier for the shipment
+ * @property {number} [bagId] - Identifier for a bag or product.
  */
 
 /**
@@ -355,7 +355,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef JobDetailsParam
- * @property {string} batchId
+ * @property {string} batchId - A unique identifier for the batch associated
+ *   with this bulk action.
  */
 
 /**
@@ -368,11 +369,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {OrderPlatformModel.PostShipmentHistory} body
  */
 
-/**
- * @typedef ProcessManifestsParam
- * @property {OrderPlatformModel.ProcessManifest} body
- */
-
 /**
  * @typedef ReassignLocationParam
  * @property {OrderPlatformModel.StoreReassign} body
@@ -390,10 +386,10 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef TrackShipmentParam
- * @property {string} [shipmentId] - Shipment ID
+ * @property {string} [shipmentId] - Unique identifier of a shipment on the platform.
  * @property {string} [awb] - AWB number
- * @property {number} [pageNo] - Page number
- * @property {number} [pageSize] - Page size
+ * @property {number} [pageNo] - Page number for pagination.
+ * @property {number} [pageSize] - Number of records per page for pagination.
  */
 
 /**
@@ -424,7 +420,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef UpdateShipmentStatusParam
- * @property {OrderPlatformModel.UpdateShipmentStatusRequest} body
+ * @property {OrderPlatformModel.UpdateShipmentStatusRequestSchema} body
  */
 
 /**
@@ -434,8 +430,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef UploadConsentsParam
- * @property {string} manifestId
- * @property {OrderPlatformModel.UploadConsent} body
+ * @property {OrderPlatformModel.UploadManifestConsent} body
  */
 
 /**
@@ -474,7 +469,7 @@ class OrderPlatformValidator {
   /** @returns {BulkStateTransistionParam} */
   static bulkStateTransistion() {
     return Joi.object({
-      body: OrderPlatformModel.BulkStateTransistionRequest().required(),
+      body: OrderPlatformModel.BulkStateTransistionRequestSchema().required(),
     }).required();
   }
 
@@ -485,13 +480,6 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {CreateChannelConfigParam} */
-  static createChannelConfig() {
-    return Joi.object({
-      body: OrderPlatformModel.CreateChannelConfigData().required(),
-    }).required();
-  }
-
   /** @returns {CreateOrderParam} */
   static createOrder() {
     return Joi.object({
@@ -534,13 +522,6 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {FetchCreditBalanceDetailParam} */
-  static fetchCreditBalanceDetail() {
-    return Joi.object({
-      body: OrderPlatformModel.FetchCreditBalanceRequestPayload().required(),
-    }).required();
-  }
-
   /** @returns {FetchRefundModeConfigParam} */
   static fetchRefundModeConfig() {
     return Joi.object({
@@ -552,7 +533,7 @@ class OrderPlatformValidator {
   static generateInvoiceID() {
     return Joi.object({
       invoiceType: Joi.string().allow("").required(),
-      body: OrderPlatformModel.GenerateInvoiceIDRequest().required(),
+      body: OrderPlatformModel.GenerateInvoiceIDRequestSchema().required(),
     }).required();
   }
 
@@ -639,11 +620,6 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetChannelConfigParam} */
-  static getChannelConfig() {
-    return Joi.object({}).required();
-  }
-
   /** @returns {GetFileByStatusParam} */
   static getFileByStatus() {
     return Joi.object({
@@ -683,6 +659,11 @@ class OrderPlatformValidator {
   static getManifestDetails() {
     return Joi.object({
       manifestId: Joi.string().allow("").required(),
+      dpIds: Joi.string().allow(""),
+      endDate: Joi.string().allow(""),
+      startDate: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
     }).required();
   }
 
@@ -888,13 +869,6 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {ProcessManifestsParam} */
-  static processManifests() {
-    return Joi.object({
-      body: OrderPlatformModel.ProcessManifest().required(),
-    }).required();
-  }
-
   /** @returns {ReassignLocationParam} */
   static reassignLocation() {
     return Joi.object({
@@ -961,7 +935,7 @@ class OrderPlatformValidator {
   /** @returns {UpdateShipmentStatusParam} */
   static updateShipmentStatus() {
     return Joi.object({
-      body: OrderPlatformModel.UpdateShipmentStatusRequest().required(),
+      body: OrderPlatformModel.UpdateShipmentStatusRequestSchema().required(),
     }).required();
   }
 
@@ -975,8 +949,7 @@ class OrderPlatformValidator {
   /** @returns {UploadConsentsParam} */
   static uploadConsents() {
     return Joi.object({
-      manifestId: Joi.string().allow("").required(),
-      body: OrderPlatformModel.UploadConsent().required(),
+      body: OrderPlatformModel.UploadManifestConsent().required(),
     }).required();
   }
 

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"
     );
   }
 }