@gofynd/fdk-client-javascript 1.4.6 → 1.4.7

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

@@ -31,7 +31,6 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef DispatchManifestsParam
- * @property {string} manifestId
  * @property {OrderPlatformModel.DispatchManifest} body
  */
 /**
@@ -69,6 +68,10 @@ export = OrderPlatformValidator;
  * @property {string} [shipmentId]
  * @property {string} [documentType]
  */
+/**
+ * @typedef GenerateProcessManifestParam
+ * @property {OrderPlatformModel.ProcessManifestRequest} body
+ */
 /**
  * @typedef GetAllowedStateTransitionParam
  * @property {string} orderingChannel - Ordering channel
@@ -151,16 +154,18 @@ export = OrderPlatformValidator;
  */
 /**
  * @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]
+ * @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 {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 {number} [pageNo] - Page number for pagination.
+ * @property {number} [pageSize] - Number of records per page for pagination.
  */
 /**
  * @typedef GetManifestfiltersParam
@@ -398,6 +403,8 @@ declare class OrderPlatformValidator {
     static generateInvoiceID(): GenerateInvoiceIDParam;
     /** @returns {GeneratePOSReceiptByOrderIdParam} */
     static generatePOSReceiptByOrderId(): GeneratePOSReceiptByOrderIdParam;
+    /** @returns {GenerateProcessManifestParam} */
+    static generateProcessManifest(): GenerateProcessManifestParam;
     /** @returns {GetAllowedStateTransitionParam} */
     static getAllowedStateTransition(): GetAllowedStateTransitionParam;
     /** @returns {GetAllowedTemplatesForBulkParam} */
