@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/sdk/platform/Communication/CommunicationPlatformClient.d.ts

@@ -2,16 +2,30 @@ export = Communication;
 declare class Communication {
     constructor(config: any);
     config: any;
+    /**
+     * @param {CommunicationPlatformValidator.GetSystemNotificationsParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CommunicationPlatformModel.SystemNotifications>} -
+     *   Success response
+     * @name getSystemNotifications
+     * @summary: Get system notifications
+     * @description: Get system notifications - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
+     */
+    getSystemNotifications({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformValidator.GetSystemNotificationsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemNotifications>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageNo] -
      * @param {number} [arg.pageSize] -
-     * @returns {Promise<SystemNotifications>} - Success response
+     * @returns {Paginator<CommunicationPlatformModel.SystemNotifications>}
      * @summary: Get system notifications
      * @description: Get system notifications
      */
-    getSystemNotifications({ pageNo, pageSize }?: {
-        pageNo?: number;
+    getSystemNotificationsPaginator({ pageSize }?: {
         pageSize?: number;
-    }): Promise<SystemNotifications>;
+    }): Paginator<CommunicationPlatformModel.SystemNotifications>;
 }
+import CommunicationPlatformValidator = require("./CommunicationPlatformValidator");
+import CommunicationPlatformModel = require("./CommunicationPlatformModel");
+import Paginator = require("../../common/Paginator");

package/sdk/platform/Communication/CommunicationPlatformClient.js

@@ -1,8 +1,8 @@
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const Paginator = require("../../common/Paginator");
-const CommunicationValidator = require("./CommunicationPlatformValidator");
-const CommunicationModel = require("./CommunicationPlatformModel");
+const CommunicationPlatformValidator = require("./CommunicationPlatformValidator");
+const CommunicationPlatformModel = require("./CommunicationPlatformModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -12,15 +12,24 @@ class Communication {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {number} [arg.pageNo] -
-   * @param {number} [arg.pageSize] -
-   * @returns {Promise<SystemNotifications>} - Success response
+   * @param {CommunicationPlatformValidator.GetSystemNotificationsParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CommunicationPlatformModel.SystemNotifications>} -
+   *   Success response
+   * @name getSystemNotifications
    * @summary: Get system notifications
-   * @description: Get system notifications
+   * @description: Get system notifications - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
    */
-  async getSystemNotifications({ pageNo, pageSize } = {}) {
-    const { error } = CommunicationValidator.getSystemNotifications().validate(
+  async getSystemNotifications(
+    { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = CommunicationPlatformValidator.getSystemNotifications().validate(
       {
         pageNo,
         pageSize,
@@ -34,7 +43,7 @@ class Communication {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = CommunicationValidator.getSystemNotifications().validate(
+    } = CommunicationPlatformValidator.getSystemNotifications().validate(
       {
         pageNo,
         pageSize,
@@ -44,9 +53,8 @@ class Communication {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getSystemNotifications",
+        message: `Parameter Validation warrnings for platform > Communication > getSystemNotifications \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -61,26 +69,58 @@ class Communication {
       `/service/platform/communication/v1.0/company/${this.config.companyId}/notification/system-notifications/`,
       query_params,
       undefined,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CommunicationModel.SystemNotifications().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = CommunicationPlatformModel.SystemNotifications().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getSystemNotifications",
+        message: `Response Validation Warnnings for platform > Communication > getSystemNotifications \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageSize] -
+   * @returns {Paginator<CommunicationPlatformModel.SystemNotifications>}
+   * @summary: Get system notifications
+   * @description: Get system notifications
+   */
+  getSystemNotificationsPaginator({ pageSize } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getSystemNotifications({
+        pageNo: pageNo,
+        pageSize: pageSize,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
 }
 
 module.exports = Communication;