@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/sdk/application/Communication/CommunicationApplicationClient.js

@@ -2,8 +2,8 @@ const ApplicationAPIClient = require("../ApplicationAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
-const CommunicationValidator = require("./CommunicationApplicationValidator");
-const CommunicationModel = require("./CommunicationApplicationModel");
+const CommunicationApplicationValidator = require("./CommunicationApplicationValidator");
+const CommunicationApplicationModel = require("./CommunicationApplicationModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -34,13 +34,24 @@ class Communication {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @returns {Promise<CommunicationConsent>} - Success response
+   * @param {CommunicationApplicationValidator.GetCommunicationConsentParam} arg
+   *   - Arg object.
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<CommunicationApplicationModel.CommunicationConsent>} -
+   *   Success response
+   * @name getCommunicationConsent
    * @summary: Get communication consent
-   * @description: Use this API to retrieve the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp.
+   * @description: Use this API to retrieve the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCommunicationConsent/).
    */
-  async getCommunicationConsent({} = {}) {
-    const { error } = CommunicationValidator.getCommunicationConsent().validate(
+  async getCommunicationConsent(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = CommunicationApplicationValidator.getCommunicationConsent().validate(
       {},
       { abortEarly: false, allowUnknown: true }
     );
@@ -51,16 +62,15 @@ class Communication {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = CommunicationValidator.getCommunicationConsent().validate(
+    } = CommunicationApplicationValidator.getCommunicationConsent().validate(
       {},
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getCommunicationConsent",
+        message: `Parameter Validation warrnings for application > Communication > getCommunicationConsent \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -76,36 +86,49 @@ class Communication {
       }),
       query_params,
       undefined,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CommunicationModel.CommunicationConsent().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = CommunicationApplicationModel.CommunicationConsent().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getCommunicationConsent",
+        message: `Response Validation Warnnings for application > Communication > getCommunicationConsent \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {PushtokenReq} arg.body
-   * @returns {Promise<PushtokenRes>} - Success response
+   * @param {CommunicationApplicationValidator.UpsertAppPushtokenParam} arg -
+   *   Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<CommunicationApplicationModel.PushtokenRes>} - Success response
+   * @name upsertAppPushtoken
    * @summary: Upsert push token of a user
-   * @description: Use this API to update and insert the push token of the user.
+   * @description: Use this API to update and insert the push token of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertAppPushtoken/).
    */
-  async upsertAppPushtoken({ body } = {}) {
-    const { error } = CommunicationValidator.upsertAppPushtoken().validate(
+  async upsertAppPushtoken(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = CommunicationApplicationValidator.upsertAppPushtoken().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -116,16 +139,15 @@ class Communication {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = CommunicationValidator.upsertAppPushtoken().validate(
+    } = CommunicationApplicationValidator.upsertAppPushtoken().validate(
       { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for upsertAppPushtoken",
+        message: `Parameter Validation warrnings for application > Communication > upsertAppPushtoken \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -141,12 +163,18 @@ class Communication {
       }),
       query_params,
       body,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CommunicationModel.PushtokenRes().validate(response, {
+    } = CommunicationApplicationModel.PushtokenRes().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -154,25 +182,33 @@ class Communication {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for upsertAppPushtoken",
+        message: `Response Validation Warnnings for application > Communication > upsertAppPushtoken \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {CommunicationConsentReq} arg.body
-   * @returns {Promise<CommunicationConsentRes>} - Success response
+   * @param {CommunicationApplicationValidator.UpsertCommunicationConsentParam} arg
+   *   - Arg object.
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<CommunicationApplicationModel.CommunicationConsentRes>}
+   *   - Success response
+   *
+   * @name upsertCommunicationConsent
    * @summary: Upsert communication consent
-   * @description: Use this API to update and insert the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp.
+   * @description: Use this API to update and insert the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCommunicationConsent/).
    */
-  async upsertCommunicationConsent({ body } = {}) {
+  async upsertCommunicationConsent(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const {
       error,
-    } = CommunicationValidator.upsertCommunicationConsent().validate(
+    } = CommunicationApplicationValidator.upsertCommunicationConsent().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -183,17 +219,15 @@ class Communication {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = CommunicationValidator.upsertCommunicationConsent().validate(
+    } = CommunicationApplicationValidator.upsertCommunicationConsent().validate(
       { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message:
-          "Parameter Validation warrnings for upsertCommunicationConsent",
+        message: `Parameter Validation warrnings for application > Communication > upsertCommunicationConsent \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -209,22 +243,27 @@ class Communication {
       }),
       query_params,
       body,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CommunicationModel.CommunicationConsentRes().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = CommunicationApplicationModel.CommunicationConsentRes().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for upsertCommunicationConsent",
+        message: `Response Validation Warnnings for application > Communication > upsertCommunicationConsent \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;

package/sdk/application/Communication/CommunicationApplicationModel.d.ts

@@ -1,15 +1,158 @@
-export = CommunicationModel;
-declare class CommunicationModel {
-    static BadRequestSchema(): any;
-    static CommunicationConsent(): any;
-    static CommunicationConsentChannels(): any;
-    static CommunicationConsentChannelsEmail(): any;
-    static CommunicationConsentChannelsSms(): any;
-    static CommunicationConsentChannelsWhatsapp(): any;
-    static CommunicationConsentReq(): any;
-    static CommunicationConsentRes(): any;
-    static NotFound(): any;
-    static Page(): any;
-    static PushtokenReq(): any;
-    static PushtokenRes(): any;
+export = CommunicationApplicationModel;
+/**
+ * @typedef BadRequestSchema
+ * @property {string} [message] - Failure message.
+ * @property {string} [status] - Response status.
+ */
+/**
+ * @typedef CommunicationConsent
+ * @property {string} [app_id]
+ * @property {CommunicationConsentChannels} [channels]
+ * @property {string} [user_id]
+ */
+/**
+ * @typedef CommunicationConsentChannels
+ * @property {CommunicationConsentChannelsEmail} [email]
+ * @property {CommunicationConsentChannelsSms} [sms]
+ * @property {CommunicationConsentChannelsWhatsapp} [whatsapp]
+ */
+/**
+ * @typedef CommunicationConsentChannelsEmail
+ * @property {string} [display_name]
+ * @property {string} [response]
+ */
+/**
+ * @typedef CommunicationConsentChannelsSms
+ * @property {string} [display_name]
+ * @property {string} [response]
+ */
+/**
+ * @typedef CommunicationConsentChannelsWhatsapp
+ * @property {string} [country_code]
+ * @property {string} [display_name]
+ * @property {string} [phone_number]
+ * @property {string} [response]
+ */
+/**
+ * @typedef CommunicationConsentReq
+ * @property {string} [action]
+ * @property {string} [channel]
+ * @property {string} [response]
+ */
+/**
+ * @typedef CommunicationConsentRes
+ * @property {string} [app_id]
+ * @property {CommunicationConsentChannels} [channels]
+ * @property {string} [user_id]
+ */
+/**
+ * @typedef PushtokenReq
+ * @property {string} [action]
+ * @property {string} [bundle_identifier]
+ * @property {string} [push_token]
+ * @property {string} [type]
+ * @property {string} [unique_device_id]
+ */
+/**
+ * @typedef PushtokenRes
+ * @property {string} [_id]
+ * @property {string} [application_id]
+ * @property {string} [bundle_identifier]
+ * @property {string} [created_at]
+ * @property {string} [expired_at]
+ * @property {string} [platform]
+ * @property {string} [push_token]
+ * @property {string} [type]
+ * @property {string} [unique_device_id]
+ * @property {string} [updated_at]
+ * @property {string} [user_id]
+ */
+declare class CommunicationApplicationModel {
 }
+declare namespace CommunicationApplicationModel {
+    export { BadRequestSchema, CommunicationConsent, CommunicationConsentChannels, CommunicationConsentChannelsEmail, CommunicationConsentChannelsSms, CommunicationConsentChannelsWhatsapp, CommunicationConsentReq, CommunicationConsentRes, PushtokenReq, PushtokenRes };
+}
+/** @returns {BadRequestSchema} */
+declare function BadRequestSchema(): BadRequestSchema;
+type BadRequestSchema = {
+    /**
+     * - Failure message.
+     */
+    message?: string;
+    /**
+     * - Response status.
+     */
+    status?: string;
+};
+/** @returns {CommunicationConsent} */
+declare function CommunicationConsent(): CommunicationConsent;
+type CommunicationConsent = {
+    app_id?: string;
+    channels?: CommunicationConsentChannels;
+    user_id?: string;
+};
+/** @returns {CommunicationConsentChannels} */
+declare function CommunicationConsentChannels(): CommunicationConsentChannels;
+type CommunicationConsentChannels = {
+    email?: CommunicationConsentChannelsEmail;
+    sms?: CommunicationConsentChannelsSms;
+    whatsapp?: CommunicationConsentChannelsWhatsapp;
+};
+/** @returns {CommunicationConsentChannelsEmail} */
+declare function CommunicationConsentChannelsEmail(): CommunicationConsentChannelsEmail;
+type CommunicationConsentChannelsEmail = {
+    display_name?: string;
+    response?: string;
+};
+/** @returns {CommunicationConsentChannelsSms} */
+declare function CommunicationConsentChannelsSms(): CommunicationConsentChannelsSms;
+type CommunicationConsentChannelsSms = {
+    display_name?: string;
+    response?: string;
+};
+/** @returns {CommunicationConsentChannelsWhatsapp} */
+declare function CommunicationConsentChannelsWhatsapp(): CommunicationConsentChannelsWhatsapp;
+type CommunicationConsentChannelsWhatsapp = {
+    country_code?: string;
+    display_name?: string;
+    phone_number?: string;
+    response?: string;
+};
+/** @returns {CommunicationConsentReq} */
+declare function CommunicationConsentReq(): CommunicationConsentReq;
+type CommunicationConsentReq = {
+    action?: string;
+    channel?: string;
+    response?: string;
+};
+/** @returns {CommunicationConsentRes} */
+declare function CommunicationConsentRes(): CommunicationConsentRes;
+type CommunicationConsentRes = {
+    app_id?: string;
+    channels?: CommunicationConsentChannels;
+    user_id?: string;
+};
+/** @returns {PushtokenReq} */
+declare function PushtokenReq(): PushtokenReq;
+type PushtokenReq = {
+    action?: string;
+    bundle_identifier?: string;
+    push_token?: string;
+    type?: string;
+    unique_device_id?: string;
+};
+/** @returns {PushtokenRes} */
+declare function PushtokenRes(): PushtokenRes;
+type PushtokenRes = {
+    _id?: string;
+    application_id?: string;
+    bundle_identifier?: string;
+    created_at?: string;
+    expired_at?: string;
+    platform?: string;
+    push_token?: string;
+    type?: string;
+    unique_device_id?: string;
+    updated_at?: string;
+    user_id?: string;
+};

package/sdk/application/Communication/CommunicationApplicationModel.js

@@ -1,38 +1,127 @@
 const Joi = require("joi");
 
-class CommunicationModel {
+/**
+ * @typedef BadRequestSchema
+ * @property {string} [message] - Failure message.
+ * @property {string} [status] - Response status.
+ */
+
+/**
+ * @typedef CommunicationConsent
+ * @property {string} [app_id]
+ * @property {CommunicationConsentChannels} [channels]
+ * @property {string} [user_id]
+ */
+
+/**
+ * @typedef CommunicationConsentChannels
+ * @property {CommunicationConsentChannelsEmail} [email]
+ * @property {CommunicationConsentChannelsSms} [sms]
+ * @property {CommunicationConsentChannelsWhatsapp} [whatsapp]
+ */
+
+/**
+ * @typedef CommunicationConsentChannelsEmail
+ * @property {string} [display_name]
+ * @property {string} [response]
+ */
+
+/**
+ * @typedef CommunicationConsentChannelsSms
+ * @property {string} [display_name]
+ * @property {string} [response]
+ */
+
+/**
+ * @typedef CommunicationConsentChannelsWhatsapp
+ * @property {string} [country_code]
+ * @property {string} [display_name]
+ * @property {string} [phone_number]
+ * @property {string} [response]
+ */
+
+/**
+ * @typedef CommunicationConsentReq
+ * @property {string} [action]
+ * @property {string} [channel]
+ * @property {string} [response]
+ */
+
+/**
+ * @typedef CommunicationConsentRes
+ * @property {string} [app_id]
+ * @property {CommunicationConsentChannels} [channels]
+ * @property {string} [user_id]
+ */
+
+/**
+ * @typedef PushtokenReq
+ * @property {string} [action]
+ * @property {string} [bundle_identifier]
+ * @property {string} [push_token]
+ * @property {string} [type]
+ * @property {string} [unique_device_id]
+ */
+
+/**
+ * @typedef PushtokenRes
+ * @property {string} [_id]
+ * @property {string} [application_id]
+ * @property {string} [bundle_identifier]
+ * @property {string} [created_at]
+ * @property {string} [expired_at]
+ * @property {string} [platform]
+ * @property {string} [push_token]
+ * @property {string} [type]
+ * @property {string} [unique_device_id]
+ * @property {string} [updated_at]
+ * @property {string} [user_id]
+ */
+
+class CommunicationApplicationModel {
+  /** @returns {BadRequestSchema} */
   static BadRequestSchema() {
     return Joi.object({
       message: Joi.string().allow(""),
       status: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CommunicationConsent} */
   static CommunicationConsent() {
     return Joi.object({
       app_id: Joi.string().allow(""),
-      channels: CommunicationModel.CommunicationConsentChannels(),
+      channels: CommunicationApplicationModel.CommunicationConsentChannels(),
       user_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CommunicationConsentChannels} */
   static CommunicationConsentChannels() {
     return Joi.object({
-      email: CommunicationModel.CommunicationConsentChannelsEmail(),
-      sms: CommunicationModel.CommunicationConsentChannelsSms(),
-      whatsapp: CommunicationModel.CommunicationConsentChannelsWhatsapp(),
+      email: CommunicationApplicationModel.CommunicationConsentChannelsEmail(),
+      sms: CommunicationApplicationModel.CommunicationConsentChannelsSms(),
+      whatsapp: CommunicationApplicationModel.CommunicationConsentChannelsWhatsapp(),
     });
   }
+
+  /** @returns {CommunicationConsentChannelsEmail} */
   static CommunicationConsentChannelsEmail() {
     return Joi.object({
       display_name: Joi.string().allow(""),
       response: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CommunicationConsentChannelsSms} */
   static CommunicationConsentChannelsSms() {
     return Joi.object({
       display_name: Joi.string().allow(""),
       response: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CommunicationConsentChannelsWhatsapp} */
   static CommunicationConsentChannelsWhatsapp() {
     return Joi.object({
       country_code: Joi.string().allow(""),
@@ -41,6 +130,8 @@ class CommunicationModel {
       response: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CommunicationConsentReq} */
   static CommunicationConsentReq() {
     return Joi.object({
       action: Joi.string().allow(""),
@@ -48,29 +139,17 @@ class CommunicationModel {
       response: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CommunicationConsentRes} */
   static CommunicationConsentRes() {
     return Joi.object({
       app_id: Joi.string().allow(""),
-      channels: CommunicationModel.CommunicationConsentChannels(),
+      channels: CommunicationApplicationModel.CommunicationConsentChannels(),
       user_id: Joi.string().allow(""),
     });
   }
-  static NotFound() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-    });
-  }
-  static Page() {
-    return Joi.object({
-      current: Joi.number(),
-      has_next: Joi.boolean(),
-      has_previous: Joi.boolean(),
-      item_total: Joi.number(),
-      next_id: Joi.string().allow(""),
-      size: Joi.number(),
-      type: Joi.string().allow("").required(),
-    });
-  }
+
+  /** @returns {PushtokenReq} */
   static PushtokenReq() {
     return Joi.object({
       action: Joi.string().allow(""),
@@ -80,6 +159,8 @@ class CommunicationModel {
       unique_device_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {PushtokenRes} */
   static PushtokenRes() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -96,4 +177,4 @@ class CommunicationModel {
     });
   }
 }
-module.exports = CommunicationModel;
+module.exports = CommunicationApplicationModel;

package/sdk/application/Communication/CommunicationApplicationValidator.d.ts

@@ -1,6 +1,29 @@
-export = CommunicationValidator;
-declare class CommunicationValidator {
+export = CommunicationApplicationValidator;
+/** @typedef GetCommunicationConsentParam */
+/**
+ * @typedef UpsertAppPushtokenParam
+ * @property {CommunicationApplicationModel.PushtokenReq} body
+ */
+/**
+ * @typedef UpsertCommunicationConsentParam
+ * @property {CommunicationApplicationModel.CommunicationConsentReq} body
+ */
+declare class CommunicationApplicationValidator {
+    /** @returns {GetCommunicationConsentParam} */
     static getCommunicationConsent(): any;
-    static upsertAppPushtoken(): any;
-    static upsertCommunicationConsent(): any;
+    /** @returns {UpsertAppPushtokenParam} */
+    static upsertAppPushtoken(): UpsertAppPushtokenParam;
+    /** @returns {UpsertCommunicationConsentParam} */
+    static upsertCommunicationConsent(): UpsertCommunicationConsentParam;
 }
+declare namespace CommunicationApplicationValidator {
+    export { GetCommunicationConsentParam, UpsertAppPushtokenParam, UpsertCommunicationConsentParam };
+}
+type UpsertAppPushtokenParam = {
+    body: CommunicationApplicationModel.PushtokenReq;
+};
+type UpsertCommunicationConsentParam = {
+    body: CommunicationApplicationModel.CommunicationConsentReq;
+};
+type GetCommunicationConsentParam = any;
+import CommunicationApplicationModel = require("./CommunicationApplicationModel");