@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -7,22 +7,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {OrderPlatformModel.AttachOrderUser} body
  */
 
-/**
- * @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.
- */
-
-/**
- * @typedef BulkStateTransistionParam
- * @property {OrderPlatformModel.BulkStateTransistionRequest} body
- */
-
 /**
  * @typedef CheckOrderStatusParam
  * @property {OrderPlatformModel.OrderStatus} body
@@ -48,8 +32,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  */
 
 /**
- * @typedef DispatchManifestsParam
- * @property {string} manifestId
+ * @typedef DispatchManifestParam
  * @property {OrderPlatformModel.DispatchManifest} body
  */
 
@@ -68,11 +51,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {OrderPlatformModel.EInvoiceRetry} body
  */
 
-/**
- * @typedef FailedOrderLogDetailsParam
- * @property {string} logId - Log Error ID
- */
-
 /**
  * @typedef FetchCreditBalanceDetailParam
  * @property {OrderPlatformModel.FetchCreditBalanceRequestPayload} body
@@ -102,8 +80,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} status - Current status of a shipment
  */
 
-/** @typedef GetAllowedTemplatesForBulkParam */
-
 /**
  * @typedef GetAnnouncementsParam
  * @property {string} [date] - Date On which the announcement is Active (Date
@@ -136,8 +112,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} [fromDate] - Start Date in DD-MM-YYYY format
+ * @property {string} [toDate] - End Date in DD-MM-YYYY 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
@@ -150,22 +126,12 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /** @typedef GetChannelConfigParam */
 
-/**
- * @typedef GetFileByStatusParam
- * @property {string} batchId
- * @property {string} status
- * @property {string} fileType
- * @property {string} [reportType]
- */
-
 /**
  * @typedef GetLaneConfigParam
  * @property {string} [superLane] - Name of lane for which data is to be fetched
  * @property {string} [groupEntity] - Name of group entity
  * @property {string} [fromDate] - Start Date in DD-MM-YYYY format
  * @property {string} [toDate] - End Date in DD-MM-YYYY format
- * @property {string} [startDate] - UTC Start Date in ISO format
- * @property {string} [endDate] - UTC End Date in ISO format
  * @property {string} [dpIds] - Comma separated values of delivery partner ids
  * @property {string} [stores] - Comma separated values of store ids
  * @property {string} [salesChannels]
@@ -182,49 +148,10 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} [orderType]
  */
 
-/**
- * @typedef GetManifestDetailsParam
- * @property {string} manifestId
- */
-
-/**
- * @typedef GetManifestShipmentsParam
- * @property {number} dpIds
- * @property {string} stores
- * @property {string} toDate
- * @property {string} fromDate
- * @property {string} [dpName]
- * @property {string} [salesChannels]
- * @property {string} [searchType]
- * @property {string} [searchValue]
- * @property {string} [pageNo]
- * @property {string} [pageSize]
- */
-
-/**
- * @typedef GetManifestfiltersParam
- * @property {string} view - Name of View
- */
-
-/**
- * @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]
- */
-
 /**
  * @typedef GetOrderByIdParam
  * @property {string} orderId
  * @property {boolean} [myOrders]
- * @property {boolean} [allowInactive] - Flag to allow inactive shipments
  */
 
 /**
@@ -243,8 +170,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  *   specified by the search_type
  * @property {string} [fromDate]
  * @property {string} [toDate]
- * @property {string} [startDate]
- * @property {string} [endDate]
  * @property {string} [dpIds] - Delivery Partner IDs to which shipments are assigned.
  * @property {string} [stores]
  * @property {string} [salesChannels]
@@ -265,8 +190,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @typedef GetShipmentByIdParam
  * @property {string} [channelShipmentId] - App Shipment Id
  * @property {string} [shipmentId] - Shipment Id
- * @property {boolean} [fetchActiveShipment] - Flag to fetch active or
- *   deactivated shipments
  */
 
 /**
@@ -296,8 +219,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @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
- * @property {string} [startDate] - UTC Start Date in ISO format
- * @property {string} [endDate] - UTC End Date in ISO format
  * @property {string} [dpIds] - Comma separated values of delivery partner ids
  * @property {string} [stores] - Comma separated values of store ids
  * @property {string} [salesChannels] - Comma separated values of sales channel ids
@@ -324,11 +245,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /** @typedef GetStateTransitionMapParam */
 