@@ -480,7 +487,7 @@ declare class OrderPlatformValidator {
     static verifyMobileOTP(): VerifyMobileOTPParam;
 }
 declare namespace OrderPlatformValidator {
-    export { AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ProcessManifestsParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
+    export { AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ProcessManifestsParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
 }
 type AttachOrderUserParam = {
     body: OrderPlatformModel.AttachOrderUser;
@@ -528,7 +535,6 @@ type CreateOrderParam = {
     body: OrderPlatformModel.CreateOrderAPI;
 };
 type DispatchManifestsParam = {
-    manifestId: string;
     body: OrderPlatformModel.DispatchManifest;
 };
 type DownloadBulkActionTemplateParam = {
@@ -567,6 +573,9 @@ type GeneratePOSReceiptByOrderIdParam = {
     shipmentId?: string;
     documentType?: string;
 };
+type GenerateProcessManifestParam = {
+    body: OrderPlatformModel.ProcessManifestRequest;
+};
 type GetAllowedStateTransitionParam = {
     /**
      * - Ordering channel
@@ -745,16 +754,48 @@ type GetManifestDetailsParam = {
     manifestId: string;
 };
 type GetManifestShipmentsParam = {
-    dpIds: number;
-    stores: string;
+    /**
+     * - Filter shipments with the specific Courier partner
+     * Ids which is a combination of courier partner extension and scheme Ids.
+     */
+    dpIds: string;
+    /**
+     * - Filter with the specific store.
+     */
+    stores: number;
+    /**
+     * - End date for the shipment search range.
+     */
     toDate: string;
+    /**
+     * - Start date for the shipment search range.
+     */
     fromDate: string;
+    /**
+     * - Filter with the specific courier partner name.
+     */
     dpName?: string;
+    /**
+     * - Comma-separated list of sales channels.
+     */
     salesChannels?: string;
+    /**
+     * - Type of search (e.g., by shipment ID, order
+     * ID, AWB number).
+     */
     searchType?: string;
+    /**
+     * - Value to search for based on the search type.
+     */
     searchValue?: string;
-    pageNo?: string;
-    pageSize?: string;
+    /**
+     * - Page number for pagination.
+     */
+    pageNo?: number;
+    /**
+     * - Number of records per page for pagination.
+     */
+    pageSize?: number;
 };
 type GetManifestfiltersParam = {
     /**

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -40,7 +40,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef DispatchManifestsParam
- * @property {string} manifestId
  * @property {OrderPlatformModel.DispatchManifest} body
  */
 
@@ -87,6 +86,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} [documentType]
  */
 
+/**
+ * @typedef GenerateProcessManifestParam
+ * @property {OrderPlatformModel.ProcessManifestRequest} body
+ */
+
 /**
  * @typedef GetAllowedStateTransitionParam
  * @property {string} orderingChannel - Ordering channel
@@ -180,16 +184,18 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @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]
+ * @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 {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 {number} [pageNo] - Page number for pagination.
+ * @property {number} [pageSize] - Number of records per page for pagination.
  */
 
 /**
@@ -477,7 +483,6 @@ class OrderPlatformValidator {
   /** @returns {DispatchManifestsParam} */
   static dispatchManifests() {
     return Joi.object({
-      manifestId: Joi.string().allow("").required(),
       body: OrderPlatformModel.DispatchManifest().required(),
     }).required();
   }
@@ -541,6 +546,13 @@ class OrderPlatformValidator {
     }).required();
   }
 
+  /** @returns {GenerateProcessManifestParam} */
+  static generateProcessManifest() {
+    return Joi.object({
+      body: OrderPlatformModel.ProcessManifestRequest().required(),
+    }).required();
+  }
+
   /** @returns {GetAllowedStateTransitionParam} */
   static getAllowedStateTransition() {
     return Joi.object({
@@ -658,16 +670,16 @@ class OrderPlatformValidator {
   /** @returns {GetManifestShipmentsParam} */
   static getManifestShipments() {
     return Joi.object({
-      dpIds: Joi.number().required(),
-      stores: Joi.string().allow("").required(),
+      dpIds: Joi.string().allow("").required(),
+      stores: Joi.number().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(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
     }).required();
   }
 

package/sdk/platform/Payment/PaymentPlatformModel.d.ts

@@ -132,7 +132,7 @@ export = PaymentPlatformModel;
 /**
  * @typedef AggregatorRoute
  * @property {Object} [data] - Data
- * @property {string} [payment_flow_data] - Payment_flow_data
+ * @property {Object} [payment_flow_data] - Payment_flow_data
  * @property {string} [payment_flow] - Payment_flow
  * @property {string} [api_link] - Api_link
  */
@@ -1561,7 +1561,7 @@ type AggregatorRoute = {
     /**
      * - Payment_flow_data
      */
-    payment_flow_data?: string;
+    payment_flow_data?: any;
     /**
      * - Payment_flow
      */

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -148,7 +148,7 @@ const Joi = require("joi");
 /**
  * @typedef AggregatorRoute
  * @property {Object} [data] - Data
- * @property {string} [payment_flow_data] - Payment_flow_data
+ * @property {Object} [payment_flow_data] - Payment_flow_data
  * @property {string} [payment_flow] - Payment_flow
  * @property {string} [api_link] - Api_link
  */
@@ -1500,7 +1500,7 @@ class PaymentPlatformModel {
   static AggregatorRoute() {
     return Joi.object({
       data: Joi.any().allow(null),
-      payment_flow_data: Joi.string().allow("").allow(null),
+      payment_flow_data: Joi.any().allow(null),
       payment_flow: Joi.string().allow("").allow(null),
       api_link: Joi.string().allow("").allow(null),
     });

package/sdk/platform/PlatformApplicationClient.d.ts

@@ -15,6 +15,7 @@ declare class PlatformApplicationClient {
     config: import("./PlatformConfig");
     companyId: string;
     applicationId: string;
+    analytics: Analytics;
     cart: Cart;
     catalog: Catalog;
     communication: Communication;
@@ -38,6 +39,7 @@ declare class PlatformApplicationClient {
      */
     setExtraHeaders(header: object): void;
 }
+import Analytics = require("./Analytics/AnalyticsPlatformApplicationClient");
 import Cart = require("./Cart/CartPlatformApplicationClient");
 import Catalog = require("./Catalog/CatalogPlatformApplicationClient");
 import Communication = require("./Communication/CommunicationPlatformApplicationClient");

package/sdk/platform/PlatformApplicationClient.js

@@ -1,3 +1,5 @@
+const Analytics = require("./Analytics/AnalyticsPlatformApplicationClient");
+
 const Cart = require("./Cart/CartPlatformApplicationClient");
 
 const Catalog = require("./Catalog/CatalogPlatformApplicationClient");
@@ -47,6 +49,8 @@ class PlatformApplicationClient {
     this.companyId = config.companyId;
     this.applicationId = applicationId;
 
+    this.analytics = new Analytics(config, applicationId);
+
     this.cart = new Cart(config, applicationId);
 
     this.catalog = new Catalog(config, applicationId);

package/sdk/platform/Webhook/WebhookPlatformClient.d.ts

@@ -154,6 +154,18 @@ declare class Webhook {
      * @description: Add a subscriber to receive events of a specific type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
      */
     registerSubscriberToEvent({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
+    /**
+     * @param {WebhookPlatformValidator.RegisterSubscriberToEventV2Param} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
+     *   Success response
+     * @name registerSubscriberToEventV2
+     * @summary: Register Subscriber.
+     * @description: Register Subscriber.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEventV2/).
+     */
+    registerSubscriberToEventV2({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventV2Param, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
     /**
      * @param {WebhookPlatformValidator.UpdateSubscriberConfigParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -165,6 +177,18 @@ declare class Webhook {
      * @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
      */
     updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
+    /**
+     * @param {WebhookPlatformValidator.UpdateSubscriberV2Param} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
+     *   Success response
+     * @name updateSubscriberV2
+     * @summary: Update Subscriber.
+     * @description: Update Subscriber.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberV2/).
+     */
+    updateSubscriberV2({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberV2Param, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
 }
 import WebhookPlatformValidator = require("./WebhookPlatformValidator");
 import WebhookPlatformModel = require("./WebhookPlatformModel");

package/sdk/platform/Webhook/WebhookPlatformClient.js

@@ -1206,6 +1206,89 @@ class Webhook {
     return response;
   }
 
+  /**
+   * @param {WebhookPlatformValidator.RegisterSubscriberToEventV2Param} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
+   *   Success response
+   * @name registerSubscriberToEventV2
+   * @summary: Register Subscriber.
+   * @description: Register Subscriber.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEventV2/).
+   */
+  async registerSubscriberToEventV2(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = WebhookPlatformValidator.registerSubscriberToEventV2().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookPlatformValidator.registerSubscriberToEventV2().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Webhook > registerSubscriberToEventV2 \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/webhook/v2.0/company/${this.config.companyId}/subscriber/`,
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = WebhookPlatformModel.SubscriberConfigResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Webhook > registerSubscriberToEventV2 \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {WebhookPlatformValidator.UpdateSubscriberConfigParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1287,6 +1370,87 @@ class Webhook {
 
     return response;
   }
+
+  /**
+   * @param {WebhookPlatformValidator.UpdateSubscriberV2Param} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
+   *   Success response
+   * @name updateSubscriberV2
+   * @summary: Update Subscriber.
+   * @description: Update Subscriber.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberV2/).
+   */
+  async updateSubscriberV2(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = WebhookPlatformValidator.updateSubscriberV2().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookPlatformValidator.updateSubscriberV2().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Webhook > updateSubscriberV2 \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "put",
+      `/service/platform/webhook/v2.0/company/${this.config.companyId}/subscriber/`,
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = WebhookPlatformModel.SubscriberConfigResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Webhook > updateSubscriberV2 \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
 }
 
 module.exports = Webhook;