@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/public/Webhook/WebhookPublicModel.js

@@ -1,6 +1,130 @@
 const Joi = require("joi");
 
-class WebhookModel {
+/**
+ * @typedef Association
+ * @property {string[]} [application_id]
+ * @property {number} [company_id]
+ * @property {string} [criteria]
+ * @property {string} [extension_id]
+ */
+
+/**
+ * @typedef AuthMeta
+ * @property {string} [secret]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef EventConfig
+ * @property {string} [created_on]
+ * @property {string} [description]
+ * @property {string} [display_name]
+ * @property {string} [event_category]
+ * @property {string} [event_name]
+ * @property {string} [event_type]
+ * @property {number} [id]
+ * @property {string} [version]
+ */
+
+/**
+ * @typedef EventConfigBase
+ * @property {string} [event_category]
+ * @property {string} [event_name]
+ * @property {string} [event_type]
+ * @property {string} [version]
+ */
+
+/**
+ * @typedef EventConfigList
+ * @property {EventConfig[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef EventConfigResponse
+ * @property {EventConfig[]} [event_configs]
+ */
+
+/**
+ * @typedef EventPayload
+ * @property {string} [event_name]
+ * @property {string} [event_trace_id]
+ * @property {string} [event_type]
+ * @property {number} [id]
+ * @property {string} [message_id]
+ * @property {boolean} [status]
+ * @property {string} [version]
+ */
+
+/**
+ * @typedef EventProcessedStatus
+ * @property {number} [attempt]
+ * @property {string} [created_on]
+ * @property {number} [id]
+ * @property {string} [processed_on]
+ * @property {string} [response_code]
+ * @property {string} [response_message]
+ * @property {boolean} [status]
+ * @property {string} [subscriber_id]
+ */
+
+/**
+ * @typedef Page
+ * @property {number} [current]
+ * @property {boolean} [has_next]
+ * @property {boolean} [has_previous]
+ * @property {number} [item_total]
+ * @property {string} [next_id]
+ * @property {number} [size]
+ * @property {string} type
+ */
+
+/**
+ * @typedef SubscriberConfig
+ * @property {Association} [association]
+ * @property {AuthMeta} [auth_meta]
+ * @property {Object} [custom_headers]
+ * @property {string} [email_id]
+ * @property {number[]} [event_id]
+ * @property {number} [id]
+ * @property {string} [name]
+ * @property {SubscriberStatus} [status]
+ * @property {string} [webhook_url]
+ */
+
+/**
+ * @typedef SubscriberConfigList
+ * @property {SubscriberResponse[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef SubscriberEvent
+ * @property {string} [created_date]
+ * @property {number} [event_id]
+ * @property {number} [id]
+ * @property {number} [subscriber_id]
+ */
+
+/**
+ * @typedef SubscriberResponse
+ * @property {Association} [association]
+ * @property {AuthMeta} [auth_meta]
+ * @property {string} [created_on]
+ * @property {Object} [custom_headers]
+ * @property {string} [email_id]
+ * @property {EventConfig[]} [event_configs]
+ * @property {number} [id]
+ * @property {string} [name]
+ * @property {SubscriberStatus} [status]
+ * @property {string} [updated_on]
+ * @property {string} [webhook_url]
+ */
+
+/** @typedef {"active" | "inactive" | "blocked"} SubscriberStatus */
+
+class WebhookPublicModel {
+  /** @returns {Association} */
   static Association() {
     return Joi.object({
       application_id: Joi.array().items(Joi.string().allow("")),
@@ -9,12 +133,16 @@ class WebhookModel {
       extension_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {AuthMeta} */
   static AuthMeta() {
     return Joi.object({
       secret: Joi.string().allow(""),
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EventConfig} */
   static EventConfig() {
     return Joi.object({
       created_on: Joi.string().allow(""),
@@ -27,6 +155,8 @@ class WebhookModel {
       version: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EventConfigBase} */
   static EventConfigBase() {
     return Joi.object({
       event_category: Joi.string().allow(""),
@@ -35,17 +165,23 @@ class WebhookModel {
       version: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EventConfigList} */
   static EventConfigList() {
     return Joi.object({
-      items: Joi.array().items(WebhookModel.EventConfig()),
-      page: WebhookModel.Page(),
+      items: Joi.array().items(WebhookPublicModel.EventConfig()),
+      page: WebhookPublicModel.Page(),
     });
   }
+
+  /** @returns {EventConfigResponse} */
   static EventConfigResponse() {
     return Joi.object({
-      event_configs: Joi.array().items(WebhookModel.EventConfig()),
+      event_configs: Joi.array().items(WebhookPublicModel.EventConfig()),
     });
   }
+
+  /** @returns {EventPayload} */
   static EventPayload() {
     return Joi.object({
       event_name: Joi.string().allow(""),
@@ -57,6 +193,8 @@ class WebhookModel {
       version: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EventProcessedStatus} */
   static EventProcessedStatus() {
     return Joi.object({
       attempt: Joi.number(),
@@ -69,6 +207,8 @@ class WebhookModel {
       subscriber_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Page} */
   static Page() {
     return Joi.object({
       current: Joi.number(),
@@ -80,25 +220,31 @@ class WebhookModel {
       type: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {SubscriberConfig} */
   static SubscriberConfig() {
     return Joi.object({
-      association: WebhookModel.Association(),
-      auth_meta: WebhookModel.AuthMeta(),
+      association: WebhookPublicModel.Association(),
+      auth_meta: WebhookPublicModel.AuthMeta(),
       custom_headers: Joi.any(),
       email_id: Joi.string().allow(""),
       event_id: Joi.array().items(Joi.number()),
       id: Joi.number(),
       name: Joi.string().allow(""),
-      status: WebhookModel.SubscriberStatus(),
+      status: WebhookPublicModel.SubscriberStatus(),
       webhook_url: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SubscriberConfigList} */
   static SubscriberConfigList() {
     return Joi.object({
-      items: Joi.array().items(WebhookModel.SubscriberResponse()),
-      page: WebhookModel.Page(),
+      items: Joi.array().items(WebhookPublicModel.SubscriberResponse()),
+      page: WebhookPublicModel.Page(),
     });
   }
+
+  /** @returns {SubscriberEvent} */
   static SubscriberEvent() {
     return Joi.object({
       created_date: Joi.string().allow(""),
@@ -107,26 +253,29 @@ class WebhookModel {
       subscriber_id: Joi.number(),
     });
   }
+
+  /** @returns {SubscriberResponse} */
   static SubscriberResponse() {
     return Joi.object({
-      association: WebhookModel.Association(),
-      auth_meta: WebhookModel.AuthMeta(),
+      association: WebhookPublicModel.Association(),
+      auth_meta: WebhookPublicModel.AuthMeta(),
       created_on: Joi.string().allow(""),
       custom_headers: Joi.any(),
       email_id: Joi.string().allow(""),
-      event_configs: Joi.array().items(WebhookModel.EventConfig()),
+      event_configs: Joi.array().items(WebhookPublicModel.EventConfig()),
       id: Joi.number(),
       name: Joi.string().allow(""),
-      status: WebhookModel.SubscriberStatus(),
+      status: WebhookPublicModel.SubscriberStatus(),
       updated_on: Joi.string().allow(""),
       webhook_url: Joi.string().allow(""),
     });
   }
 
-  /*
-        Enum: SubscriberStatus
-        Used By: Webhook
-    */
+  /**
+   * Enum: SubscriberStatus Used By: Webhook
+   *
+   * @returns {SubscriberStatus}
+   */
   static SubscriberStatus() {
     return Joi.string().valid(
       "active",
@@ -137,4 +286,4 @@ class WebhookModel {
     );
   }
 }
-module.exports = WebhookModel;
+module.exports = WebhookPublicModel;

package/sdk/public/Webhook/WebhookPublicValidator.d.ts

@@ -1,5 +1,20 @@
-export = WebhookValidator;
-declare class WebhookValidator {
+export = WebhookPublicValidator;
+/** @typedef FetchAllWebhookEventsParam */
+/**
+ * @typedef QueryWebhookEventDetailsParam
+ * @property {WebhookPublicModel.EventConfigBase[]} body
+ */
+declare class WebhookPublicValidator {
+    /** @returns {FetchAllWebhookEventsParam} */
     static fetchAllWebhookEvents(): any;
-    static queryWebhookEventDetails(): any;
+    /** @returns {QueryWebhookEventDetailsParam} */
+    static queryWebhookEventDetails(): QueryWebhookEventDetailsParam;
 }
+declare namespace WebhookPublicValidator {
+    export { FetchAllWebhookEventsParam, QueryWebhookEventDetailsParam };
+}
+type QueryWebhookEventDetailsParam = {
+    body: WebhookPublicModel.EventConfigBase[];
+};
+type FetchAllWebhookEventsParam = any;
+import WebhookPublicModel = require("./WebhookPublicModel");

package/sdk/public/Webhook/WebhookPublicValidator.js

@@ -1,16 +1,26 @@
 const Joi = require("joi");
 
-const WebhookModel = require("./WebhookPublicModel");
-class WebhookValidator {
+const WebhookPublicModel = require("./WebhookPublicModel");
+
+/** @typedef FetchAllWebhookEventsParam */
+
+/**
+ * @typedef QueryWebhookEventDetailsParam
+ * @property {WebhookPublicModel.EventConfigBase[]} body
+ */
+
+class WebhookPublicValidator {
+  /** @returns {FetchAllWebhookEventsParam} */
   static fetchAllWebhookEvents() {
     return Joi.object({});
   }
 
+  /** @returns {QueryWebhookEventDetailsParam} */
   static queryWebhookEventDetails() {
     return Joi.object({
-      body: Joi.array().items(WebhookModel.EventConfigBase()).required(),
+      body: Joi.array().items(WebhookPublicModel.EventConfigBase()).required(),
     }).required();
   }
 }
 
-module.exports = WebhookValidator;
+module.exports = WebhookPublicValidator;