@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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,111 +2,91 @@ const Joi = require("joi");
 
 const OrderModel = require("./OrderPlatformModel");
 class OrderValidator {
-  static getShipments() {
+  static bulkActionDetails() {
     return Joi.object({
-      lane: Joi.string().allow(""),
-      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(),
-      excludeLockedShipments: Joi.boolean(),
-      paymentMethods: Joi.string().allow(""),
-      channelShipmentId: Joi.string().allow(""),
-      channelOrderId: Joi.string().allow(""),
-      customMeta: 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();
   }
 
@@ -123,7 +103,7 @@ class OrderValidator {
     }).required();
   }
 
-  static getBulkShipmentExcelFile() {
+  static getBulkList() {
     return Joi.object({
       lane: Joi.string().allow(""),
       searchType: Joi.string().allow(""),
@@ -142,7 +122,7 @@ class OrderValidator {
     }).required();
   }
 
-  static getBulkList() {
+  static getBulkShipmentExcelFile() {
     return Joi.object({
       lane: Joi.string().allow(""),
       searchType: Joi.string().allow(""),
@@ -161,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();
   }
 
@@ -302,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();
   }
 
@@ -314,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();
   }
 
@@ -336,20 +351,10 @@ 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.d.ts

@@ -8,23 +8,25 @@ declare class Partner {
      * @param {string} arg.extensionId - Extension id for which proxy URL will
      *   be generated
      * @param {AddProxyReq} arg.body
+     * @returns {Promise<AddProxyResponse>} - Success response
      * @summary: Create proxy URL for the external URL
      * @description: Use this API to generate proxy URL for the external URL
      */
     addProxyPath({ extensionId, body }?: {
         extensionId: string;
         body: AddProxyReq;
-    }): Promise<any>;
+    }): Promise<AddProxyResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.extensionId - Extension id for which proxy URL needs
      *   to be removed
      * @param {string} arg.attachedPath - Attachaed path slug
+     * @returns {Promise<RemoveProxyResponse>} - Success response
      * @summary: Remove proxy URL for the external URL
      * @description: Use this API to remove the proxy URL which is already generated for the external URL
      */
     removeProxyPath({ extensionId, attachedPath }?: {
         extensionId: string;
         attachedPath: string;
-    }): Promise<any>;
+    }): Promise<RemoveProxyResponse>;
 }