-/**
- * @typedef GetTemplateParam
- * @property {string} templateName
- */
-
 /**
  * @typedef GetfiltersParam
  * @property {string} view - Name of view
@@ -340,11 +256,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {OrderPlatformModel.InvalidateShipmentCachePayload} body
  */
 
-/**
- * @typedef JobDetailsParam
- * @property {string} batchId
- */
-
 /**
  * @typedef OrderUpdateParam
  * @property {OrderPlatformModel.PlatformOrderUpdate} body
@@ -356,8 +267,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  */
 
 /**
- * @typedef ProcessManifestsParam
- * @property {OrderPlatformModel.ProcessManifest} body
+ * @typedef ProcessManifestParam
+ * @property {OrderPlatformModel.CreateOrderPayload} body
  */
 
 /**
@@ -420,8 +331,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  */
 
 /**
- * @typedef UploadConsentsParam
- * @property {string} manifestId
+ * @typedef UploadConsentParam
  * @property {OrderPlatformModel.UploadConsent} body
  */
 
@@ -438,26 +348,6 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {BulkListingParam} */
-  static bulkListing() {
-    return Joi.object({
-      pageSize: Joi.number().required(),
-      pageNo: Joi.number().required(),
-      startDate: Joi.string().allow("").required(),
-      endDate: Joi.string().allow("").required(),
-      status: Joi.string().allow(""),
-      bulkActionType: Joi.string().allow(""),
-      searchKey: Joi.string().allow(""),
-    }).required();
-  }
-
-  /** @returns {BulkStateTransistionParam} */
-  static bulkStateTransistion() {
-    return Joi.object({
-      body: OrderPlatformModel.BulkStateTransistionRequest().required(),
-    }).required();
-  }
-
   /** @returns {CheckOrderStatusParam} */
   static checkOrderStatus() {
     return Joi.object({
@@ -490,10 +380,9 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {DispatchManifestsParam} */
-  static dispatchManifests() {
+  /** @returns {DispatchManifestParam} */
+  static dispatchManifest() {
     return Joi.object({
-      manifestId: Joi.string().allow("").required(),
       body: OrderPlatformModel.DispatchManifest().required(),
     }).required();
   }
@@ -519,13 +408,6 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {FailedOrderLogDetailsParam} */
-  static failedOrderLogDetails() {
-    return Joi.object({
-      logId: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {FetchCreditBalanceDetailParam} */
   static fetchCreditBalanceDetail() {
     return Joi.object({
@@ -565,11 +447,6 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetAllowedTemplatesForBulkParam} */
-  static getAllowedTemplatesForBulk() {
-    return Joi.object({}).required();
-  }
-
   /** @returns {GetAnnouncementsParam} */
   static getAnnouncements() {
     return Joi.object({
@@ -611,8 +488,8 @@ class OrderPlatformValidator {
     return Joi.object({
       salesChannels: Joi.string().allow(""),
       dpIds: Joi.string().allow(""),
-      startDate: Joi.string().allow(""),
-      endDate: Joi.string().allow(""),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
       stores: Joi.string().allow(""),
       tags: Joi.string().allow(""),
       bagStatus: Joi.string().allow(""),
@@ -629,16 +506,6 @@ class OrderPlatformValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetFileByStatusParam} */
-  static getFileByStatus() {
-    return Joi.object({
-      batchId: Joi.string().allow("").required(),
-      status: Joi.string().allow("").required(),
-      fileType: Joi.string().allow("").required(),
-      reportType: Joi.string().allow(""),
-    }).required();
-  }
-
   /** @returns {GetLaneConfigParam} */
   static getLaneConfig() {
     return Joi.object({
@@ -646,8 +513,6 @@ class OrderPlatformValidator {
       groupEntity: Joi.string().allow(""),
       fromDate: Joi.string().allow(""),
       toDate: Joi.string().allow(""),
-      startDate: Joi.string().allow(""),
-      endDate: Joi.string().allow(""),
       dpIds: Joi.string().allow(""),
       stores: Joi.string().allow(""),
       salesChannels: Joi.string().allow(""),
@@ -664,57 +529,11 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetManifestDetailsParam} */
-  static getManifestDetails() {
-    return Joi.object({
-      manifestId: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetManifestShipmentsParam} */
-  static getManifestShipments() {
-    return Joi.object({
-      dpIds: Joi.number().required(),
-      stores: Joi.string().allow("").required(),
-      toDate: Joi.string().allow("").required(),
-      fromDate: Joi.string().allow("").required(),
-      dpName: Joi.string().allow(""),
-      salesChannels: Joi.string().allow(""),
-      searchType: Joi.string().allow(""),
-      searchValue: Joi.string().allow(""),
-      pageNo: Joi.string().allow(""),
-      pageSize: Joi.string().allow(""),
-    }).required();
-  }
-
-  /** @returns {GetManifestfiltersParam} */
-  static getManifestfilters() {
-    return Joi.object({
-      view: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetManifestsParam} */
-  static getManifests() {
-    return Joi.object({
-      status: Joi.string().allow(""),
-      startDate: Joi.string().allow(""),
-      endDate: Joi.string().allow(""),
-      searchType: Joi.string().allow(""),
-      storeId: Joi.number(),
-      searchValue: Joi.string().allow(""),
-      dpIds: Joi.string().allow(""),
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-    }).required();
-  }
-
   /** @returns {GetOrderByIdParam} */
   static getOrderById() {
     return Joi.object({
       orderId: Joi.string().allow("").required(),
       myOrders: Joi.boolean(),
-      allowInactive: Joi.boolean(),
     }).required();
   }
 
@@ -730,8 +549,6 @@ class OrderPlatformValidator {
       searchValue: Joi.string().allow(""),
       fromDate: Joi.string().allow(""),
       toDate: Joi.string().allow(""),
-      startDate: Joi.string().allow(""),
-      endDate: Joi.string().allow(""),
       dpIds: Joi.string().allow(""),
       stores: Joi.string().allow(""),
       salesChannels: Joi.string().allow(""),
@@ -756,7 +573,6 @@ class OrderPlatformValidator {
     return Joi.object({
       channelShipmentId: Joi.string().allow(""),
       shipmentId: Joi.string().allow(""),
-      fetchActiveShipment: Joi.boolean(),
     }).required();
   }
 
@@ -788,8 +604,6 @@ class OrderPlatformValidator {
       searchValue: Joi.string().allow(""),
       fromDate: Joi.string().allow(""),
       toDate: Joi.string().allow(""),
-      startDate: Joi.string().allow(""),
-      endDate: Joi.string().allow(""),
       dpIds: Joi.string().allow(""),
       stores: Joi.string().allow(""),
       salesChannels: Joi.string().allow(""),
@@ -819,13 +633,6 @@ class OrderPlatformValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetTemplateParam} */
-  static getTemplate() {
-    return Joi.object({
-      templateName: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {GetfiltersParam} */
   static getfilters() {
     return Joi.object({
@@ -841,13 +648,6 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {JobDetailsParam} */
-  static jobDetails() {
-    return Joi.object({
-      batchId: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {OrderUpdateParam} */
   static orderUpdate() {
     return Joi.object({
@@ -862,10 +662,10 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {ProcessManifestsParam} */
-  static processManifests() {
+  /** @returns {ProcessManifestParam} */
+  static processManifest() {
     return Joi.object({
-      body: OrderPlatformModel.ProcessManifest().required(),
+      body: OrderPlatformModel.CreateOrderPayload().required(),
     }).required();
   }
 
@@ -946,10 +746,9 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {UploadConsentsParam} */
-  static uploadConsents() {
+  /** @returns {UploadConsentParam} */
+  static uploadConsent() {
     return Joi.object({
-      manifestId: Joi.string().allow("").required(),
       body: OrderPlatformModel.UploadConsent().required(),
     }).required();
   }

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

@@ -8,31 +8,31 @@ export = PartnerPlatformModel;
 /**
  * @typedef AddProxyResponse
  * @property {string} [_id]
- * @property {string} [application_id]
  * @property {string} [attached_path]
+ * @property {string} [proxy_url]
  * @property {string} [company_id]
- * @property {string} [created_at]
+ * @property {string} [application_id]
  * @property {string} [extension_id]
+ * @property {string} [created_at]
  * @property {string} [modified_at]
- * @property {string} [proxy_url]
  */
 /**
- * @typedef APIError
- * @property {string} [code]
- * @property {string} [info] - Error code description link
+ * @typedef RemoveProxyResponse
  * @property {string} [message]
- * @property {Object} [meta]
- * @property {string} [request_id]
+ * @property {Object} [data]
  */
 /**
- * @typedef RemoveProxyResponse
- * @property {Object} [data]
+ * @typedef APIError
+ * @property {string} [code]
  * @property {string} [message]
+ * @property {string} [info] - Error code description link
+ * @property {string} [request_id]
+ * @property {Object} [meta]
  */
 declare class PartnerPlatformModel {
 }
 declare namespace PartnerPlatformModel {
-    export { AddProxyReq, AddProxyResponse, APIError, RemoveProxyResponse };
+    export { AddProxyReq, AddProxyResponse, RemoveProxyResponse, APIError };
 }
 /** @returns {AddProxyReq} */
 declare function AddProxyReq(): AddProxyReq;
@@ -51,29 +51,29 @@ type AddProxyReq = {
 declare function AddProxyResponse(): AddProxyResponse;
 type AddProxyResponse = {
     _id?: string;
-    application_id?: string;
     attached_path?: string;
+    proxy_url?: string;
     company_id?: string;
-    created_at?: string;
+    application_id?: string;
     extension_id?: string;
+    created_at?: string;
     modified_at?: string;
-    proxy_url?: string;
+};
+/** @returns {RemoveProxyResponse} */
+declare function RemoveProxyResponse(): RemoveProxyResponse;
+type RemoveProxyResponse = {
+    message?: string;
+    data?: any;
 };
 /** @returns {APIError} */
 declare function APIError(): APIError;
 type APIError = {
     code?: string;
+    message?: string;
     /**
      * - Error code description link
      */
     info?: string;
-    message?: string;
-    meta?: any;
     request_id?: string;
-};
-/** @returns {RemoveProxyResponse} */
-declare function RemoveProxyResponse(): RemoveProxyResponse;
-type RemoveProxyResponse = {
-    data?: any;
-    message?: string;
+    meta?: any;
 };

package/sdk/platform/Partner/PartnerPlatformModel.js

@@ -10,28 +10,28 @@ const Joi = require("joi");
 /**
  * @typedef AddProxyResponse
  * @property {string} [_id]
- * @property {string} [application_id]
  * @property {string} [attached_path]
+ * @property {string} [proxy_url]
  * @property {string} [company_id]
- * @property {string} [created_at]
+ * @property {string} [application_id]
  * @property {string} [extension_id]
+ * @property {string} [created_at]
  * @property {string} [modified_at]
- * @property {string} [proxy_url]
  */
 
 /**
- * @typedef APIError
- * @property {string} [code]
- * @property {string} [info] - Error code description link
+ * @typedef RemoveProxyResponse
  * @property {string} [message]
- * @property {Object} [meta]
- * @property {string} [request_id]
+ * @property {Object} [data]
  */
 
 /**
- * @typedef RemoveProxyResponse
- * @property {Object} [data]
+ * @typedef APIError
+ * @property {string} [code]
  * @property {string} [message]
+ * @property {string} [info] - Error code description link
+ * @property {string} [request_id]
+ * @property {Object} [meta]
  */
 
 class PartnerPlatformModel {
@@ -47,32 +47,32 @@ class PartnerPlatformModel {
   static AddProxyResponse() {
     return Joi.object({
       _id: Joi.string().allow(""),
-      application_id: Joi.string().allow(""),
       attached_path: Joi.string().allow(""),
+      proxy_url: Joi.string().allow(""),
       company_id: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
+      application_id: Joi.string().allow(""),
       extension_id: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
       modified_at: Joi.string().allow(""),
-      proxy_url: Joi.string().allow(""),
     });
   }
 
-  /** @returns {APIError} */
-  static APIError() {
+  /** @returns {RemoveProxyResponse} */
+  static RemoveProxyResponse() {
     return Joi.object({
-      code: Joi.string().allow(""),
-      info: Joi.string().allow(""),
       message: Joi.string().allow(""),
-      meta: Joi.any(),
-      request_id: Joi.string().allow(""),
+      data: Joi.any(),
     });
   }
 
-  /** @returns {RemoveProxyResponse} */
-  static RemoveProxyResponse() {
+  /** @returns {APIError} */
+  static APIError() {
     return Joi.object({
-      data: Joi.any(),
+      code: Joi.string().allow(""),
       message: Joi.string().allow(""),
+      info: Joi.string().allow(""),
+      request_id: Joi.string().allow(""),
+      meta: Joi.any(),
     });
   }
 }