@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

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

@@ -1,45 +1,45 @@
 export = OrderValidator;
 declare class OrderValidator {
-    static getShipments(): any;
-    static getShipmentById(): any;
-    static getOrderById(): any;
-    static getLaneConfig(): any;
-    static getOrders(): any;
-    static getMetricCount(): any;
-    static getfilters(): any;
+    static bulkActionDetails(): any;
+    static bulkActionProcessXlsxFile(): any;
+    static checkOrderStatus(): any;
+    static click2Call(): any;
+    static createChannelConfig(): any;
+    static createOrder(): any;
     static createShipmentReport(): any;
-    static getReportsShipmentListing(): any;
-    static upsertJioCode(): any;
+    static dispatchManifest(): any;
+    static getAnnouncements(): any;
+    static getBagById(): any;
+    static getBags(): any;
+    static getBulkActionFailedReport(): any;
     static getBulkInvoice(): any;
     static getBulkInvoiceLabel(): any;
-    static getBulkShipmentExcelFile(): any;
     static getBulkList(): any;
-    static getBulkActionFailedReport(): any;
-    static getShipmentReasons(): any;
-    static bulkActionProcessXlsxFile(): any;
-    static bulkActionDetails(): any;
-    static getBagById(): any;
-    static getBags(): any;
-    static invalidateShipmentCache(): any;
-    static reassignLocation(): any;
-    static updateShipmentLock(): any;
-    static getAnnouncements(): any;
-    static updateAddress(): any;
-    static click2Call(): any;
-    static updateShipmentStatus(): any;
-    static processManifest(): any;
-    static dispatchManifest(): any;
+    static getBulkShipmentExcelFile(): any;
+    static getChannelConfig(): any;
+    static getLaneConfig(): any;
+    static getMetricCount(): any;
+    static getOrderById(): any;
+    static getOrders(): any;
+    static getReportsShipmentListing(): any;
     static getRoleBasedActions(): any;
+    static getShipmentById(): any;
     static getShipmentHistory(): any;
+    static getShipmentReasons(): any;
+    static getShipments(): any;
+    static getfilters(): any;
+    static invalidateShipmentCache(): any;
+    static orderUpdate(): any;
+    static platformManualAssignDPToShipment(): any;
     static postShipmentHistory(): any;
+    static processManifest(): any;
+    static reassignLocation(): any;
     static sendSmsNinja(): any;
-    static platformManualAssignDPToShipment(): any;
+    static sendSmsNinjaPlatform(): any;
+    static updateAddress(): any;
     static updatePackagingDimensions(): any;
-    static createOrder(): any;
-    static getChannelConfig(): any;
-    static createChannelConfig(): any;
+    static updateShipmentLock(): any;
+    static updateShipmentStatus(): any;
     static uploadConsent(): any;
-    static orderUpdate(): any;
-    static checkOrderStatus(): any;
-    static sendSmsNinjaPlatform(): any;
+    static upsertJioCode(): any;
 }

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -2,116 +2,91 @@ const Joi = require("joi");
 
 const OrderModel = require("./OrderPlatformModel");
 class OrderValidator {
-  static getShipments() {
+  static bulkActionDetails() {
     return Joi.object({
-      lane: Joi.string().allow(""),
-      bagStatus: Joi.string().allow(""),
-      statusOverrideLane: Joi.boolean(),
-      searchType: Joi.string().allow(""),
-      searchValue: Joi.string().allow(""),
-      searchId: Joi.string().allow(""),
-      fromDate: Joi.string().allow(""),
-      toDate: Joi.string().allow(""),
-      dpIds: Joi.string().allow(""),
-      orderingCompanyId: Joi.string().allow(""),
-      stores: Joi.string().allow(""),
-      salesChannel: Joi.string().allow(""),
-      requestByExt: Joi.string().allow(""),
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      isPrioritySort: Joi.boolean(),
-      fetchActiveShipment: Joi.boolean(),
-      excludeLockedShipments: Joi.boolean(),
-      paymentMethods: Joi.string().allow(""),
-      channelShipmentId: Joi.string().allow(""),
-      channelOrderId: Joi.string().allow(""),
-      customMeta: Joi.string().allow(""),
-      orderingChannel: Joi.string().allow(""),
-      companyAffiliateTag: Joi.string().allow(""),
+      batchId: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getShipmentById() {
+  static bulkActionProcessXlsxFile() {
     return Joi.object({
-      channelShipmentId: Joi.string().allow(""),
-      shipmentId: Joi.string().allow(""),
-      orderingCompanyId: Joi.string().allow(""),
-      requestByExt: Joi.string().allow(""),
+      body: OrderModel.BulkActionPayload().required(),
     }).required();
   }
 
-  static getOrderById() {
+  static checkOrderStatus() {
     return Joi.object({
-      orderId: Joi.string().allow("").required(),
+      body: OrderModel.OrderStatus().required(),
     }).required();
   }
 
-  static getLaneConfig() {
+  static click2Call() {
     return Joi.object({
-      superLane: Joi.string().allow(""),
-      groupEntity: Joi.string().allow(""),
-      fromDate: Joi.string().allow(""),
-      toDate: Joi.string().allow(""),
-      dpIds: Joi.string().allow(""),
-      stores: Joi.string().allow(""),
-      salesChannel: Joi.string().allow(""),
-      paymentMode: Joi.string().allow(""),
-      bagStatus: Joi.string().allow(""),
+      caller: Joi.string().allow("").required(),
+      receiver: Joi.string().allow("").required(),
+      bagId: Joi.string().allow("").required(),
+      callingTo: Joi.string().allow(""),
+      callerId: Joi.string().allow(""),
     }).required();
   }
 
-  static getOrders() {
+  static createChannelConfig() {
     return Joi.object({
-      lane: Joi.string().allow(""),
-      searchType: Joi.string().allow(""),
-      bagStatus: Joi.string().allow(""),
-      timeToDispatch: Joi.string().allow(""),
-      paymentMethods: Joi.string().allow(""),
-      tags: Joi.string().allow(""),
-      searchValue: Joi.string().allow(""),
-      fromDate: Joi.string().allow(""),
-      toDate: Joi.string().allow(""),
-      dpIds: Joi.string().allow(""),
-      stores: Joi.string().allow(""),
-      salesChannel: Joi.string().allow(""),
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      isPrioritySort: Joi.boolean(),
-      customMeta: Joi.string().allow(""),
+      body: OrderModel.CreateChannelConfigData().required(),
     }).required();
   }
 
-  static getMetricCount() {
+  static createOrder() {
+    return Joi.object({
+      body: OrderModel.CreateOrderAPI().required(),
+    }).required();
+  }
+
+  static createShipmentReport() {
     return Joi.object({
       fromDate: Joi.string().allow(""),
       toDate: Joi.string().allow(""),
     }).required();
   }
 
-  static getfilters() {
+  static dispatchManifest() {
     return Joi.object({
-      view: Joi.string().allow("").required(),
-      groupEntity: Joi.string().allow(""),
+      body: OrderModel.DispatchManifest().required(),
     }).required();
   }
 
-  static createShipmentReport() {
+  static getAnnouncements() {
     return Joi.object({
-      fromDate: Joi.string().allow(""),
-      toDate: Joi.string().allow(""),
+      date: Joi.string().allow(""),
     }).required();
   }
 
-  static getReportsShipmentListing() {
+  static getBagById() {
+    return Joi.object({
+      bagId: Joi.string().allow(""),
+      channelBagId: Joi.string().allow(""),
+      channelId: Joi.string().allow(""),
+    }).required();
+  }
+
+  static getBags() {
     return Joi.object({
+      bagIds: Joi.string().allow(""),
+      shipmentIds: Joi.string().allow(""),
+      orderIds: Joi.string().allow(""),
+      channelBagIds: Joi.string().allow(""),
+      channelShipmentIds: Joi.string().allow(""),
+      channelOrderIds: Joi.string().allow(""),
+      channelId: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
     }).required();
   }
 
-  static upsertJioCode() {
+  static getBulkActionFailedReport() {
     return Joi.object({
-      body: OrderModel.JioCodeUpsertPayload().required(),
+      batchId: Joi.string().allow("").required(),
+      reportType: Joi.string().allow(""),
     }).required();
   }
 
@@ -128,7 +103,7 @@ class OrderValidator {
     }).required();
   }
 
-  static getBulkShipmentExcelFile() {
+  static getBulkList() {
     return Joi.object({
       lane: Joi.string().allow(""),
       searchType: Joi.string().allow(""),
@@ -147,7 +122,7 @@ class OrderValidator {
     }).required();
   }
 
-  static getBulkList() {
+  static getBulkShipmentExcelFile() {
     return Joi.object({
       lane: Joi.string().allow(""),
       searchType: Joi.string().allow(""),
@@ -166,138 +141,162 @@ class OrderValidator {
     }).required();
   }
 
-  static getBulkActionFailedReport() {
-    return Joi.object({
-      batchId: Joi.string().allow("").required(),
-      reportType: Joi.string().allow(""),
-    }).required();
+  static getChannelConfig() {
+    return Joi.object({}).required();
   }
 
-  static getShipmentReasons() {
+  static getLaneConfig() {
     return Joi.object({
-      shipmentId: Joi.string().allow("").required(),
-      bagId: Joi.string().allow("").required(),
-      state: Joi.string().allow("").required(),
+      superLane: Joi.string().allow(""),
+      groupEntity: Joi.string().allow(""),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
+      dpIds: Joi.string().allow(""),
+      stores: Joi.string().allow(""),
+      salesChannel: Joi.string().allow(""),
+      paymentMode: Joi.string().allow(""),
+      bagStatus: Joi.string().allow(""),
     }).required();
   }
 
-  static bulkActionProcessXlsxFile() {
+  static getMetricCount() {
     return Joi.object({
-      body: OrderModel.BulkActionPayload().required(),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
     }).required();
   }
 
-  static bulkActionDetails() {
+  static getOrderById() {
     return Joi.object({
-      batchId: Joi.string().allow("").required(),
+      orderId: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getBagById() {
+  static getOrders() {
     return Joi.object({
-      bagId: Joi.string().allow(""),
-      channelBagId: Joi.string().allow(""),
-      channelId: Joi.string().allow(""),
+      lane: Joi.string().allow(""),
+      searchType: Joi.string().allow(""),
+      bagStatus: Joi.string().allow(""),
+      timeToDispatch: Joi.string().allow(""),
+      paymentMethods: Joi.string().allow(""),
+      tags: Joi.string().allow(""),
+      searchValue: Joi.string().allow(""),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
+      dpIds: Joi.string().allow(""),
+      stores: Joi.string().allow(""),
+      salesChannel: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      isPrioritySort: Joi.boolean(),
+      customMeta: Joi.string().allow(""),
     }).required();
   }
 
-  static getBags() {
+  static getReportsShipmentListing() {
     return Joi.object({
-      bagIds: Joi.string().allow(""),
-      shipmentIds: Joi.string().allow(""),
-      orderIds: Joi.string().allow(""),
-      channelBagIds: Joi.string().allow(""),
-      channelShipmentIds: Joi.string().allow(""),
-      channelOrderIds: Joi.string().allow(""),
-      channelId: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
     }).required();
   }
 
-  static invalidateShipmentCache() {
-    return Joi.object({
-      body: OrderModel.InvalidateShipmentCachePayload().required(),
-    }).required();
+  static getRoleBasedActions() {
+    return Joi.object({}).required();
   }
 
-  static reassignLocation() {
+  static getShipmentById() {
     return Joi.object({
-      body: OrderModel.StoreReassign().required(),
+      channelShipmentId: Joi.string().allow(""),
+      shipmentId: Joi.string().allow(""),
+      orderingCompanyId: Joi.string().allow(""),
+      requestByExt: Joi.string().allow(""),
     }).required();
   }
 
-  static updateShipmentLock() {
+  static getShipmentHistory() {
     return Joi.object({
-      body: OrderModel.UpdateShipmentLockPayload().required(),
+      shipmentId: Joi.number(),
+      bagId: Joi.number(),
     }).required();
   }
 
-  static getAnnouncements() {
+  static getShipmentReasons() {
     return Joi.object({
-      date: Joi.string().allow(""),
+      shipmentId: Joi.string().allow("").required(),
+      bagId: Joi.string().allow("").required(),
+      state: Joi.string().allow("").required(),
     }).required();
   }
 
-  static updateAddress() {
+  static getShipments() {
     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(""),
+      lane: Joi.string().allow(""),
+      bagStatus: Joi.string().allow(""),
+      statusOverrideLane: Joi.boolean(),
+      searchType: Joi.string().allow(""),
+      searchValue: Joi.string().allow(""),
+      searchId: Joi.string().allow(""),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
+      dpIds: Joi.string().allow(""),
+      orderingCompanyId: Joi.string().allow(""),
+      stores: Joi.string().allow(""),
+      salesChannel: Joi.string().allow(""),
+      requestByExt: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      isPrioritySort: Joi.boolean(),
+      fetchActiveShipment: Joi.boolean(),
+      excludeLockedShipments: Joi.boolean(),
+      paymentMethods: Joi.string().allow(""),
+      channelShipmentId: Joi.string().allow(""),
+      channelOrderId: Joi.string().allow(""),
+      customMeta: Joi.string().allow(""),
+      orderingChannel: Joi.string().allow(""),
+      companyAffiliateTag: Joi.string().allow(""),
     }).required();
   }
 
-  static click2Call() {
+  static getfilters() {
     return Joi.object({
-      caller: Joi.string().allow("").required(),
-      receiver: Joi.string().allow("").required(),
-      bagId: Joi.string().allow("").required(),
-      callingTo: Joi.string().allow(""),
-      callerId: Joi.string().allow(""),
+      view: Joi.string().allow("").required(),
+      groupEntity: Joi.string().allow(""),
     }).required();
   }
 
-  static updateShipmentStatus() {
+  static invalidateShipmentCache() {
     return Joi.object({
-      body: OrderModel.UpdateShipmentStatusRequest().required(),
+      body: OrderModel.InvalidateShipmentCachePayload().required(),
     }).required();
   }
 
-  static processManifest() {
+  static orderUpdate() {
     return Joi.object({
-      body: OrderModel.CreateOrderPayload().required(),
+      body: OrderModel.PlatformOrderUpdate().required(),
     }).required();
   }
 
-  static dispatchManifest() {
+  static platformManualAssignDPToShipment() {
     return Joi.object({
-      body: OrderModel.DispatchManifest().required(),
+      body: OrderModel.ManualAssignDPToShipment().required(),
     }).required();
   }
 
-  static getRoleBasedActions() {
-    return Joi.object({}).required();
+  static postShipmentHistory() {
+    return Joi.object({
+      body: OrderModel.PostShipmentHistory().required(),
+    }).required();
   }
 
-  static getShipmentHistory() {
+  static processManifest() {
     return Joi.object({
-      shipmentId: Joi.number(),
-      bagId: Joi.number(),
+      body: OrderModel.CreateOrderPayload().required(),
     }).required();
   }
 
-  static postShipmentHistory() {
+  static reassignLocation() {
     return Joi.object({
-      body: OrderModel.PostShipmentHistory().required(),
+      body: OrderModel.StoreReassign().required(),
     }).required();
   }
 
@@ -307,9 +306,24 @@ class OrderValidator {
     }).required();
   }
 
-  static platformManualAssignDPToShipment() {
+  static sendSmsNinjaPlatform() {
+    return Joi.object({}).required();
+  }
+
+  static updateAddress() {
     return Joi.object({
-      body: OrderModel.ManualAssignDPToShipment().required(),
+      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(""),
     }).required();
   }
 
@@ -319,19 +333,15 @@ class OrderValidator {
     }).required();
   }
 
-  static createOrder() {
+  static updateShipmentLock() {
     return Joi.object({
-      body: OrderModel.CreateOrderAPI().required(),
+      body: OrderModel.UpdateShipmentLockPayload().required(),
     }).required();
   }
 
-  static getChannelConfig() {
-    return Joi.object({}).required();
-  }
-
-  static createChannelConfig() {
+  static updateShipmentStatus() {
     return Joi.object({
-      body: OrderModel.CreateChannelConfigData().required(),
+      body: OrderModel.UpdateShipmentStatusRequest().required(),
     }).required();
   }
 
@@ -341,20 +351,11 @@ class OrderValidator {
     }).required();
   }
 
-  static orderUpdate() {
-    return Joi.object({
-      body: OrderModel.PlatformOrderUpdate().required(),
-    }).required();
-  }
-
-  static checkOrderStatus() {
+  static upsertJioCode() {
     return Joi.object({
-      body: OrderModel.OrderStatus().required(),
+      body: OrderModel.JioCodeUpsertPayload().required(),
     }).required();
   }
-
-  static sendSmsNinjaPlatform() {
-    return Joi.object({}).required();
-  }
 }
+
 module.exports = OrderValidator;

package/sdk/platform/Partner/PartnerPlatformApplicationClient.js

@@ -1,9 +1,10 @@
-const Paginator = require("../../common/Paginator");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
 const PartnerValidator = require("./PartnerPlatformApplicationValidator");
 const PartnerModel = require("./PartnerPlatformModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Partner {
   constructor(config, applicationId) {
@@ -141,4 +142,5 @@ class Partner {
     return response;
   }
 }
+
 module.exports = Partner;

package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js

@@ -1,6 +1,6 @@
 const Joi = require("joi");
-const PartnerModel = require("./PartnerPlatformModel");
 
+const PartnerModel = require("./PartnerPlatformModel");
 class PartnerValidator {
   static addProxyPath() {
     return Joi.object({

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

@@ -2,6 +2,6 @@ export = PartnerModel;
 declare class PartnerModel {
     static AddProxyReq(): any;
     static AddProxyResponse(): any;
-    static RemoveProxyResponse(): any;
     static APIError(): any;
+    static RemoveProxyResponse(): any;
 }

package/sdk/platform/Partner/PartnerPlatformModel.js

@@ -4,50 +4,34 @@ class PartnerModel {
   static AddProxyReq() {
     return Joi.object({
       attached_path: Joi.string().allow(""),
-
       proxy_url: Joi.string().allow(""),
     });
   }
-
   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(""),
-
-      application_id: Joi.string().allow(""),
-
-      extension_id: Joi.string().allow(""),
-
       created_at: Joi.string().allow(""),
-
+      extension_id: Joi.string().allow(""),
       modified_at: Joi.string().allow(""),
+      proxy_url: Joi.string().allow(""),
     });
   }
-
-  static RemoveProxyResponse() {
+  static APIError() {
     return Joi.object({
+      code: Joi.string().allow(""),
+      info: Joi.string().allow(""),
       message: Joi.string().allow(""),
-
-      data: Joi.any(),
+      meta: Joi.any(),
+      request_id: Joi.string().allow(""),
     });
   }
-
-  static APIError() {
+  static RemoveProxyResponse() {
     return Joi.object({
-      code: Joi.string().allow(""),
-
+      data: Joi.any(),
       message: Joi.string().allow(""),
-
-      info: Joi.string().allow(""),
-
-      request_id: Joi.string().allow(""),
-
-      meta: Joi.any(),
     });
   }
 }