@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

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

@@ -31,6 +31,14 @@ export = OrderPlatformValidator;
  * @typedef DownloadBulkActionTemplateParam
  * @property {string} [templateSlug] - Slug name of template to be downloaded
  */
+/**
+ * @typedef DownloadLanesReportParam
+ * @property {OrderPlatformModel.BulkReportsDownloadRequest} body
+ */
+/**
+ * @typedef EInvoiceRetryParam
+ * @property {OrderPlatformModel.EInvoiceRetry} body
+ */
 /**
  * @typedef FetchCreditBalanceDetailParam
  * @property {OrderPlatformModel.FetchCreditBalanceRequestPayload} body
@@ -45,6 +53,11 @@ export = OrderPlatformValidator;
  * @property {string} [shipmentId]
  * @property {string} [documentType]
  */
+/**
+ * @typedef GetAllowedStateTransitionParam
+ * @property {string} orderingChannel - Ordering channel
+ * @property {string} status - Current status of a shipment
+ */
 /**
  * @typedef GetAnnouncementsParam
  * @property {string} [date] - Date On which the announcement is Active (Date
@@ -102,6 +115,8 @@ export = OrderPlatformValidator;
  * @property {string} [timeToDispatch]
  * @property {string} [paymentMethods]
  * @property {boolean} [myOrders]
+ * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
+ *   company order
  */
 /**
  * @typedef GetOrderByIdParam
@@ -131,6 +146,9 @@ export = OrderPlatformValidator;
  * @property {boolean} [isPrioritySort]
  * @property {string} [customMeta]
  * @property {boolean} [myOrders]
+ * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
+ *   company order
+ * @property {string} [customerId]
  */
 /** @typedef GetRoleBasedActionsParam */
 /**
@@ -158,7 +176,7 @@ 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 {string} [timeToDispatch]
+ * @property {number} [timeToDispatch]
  * @property {string} [searchType] - Search type key
  * @property {string} [searchValue] - Search type value
  * @property {string} [fromDate] - Start Date in DD-MM-YYYY format
@@ -178,7 +196,11 @@ export = OrderPlatformValidator;
  * @property {string} [companyAffiliateTag]
  * @property {boolean} [myOrders]
  * @property {string} [platformUserId]
+ * @property {string} [sortType] - Sort the result data on basis of input
+ * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
+ *   company order
  * @property {string} [tags] - Comma separated values of tags
+ * @property {string} [customerId]
  */
 /** @typedef GetStateTransitionMapParam */
 /**
@@ -214,6 +236,13 @@ export = OrderPlatformValidator;
  * @typedef SendUserMobileOTPParam
  * @property {OrderPlatformModel.SendUserMobileOTP} body
  */
+/**
+ * @typedef TrackShipmentParam
+ * @property {string} [shipmentId] - Shipment ID
+ * @property {string} [awb] - AWB number
+ * @property {number} [pageNo] - Page number
+ * @property {number} [pageSize] - Page size
+ */
 /**
  * @typedef UpdateAddressParam
  * @property {string} shipmentId
@@ -241,6 +270,10 @@ export = OrderPlatformValidator;
  * @typedef UpdateShipmentStatusParam
  * @property {OrderPlatformModel.UpdateShipmentStatusRequest} body
  */
+/**
+ * @typedef UpdateShipmentTrackingParam
+ * @property {OrderPlatformModel.CourierPartnerTrackingDetails} body
+ */
 /**
  * @typedef UploadConsentParam
  * @property {OrderPlatformModel.UploadConsent} body
@@ -264,12 +297,18 @@ declare class OrderPlatformValidator {
     static dispatchManifest(): DispatchManifestParam;
     /** @returns {DownloadBulkActionTemplateParam} */
     static downloadBulkActionTemplate(): DownloadBulkActionTemplateParam;
+    /** @returns {DownloadLanesReportParam} */
+    static downloadLanesReport(): DownloadLanesReportParam;
+    /** @returns {EInvoiceRetryParam} */
+    static eInvoiceRetry(): EInvoiceRetryParam;
     /** @returns {FetchCreditBalanceDetailParam} */
     static fetchCreditBalanceDetail(): FetchCreditBalanceDetailParam;
     /** @returns {FetchRefundModeConfigParam} */
     static fetchRefundModeConfig(): FetchRefundModeConfigParam;
     /** @returns {GeneratePOSReceiptByOrderIdParam} */
     static generatePOSReceiptByOrderId(): GeneratePOSReceiptByOrderIdParam;
+    /** @returns {GetAllowedStateTransitionParam} */
+    static getAllowedStateTransition(): GetAllowedStateTransitionParam;
     /** @returns {GetAnnouncementsParam} */
     static getAnnouncements(): GetAnnouncementsParam;
     /** @returns {GetBagByIdParam} */
@@ -316,6 +355,8 @@ declare class OrderPlatformValidator {
     static sendSmsNinja(): SendSmsNinjaParam;
     /** @returns {SendUserMobileOTPParam} */
     static sendUserMobileOTP(): SendUserMobileOTPParam;
+    /** @returns {TrackShipmentParam} */
+    static trackShipment(): TrackShipmentParam;
     /** @returns {UpdateAddressParam} */
     static updateAddress(): UpdateAddressParam;
     /** @returns {UpdatePackagingDimensionsParam} */
@@ -324,13 +365,15 @@ declare class OrderPlatformValidator {
     static updateShipmentLock(): UpdateShipmentLockParam;
     /** @returns {UpdateShipmentStatusParam} */
     static updateShipmentStatus(): UpdateShipmentStatusParam;
+    /** @returns {UpdateShipmentTrackingParam} */
+    static updateShipmentTracking(): UpdateShipmentTrackingParam;
     /** @returns {UploadConsentParam} */
     static uploadConsent(): UploadConsentParam;
     /** @returns {VerifyMobileOTPParam} */
     static verifyMobileOTP(): VerifyMobileOTPParam;
 }
 declare namespace OrderPlatformValidator {
-    export { AttachOrderUserParam, CheckOrderStatusParam, Click2CallParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestParam, DownloadBulkActionTemplateParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GeneratePOSReceiptByOrderIdParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetLaneConfigParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateTransitionMapParam, GetfiltersParam, InvalidateShipmentCacheParam, OrderUpdateParam, PostShipmentHistoryParam, ProcessManifestParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UploadConsentParam, VerifyMobileOTPParam };
+    export { AttachOrderUserParam, CheckOrderStatusParam, Click2CallParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GeneratePOSReceiptByOrderIdParam, GetAllowedStateTransitionParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetLaneConfigParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateTransitionMapParam, GetfiltersParam, InvalidateShipmentCacheParam, OrderUpdateParam, PostShipmentHistoryParam, ProcessManifestParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentParam, VerifyMobileOTPParam };
 }
 type AttachOrderUserParam = {
     body: OrderPlatformModel.AttachOrderUser;
@@ -375,6 +418,12 @@ type DownloadBulkActionTemplateParam = {
      */
     templateSlug?: string;
 };
+type DownloadLanesReportParam = {
+    body: OrderPlatformModel.BulkReportsDownloadRequest;
+};
+type EInvoiceRetryParam = {
+    body: OrderPlatformModel.EInvoiceRetry;
+};
 type FetchCreditBalanceDetailParam = {
     body: OrderPlatformModel.FetchCreditBalanceRequestPayload;
 };
@@ -386,6 +435,16 @@ type GeneratePOSReceiptByOrderIdParam = {
     shipmentId?: string;
     documentType?: string;
 };
+type GetAllowedStateTransitionParam = {
+    /**
+     * - Ordering channel
+     */
+    orderingChannel: string;
+    /**
+     * - Current status of a shipment
+     */
+    status: string;
+};
 type GetAnnouncementsParam = {
     /**
      * - Date On which the announcement is Active (Date
@@ -529,6 +588,11 @@ type GetLaneConfigParam = {
     timeToDispatch?: string;
     paymentMethods?: string;
     myOrders?: boolean;
+    /**
+     * - Flag to view cross & non-cross
+     * company order
+     */
+    showCrossCompanyData?: boolean;
 };
 type GetOrderByIdParam = {
     orderId: string;
@@ -577,6 +641,12 @@ type GetOrdersParam = {
     isPrioritySort?: boolean;
     customMeta?: string;
     myOrders?: boolean;
+    /**
+     * - Flag to view cross & non-cross
+     * company order
+     */
+    showCrossCompanyData?: boolean;
+    customerId?: string;
 };
 type GetShipmentByIdParam = {
     /**
@@ -629,7 +699,7 @@ type GetShipmentsParam = {
      * bag_status and override lane
      */
     statusOverrideLane?: boolean;
-    timeToDispatch?: string;
+    timeToDispatch?: number;
     /**
      * - Search type key
      */
@@ -691,10 +761,20 @@ type GetShipmentsParam = {
     companyAffiliateTag?: string;
     myOrders?: boolean;
     platformUserId?: string;
+    /**
+     * - Sort the result data on basis of input
+     */
+    sortType?: string;
+    /**
+     * - Flag to view cross & non-cross
+     * company order
+     */
+    showCrossCompanyData?: boolean;
     /**
      * - Comma separated values of tags
      */
     tags?: string;
+    customerId?: string;
 };
 type GetfiltersParam = {
     /**
@@ -727,6 +807,24 @@ type SendSmsNinjaParam = {
 type SendUserMobileOTPParam = {
     body: OrderPlatformModel.SendUserMobileOTP;
 };
+type TrackShipmentParam = {
+    /**
+     * - Shipment ID
+     */
+    shipmentId?: string;
+    /**
+     * - AWB number
+     */
+    awb?: string;
+    /**
+     * - Page number
+     */
+    pageNo?: number;
+    /**
+     * - Page size
+     */
+    pageSize?: number;
+};
 type UpdateAddressParam = {
     shipmentId: string;
     name?: string;
@@ -750,6 +848,9 @@ type UpdateShipmentLockParam = {
 type UpdateShipmentStatusParam = {
     body: OrderPlatformModel.UpdateShipmentStatusRequest;
 };
+type UpdateShipmentTrackingParam = {
+    body: OrderPlatformModel.CourierPartnerTrackingDetails;
+};
 type UploadConsentParam = {
     body: OrderPlatformModel.UploadConsent;
 };

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -41,6 +41,16 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} [templateSlug] - Slug name of template to be downloaded
  */
 
+/**
+ * @typedef DownloadLanesReportParam
+ * @property {OrderPlatformModel.BulkReportsDownloadRequest} body
+ */
+
+/**
+ * @typedef EInvoiceRetryParam
+ * @property {OrderPlatformModel.EInvoiceRetry} body
+ */
+
 /**
  * @typedef FetchCreditBalanceDetailParam
  * @property {OrderPlatformModel.FetchCreditBalanceRequestPayload} body
@@ -58,6 +68,12 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} [documentType]
  */
 
+/**
+ * @typedef GetAllowedStateTransitionParam
+ * @property {string} orderingChannel - Ordering channel
+ * @property {string} status - Current status of a shipment
+ */
+
 /**
  * @typedef GetAnnouncementsParam
  * @property {string} [date] - Date On which the announcement is Active (Date
@@ -121,6 +137,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} [timeToDispatch]
  * @property {string} [paymentMethods]
  * @property {boolean} [myOrders]
+ * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
+ *   company order
  */
 
 /**
@@ -152,6 +170,9 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {boolean} [isPrioritySort]
  * @property {string} [customMeta]
  * @property {boolean} [myOrders]
+ * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
+ *   company order
+ * @property {string} [customerId]
  */
 
 /** @typedef GetRoleBasedActionsParam */
@@ -184,7 +205,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} [bagStatus] - Comma separated values of bag statuses
  * @property {boolean} [statusOverrideLane] - Use this flag to fetch by
  *   bag_status and override lane
- * @property {string} [timeToDispatch]
+ * @property {number} [timeToDispatch]
  * @property {string} [searchType] - Search type key
  * @property {string} [searchValue] - Search type value
  * @property {string} [fromDate] - Start Date in DD-MM-YYYY format
@@ -204,7 +225,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} [companyAffiliateTag]
  * @property {boolean} [myOrders]
  * @property {string} [platformUserId]
+ * @property {string} [sortType] - Sort the result data on basis of input
+ * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
+ *   company order
  * @property {string} [tags] - Comma separated values of tags
+ * @property {string} [customerId]
  */
 
 /** @typedef GetStateTransitionMapParam */
@@ -250,6 +275,14 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {OrderPlatformModel.SendUserMobileOTP} body
  */
 
+/**
+ * @typedef TrackShipmentParam
+ * @property {string} [shipmentId] - Shipment ID
+ * @property {string} [awb] - AWB number
+ * @property {number} [pageNo] - Page number
+ * @property {number} [pageSize] - Page size
+ */
+
 /**
  * @typedef UpdateAddressParam
  * @property {string} shipmentId
@@ -281,6 +314,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {OrderPlatformModel.UpdateShipmentStatusRequest} body
  */
 
+/**
+ * @typedef UpdateShipmentTrackingParam
+ * @property {OrderPlatformModel.CourierPartnerTrackingDetails} body
+ */
+
 /**
  * @typedef UploadConsentParam
  * @property {OrderPlatformModel.UploadConsent} body
@@ -345,6 +383,20 @@ class OrderPlatformValidator {
     }).required();
   }
 
+  /** @returns {DownloadLanesReportParam} */
+  static downloadLanesReport() {
+    return Joi.object({
+      body: OrderPlatformModel.BulkReportsDownloadRequest().required(),
+    }).required();
+  }
+
+  /** @returns {EInvoiceRetryParam} */
+  static eInvoiceRetry() {
+    return Joi.object({
+      body: OrderPlatformModel.EInvoiceRetry().required(),
+    }).required();
+  }
+
   /** @returns {FetchCreditBalanceDetailParam} */
   static fetchCreditBalanceDetail() {
     return Joi.object({
@@ -368,6 +420,14 @@ class OrderPlatformValidator {
     }).required();
   }
 
+  /** @returns {GetAllowedStateTransitionParam} */
+  static getAllowedStateTransition() {
+    return Joi.object({
+      orderingChannel: Joi.string().allow("").required(),
+      status: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GetAnnouncementsParam} */
   static getAnnouncements() {
     return Joi.object({
@@ -445,6 +505,7 @@ class OrderPlatformValidator {
       timeToDispatch: Joi.string().allow(""),
       paymentMethods: Joi.string().allow(""),
       myOrders: Joi.boolean(),
+      showCrossCompanyData: Joi.boolean(),
     }).required();
   }
 
@@ -475,6 +536,8 @@ class OrderPlatformValidator {
       isPrioritySort: Joi.boolean(),
       customMeta: Joi.string().allow(""),
       myOrders: Joi.boolean(),
+      showCrossCompanyData: Joi.boolean(),
+      customerId: Joi.string().allow(""),
     }).required();
   }
 
@@ -514,7 +577,7 @@ class OrderPlatformValidator {
       lane: Joi.string().allow(""),
       bagStatus: Joi.string().allow(""),
       statusOverrideLane: Joi.boolean(),
-      timeToDispatch: Joi.string().allow(""),
+      timeToDispatch: Joi.number(),
       searchType: Joi.string().allow(""),
       searchValue: Joi.string().allow(""),
       fromDate: Joi.string().allow(""),
@@ -534,7 +597,10 @@ class OrderPlatformValidator {
       companyAffiliateTag: Joi.string().allow(""),
       myOrders: Joi.boolean(),
       platformUserId: Joi.string().allow(""),
+      sortType: Joi.string().allow(""),
+      showCrossCompanyData: Joi.boolean(),
       tags: Joi.string().allow(""),
+      customerId: Joi.string().allow(""),
     }).required();
   }
 
@@ -600,6 +666,16 @@ class OrderPlatformValidator {
     }).required();
   }
 
+  /** @returns {TrackShipmentParam} */
+  static trackShipment() {
+    return Joi.object({
+      shipmentId: Joi.string().allow(""),
+      awb: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+    }).required();
+  }
+
   /** @returns {UpdateAddressParam} */
   static updateAddress() {
     return Joi.object({
@@ -639,6 +715,13 @@ class OrderPlatformValidator {
     }).required();
   }
 
+  /** @returns {UpdateShipmentTrackingParam} */
+  static updateShipmentTracking() {
+    return Joi.object({
+      body: OrderPlatformModel.CourierPartnerTrackingDetails().required(),
+    }).required();
+  }
+
   /** @returns {UploadConsentParam} */
   static uploadConsent() {
     return Joi.object({

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

@@ -5,42 +5,24 @@ declare class Partner {
     applicationId: any;
     /**
      * @param {PartnerPlatformApplicationValidator.AddProxyPathParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
      * @name addProxyPath
      * @summary: Create proxy URL for the external URL
      * @description: Use this API to generate proxy URL for the external URL - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
      */
-    addProxyPath({ extensionId, body }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { headers }?: import("../PlatformAPIClient").Options): Promise<PartnerPlatformModel.AddProxyResponse>;
-    /**
-     * @param {PartnerPlatformApplicationValidator.GetProxyPathParam} arg - Arg object
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PartnerPlatformModel.getProxyPathRes>} - Success response
-     * @name getProxyPath
-     * @summary: Proxy
-     * @description: Use this API to get proxy url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/getProxyPath/).
-     */
-    getProxyPath({ extensionId }?: PartnerPlatformApplicationValidator.GetProxyPathParam, { headers }?: import("../PlatformAPIClient").Options): Promise<PartnerPlatformModel.getProxyPathRes>;
-    /**
-     * @param {PartnerPlatformApplicationValidator.GetProxyPathAttachedPathParam} arg
-     *   - Arg object
-     *
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
-     * @name getProxyPathAttachedPath
-     * @summary: Proxy
-     * @description: Use this API to get proxy url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/getProxyPathAttachedPath/).
-     */
-    getProxyPathAttachedPath({ extensionId, attachedPath }?: PartnerPlatformApplicationValidator.GetProxyPathAttachedPathParam, { headers }?: import("../PlatformAPIClient").Options): Promise<PartnerPlatformModel.AddProxyResponse>;
+    addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.AddProxyResponse>;
     /**
      * @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
      * @name removeProxyPath
      * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
      */
-    removeProxyPath({ extensionId, attachedPath }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { headers }?: import("../PlatformAPIClient").Options): Promise<PartnerPlatformModel.RemoveProxyResponse>;
+    removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.RemoveProxyResponse>;
 }
 import PartnerPlatformApplicationValidator = require("./PartnerPlatformApplicationValidator");
 import PartnerPlatformModel = require("./PartnerPlatformModel");