@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

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

@@ -1,200 +1,348 @@
 export = WebhookPublicModel;
 /**
  * @typedef EventConfig
- * @property {number} [id]
- * @property {string} [event_name]
- * @property {string} [event_type]
- * @property {string} [event_category]
- * @property {Object} [event_schema]
- * @property {string} [version]
- * @property {string} [display_name]
- * @property {string} [description]
- * @property {string} [created_on]
- * @property {string} [updated_on]
- * @property {string} [group]
+ * @property {number} [id] - The unique identifier for the event configuration.
+ * @property {string} [event_name] - The name of the event.
+ * @property {string} [event_type] - The type of the event.
+ * @property {string} [event_category] - The category of the event.
+ * @property {Object} [event_schema] - The schema defining the event data structure.
+ * @property {string} [version] - The version of the event configuration.
+ * @property {string} [display_name] - A user-friendly name for the event.
+ * @property {string} [description] - A detailed description of the event.
+ * @property {string} [created_on] - The timestamp when the event configuration
+ *   was created.
+ * @property {string} [updated_on] - The timestamp when the event configuration
+ *   was last updated.
+ * @property {string} [group] - The group to which the event belongs.
  */
 /**
- * @typedef EventConfigResponse
- * @property {EventConfig[]} [event_configs]
+ * @typedef EventDetails
+ * @property {EventConfig[]} [event_configs] - A list of event configuration details.
  */
 /**
  * @typedef EventConfigBase
- * @property {string} [event_name]
- * @property {string} [event_type]
- * @property {string} [event_category]
- * @property {string} [version]
+ * @property {string} [event_name] - The name of the event.
+ * @property {string} [event_type] - The type of the event.
+ * @property {string} [event_category] - The category of the event.
+ * @property {string} [version] - The version of the event configuration.
  */
 /**
  * @typedef EventNotifier
- * @property {string} [message]
- * @property {string[]} [emails]
+ * @property {string} [message] - The message to be sent in the notification.
+ * @property {string[]} [emails] - List of email addresses to notify.
  */
 /**
  * @typedef EventSchema
- * @property {Object} [payload]
- * @property {Object} [meta]
+ * @property {Object} [payload] - The event data payload.
+ * @property {Object} [meta] - Metadata related to the event.
  */
 /**
  * @typedef InternalTransformEvent
- * @property {string[]} [trace_id]
- * @property {string} [name]
- * @property {string} [type]
- * @property {string} [version]
- * @property {number} [created_timestamp]
+ * @property {string[]} [trace_id] - List of trace IDs related to the event.
+ * @property {string} [name] - The name of the transformation event.
+ * @property {string} [type] - The type of the transformation event.
+ * @property {string} [version] - The version of the transformation event.
+ * @property {number} [created_timestamp] - The timestamp when the event was created.
  */
 /**
  * @typedef TransformEventData
  * @property {InternalTransformEvent} [event]
- * @property {number} [company_id]
- * @property {string[]} [contains]
- * @property {Object} [payload]
+ * @property {number} [company_id] - The company ID associated with the event.
+ * @property {string[]} [contains] - List of strings related to the event.
+ * @property {Object} [payload] - Event data payload.
  */
 /**
  * @typedef TransformEventServiceMeta
- * @property {string} [name]
+ * @property {string} [name] - The name of the transformation service.
  */
 /**
  * @typedef TransformEventAssociation
- * @property {number} [company_id]
+ * @property {number} [company_id] - The company ID associated with the event.
  */
 /**
- * @typedef TransformEventRequest
- * @property {string} event_name
- * @property {string} event_type
- * @property {string} event_category
- * @property {string} event_version
+ * @typedef TransformEventPayload
+ * @property {string} event_name - The name of the event.
+ * @property {string} event_type - The type of the event.
+ * @property {string} event_category - The category of the event.
+ * @property {string} event_version - The version of the event.
  * @property {EventSchema} event
  */
 /**
- * @typedef ValidateSchemaRequest
- * @property {string} event_name
- * @property {string} event_type
- * @property {string} event_category
- * @property {string} event_version
+ * @typedef ValidateSchemaPayload
+ * @property {string} event_name - The name of the event to validate.
+ * @property {string} event_type - The type of the event.
+ * @property {string} event_category - The category of the event.
+ * @property {string} event_version - The version of the event to validate.
  * @property {EventSchema} event
- * @property {Object} event_schema
+ * @property {Object} event_schema - The schema defining the structure of the event.
  */
 /**
- * @typedef ValidateSchemaResponse
- * @property {boolean} [status]
- * @property {string} [message]
+ * @typedef ValidateSchemaResult
+ * @property {boolean} [status] - Indicates whether the schema is valid (true)
+ *   or invalid (false).
+ * @property {string} [message] - A message providing additional details about
+ *   the validation result.
  */
 /**
- * @typedef TransformEventResponse
- * @property {string[]} [event_trace_id]
+ * @typedef TransformEventResult
+ * @property {string[]} [event_trace_id] - List of trace IDs related to the
+ *   transformation event.
  * @property {TransformEventData} [data]
- * @property {string} [event_name]
- * @property {string} [version]
- * @property {boolean} [status]
- * @property {string} [event_type]
+ * @property {string} [event_name] - The name of the transformation event.
+ * @property {string} [version] - The version of the transformation event.
+ * @property {boolean} [status] - The status of the event processing.
+ * @property {string} [event_type] - The type of the transformation event.
  * @property {TransformEventServiceMeta} [service_meta]
  * @property {TransformEventAssociation} [association]
  */
 declare class WebhookPublicModel {
 }
 declare namespace WebhookPublicModel {
-    export { EventConfig, EventConfigResponse, EventConfigBase, EventNotifier, EventSchema, InternalTransformEvent, TransformEventData, TransformEventServiceMeta, TransformEventAssociation, TransformEventRequest, ValidateSchemaRequest, ValidateSchemaResponse, TransformEventResponse };
+    export { EventConfig, EventDetails, EventConfigBase, EventNotifier, EventSchema, InternalTransformEvent, TransformEventData, TransformEventServiceMeta, TransformEventAssociation, TransformEventPayload, ValidateSchemaPayload, ValidateSchemaResult, TransformEventResult };
 }
 /** @returns {EventConfig} */
 declare function EventConfig(): EventConfig;
 type EventConfig = {
+    /**
+     * - The unique identifier for the event configuration.
+     */
     id?: number;
+    /**
+     * - The name of the event.
+     */
     event_name?: string;
+    /**
+     * - The type of the event.
+     */
     event_type?: string;
+    /**
+     * - The category of the event.
+     */
     event_category?: string;
+    /**
+     * - The schema defining the event data structure.
+     */
     event_schema?: any;
+    /**
+     * - The version of the event configuration.
+     */
     version?: string;
+    /**
+     * - A user-friendly name for the event.
+     */
     display_name?: string;
+    /**
+     * - A detailed description of the event.
+     */
     description?: string;
+    /**
+     * - The timestamp when the event configuration
+     * was created.
+     */
     created_on?: string;
+    /**
+     * - The timestamp when the event configuration
+     * was last updated.
+     */
     updated_on?: string;
+    /**
+     * - The group to which the event belongs.
+     */
     group?: string;
 };
-/** @returns {EventConfigResponse} */
-declare function EventConfigResponse(): EventConfigResponse;
-type EventConfigResponse = {
+/** @returns {EventDetails} */
+declare function EventDetails(): EventDetails;
+type EventDetails = {
+    /**
+     * - A list of event configuration details.
+     */
     event_configs?: EventConfig[];
 };
 /** @returns {EventConfigBase} */
 declare function EventConfigBase(): EventConfigBase;
 type EventConfigBase = {
+    /**
+     * - The name of the event.
+     */
     event_name?: string;
+    /**
+     * - The type of the event.
+     */
     event_type?: string;
+    /**
+     * - The category of the event.
+     */
     event_category?: string;
+    /**
+     * - The version of the event configuration.
+     */
     version?: string;
 };
 /** @returns {EventNotifier} */
 declare function EventNotifier(): EventNotifier;
 type EventNotifier = {
+    /**
+     * - The message to be sent in the notification.
+     */
     message?: string;
+    /**
+     * - List of email addresses to notify.
+     */
     emails?: string[];
 };
 /** @returns {EventSchema} */
 declare function EventSchema(): EventSchema;
 type EventSchema = {
+    /**
+     * - The event data payload.
+     */
     payload?: any;
+    /**
+     * - Metadata related to the event.
+     */
     meta?: any;
 };
 /** @returns {InternalTransformEvent} */
 declare function InternalTransformEvent(): InternalTransformEvent;
 type InternalTransformEvent = {
+    /**
+     * - List of trace IDs related to the event.
+     */
     trace_id?: string[];
+    /**
+     * - The name of the transformation event.
+     */
     name?: string;
+    /**
+     * - The type of the transformation event.
+     */
     type?: string;
+    /**
+     * - The version of the transformation event.
+     */
     version?: string;
+    /**
+     * - The timestamp when the event was created.
+     */
     created_timestamp?: number;
 };
 /** @returns {TransformEventData} */
 declare function TransformEventData(): TransformEventData;
 type TransformEventData = {
     event?: InternalTransformEvent;
+    /**
+     * - The company ID associated with the event.
+     */
     company_id?: number;
+    /**
+     * - List of strings related to the event.
+     */
     contains?: string[];
+    /**
+     * - Event data payload.
+     */
     payload?: any;
 };
 /** @returns {TransformEventServiceMeta} */
 declare function TransformEventServiceMeta(): TransformEventServiceMeta;
 type TransformEventServiceMeta = {
+    /**
+     * - The name of the transformation service.
+     */
     name?: string;
 };
 /** @returns {TransformEventAssociation} */
 declare function TransformEventAssociation(): TransformEventAssociation;
 type TransformEventAssociation = {
+    /**
+     * - The company ID associated with the event.
+     */
     company_id?: number;
 };
-/** @returns {TransformEventRequest} */
-declare function TransformEventRequest(): TransformEventRequest;
-type TransformEventRequest = {
+/** @returns {TransformEventPayload} */
+declare function TransformEventPayload(): TransformEventPayload;
+type TransformEventPayload = {
+    /**
+     * - The name of the event.
+     */
     event_name: string;
+    /**
+     * - The type of the event.
+     */
     event_type: string;
+    /**
+     * - The category of the event.
+     */
     event_category: string;
+    /**
+     * - The version of the event.
+     */
     event_version: string;
     event: EventSchema;
 };
-/** @returns {ValidateSchemaRequest} */
-declare function ValidateSchemaRequest(): ValidateSchemaRequest;
-type ValidateSchemaRequest = {
+/** @returns {ValidateSchemaPayload} */
+declare function ValidateSchemaPayload(): ValidateSchemaPayload;
+type ValidateSchemaPayload = {
+    /**
+     * - The name of the event to validate.
+     */
     event_name: string;
+    /**
+     * - The type of the event.
+     */
     event_type: string;
+    /**
+     * - The category of the event.
+     */
     event_category: string;
+    /**
+     * - The version of the event to validate.
+     */
     event_version: string;
     event: EventSchema;
+    /**
+     * - The schema defining the structure of the event.
+     */
     event_schema: any;
 };
-/** @returns {ValidateSchemaResponse} */
-declare function ValidateSchemaResponse(): ValidateSchemaResponse;
-type ValidateSchemaResponse = {
+/** @returns {ValidateSchemaResult} */
+declare function ValidateSchemaResult(): ValidateSchemaResult;
+type ValidateSchemaResult = {
+    /**
+     * - Indicates whether the schema is valid (true)
+     * or invalid (false).
+     */
     status?: boolean;
+    /**
+     * - A message providing additional details about
+     * the validation result.
+     */
     message?: string;
 };
-/** @returns {TransformEventResponse} */
-declare function TransformEventResponse(): TransformEventResponse;
-type TransformEventResponse = {
+/** @returns {TransformEventResult} */
+declare function TransformEventResult(): TransformEventResult;
+type TransformEventResult = {
+    /**
+     * - List of trace IDs related to the
+     * transformation event.
+     */
     event_trace_id?: string[];
     data?: TransformEventData;
+    /**
+     * - The name of the transformation event.
+     */
     event_name?: string;
+    /**
+     * - The version of the transformation event.
+     */
     version?: string;
+    /**
+     * - The status of the event processing.
+     */
     status?: boolean;
+    /**
+     * - The type of the transformation event.
+     */
     event_type?: string;
     service_meta?: TransformEventServiceMeta;
     association?: TransformEventAssociation;

package/sdk/public/Webhook/WebhookPublicModel.js

@@ -2,104 +2,109 @@ const Joi = require("joi");
 
 /**
  * @typedef EventConfig
- * @property {number} [id]
- * @property {string} [event_name]
- * @property {string} [event_type]
- * @property {string} [event_category]
- * @property {Object} [event_schema]
- * @property {string} [version]
- * @property {string} [display_name]
- * @property {string} [description]
- * @property {string} [created_on]
- * @property {string} [updated_on]
- * @property {string} [group]
+ * @property {number} [id] - The unique identifier for the event configuration.
+ * @property {string} [event_name] - The name of the event.
+ * @property {string} [event_type] - The type of the event.
+ * @property {string} [event_category] - The category of the event.
+ * @property {Object} [event_schema] - The schema defining the event data structure.
+ * @property {string} [version] - The version of the event configuration.
+ * @property {string} [display_name] - A user-friendly name for the event.
+ * @property {string} [description] - A detailed description of the event.
+ * @property {string} [created_on] - The timestamp when the event configuration
+ *   was created.
+ * @property {string} [updated_on] - The timestamp when the event configuration
+ *   was last updated.
+ * @property {string} [group] - The group to which the event belongs.
  */
 
 /**
- * @typedef EventConfigResponse
- * @property {EventConfig[]} [event_configs]
+ * @typedef EventDetails
+ * @property {EventConfig[]} [event_configs] - A list of event configuration details.
  */
 
 /**
  * @typedef EventConfigBase
- * @property {string} [event_name]
- * @property {string} [event_type]
- * @property {string} [event_category]
- * @property {string} [version]
+ * @property {string} [event_name] - The name of the event.
+ * @property {string} [event_type] - The type of the event.
+ * @property {string} [event_category] - The category of the event.
+ * @property {string} [version] - The version of the event configuration.
  */
 
 /**
  * @typedef EventNotifier
- * @property {string} [message]
- * @property {string[]} [emails]
+ * @property {string} [message] - The message to be sent in the notification.
+ * @property {string[]} [emails] - List of email addresses to notify.
  */
 
 /**
  * @typedef EventSchema
- * @property {Object} [payload]
- * @property {Object} [meta]
+ * @property {Object} [payload] - The event data payload.
+ * @property {Object} [meta] - Metadata related to the event.
  */
 
 /**
  * @typedef InternalTransformEvent
- * @property {string[]} [trace_id]
- * @property {string} [name]
- * @property {string} [type]
- * @property {string} [version]
- * @property {number} [created_timestamp]
+ * @property {string[]} [trace_id] - List of trace IDs related to the event.
+ * @property {string} [name] - The name of the transformation event.
+ * @property {string} [type] - The type of the transformation event.
+ * @property {string} [version] - The version of the transformation event.
+ * @property {number} [created_timestamp] - The timestamp when the event was created.
  */
 
 /**
  * @typedef TransformEventData
  * @property {InternalTransformEvent} [event]
- * @property {number} [company_id]
- * @property {string[]} [contains]
- * @property {Object} [payload]
+ * @property {number} [company_id] - The company ID associated with the event.
+ * @property {string[]} [contains] - List of strings related to the event.
+ * @property {Object} [payload] - Event data payload.
  */
 
 /**
  * @typedef TransformEventServiceMeta
- * @property {string} [name]
+ * @property {string} [name] - The name of the transformation service.
  */
 
 /**
  * @typedef TransformEventAssociation
- * @property {number} [company_id]
+ * @property {number} [company_id] - The company ID associated with the event.
  */
 
 /**
- * @typedef TransformEventRequest
- * @property {string} event_name
- * @property {string} event_type
- * @property {string} event_category
- * @property {string} event_version
+ * @typedef TransformEventPayload
+ * @property {string} event_name - The name of the event.
+ * @property {string} event_type - The type of the event.
+ * @property {string} event_category - The category of the event.
+ * @property {string} event_version - The version of the event.
  * @property {EventSchema} event
  */
 
 /**
- * @typedef ValidateSchemaRequest
- * @property {string} event_name
- * @property {string} event_type
- * @property {string} event_category
- * @property {string} event_version
+ * @typedef ValidateSchemaPayload
+ * @property {string} event_name - The name of the event to validate.
+ * @property {string} event_type - The type of the event.
+ * @property {string} event_category - The category of the event.
+ * @property {string} event_version - The version of the event to validate.
  * @property {EventSchema} event
- * @property {Object} event_schema
+ * @property {Object} event_schema - The schema defining the structure of the event.
  */
 
 /**
- * @typedef ValidateSchemaResponse
- * @property {boolean} [status]
- * @property {string} [message]
+ * @typedef ValidateSchemaResult
+ * @property {boolean} [status] - Indicates whether the schema is valid (true)
+ *   or invalid (false).
+ * @property {string} [message] - A message providing additional details about
+ *   the validation result.
  */
 
 /**
- * @typedef TransformEventResponse
- * @property {string[]} [event_trace_id]
+ * @typedef TransformEventResult
+ * @property {string[]} [event_trace_id] - List of trace IDs related to the
+ *   transformation event.
  * @property {TransformEventData} [data]
- * @property {string} [event_name]
- * @property {string} [version]
- * @property {boolean} [status]
- * @property {string} [event_type]
+ * @property {string} [event_name] - The name of the transformation event.
+ * @property {string} [version] - The version of the transformation event.
+ * @property {boolean} [status] - The status of the event processing.
+ * @property {string} [event_type] - The type of the transformation event.
  * @property {TransformEventServiceMeta} [service_meta]
  * @property {TransformEventAssociation} [association]
  */
@@ -122,8 +127,8 @@ class WebhookPublicModel {
     });
   }
 
-  /** @returns {EventConfigResponse} */
-  static EventConfigResponse() {
+  /** @returns {EventDetails} */
+  static EventDetails() {
     return Joi.object({
       event_configs: Joi.array().items(WebhookPublicModel.EventConfig()),
     });
@@ -190,8 +195,8 @@ class WebhookPublicModel {
     });
   }
 
-  /** @returns {TransformEventRequest} */
-  static TransformEventRequest() {
+  /** @returns {TransformEventPayload} */
+  static TransformEventPayload() {
     return Joi.object({
       event_name: Joi.string().allow("").required(),
       event_type: Joi.string().allow("").required(),
@@ -201,8 +206,8 @@ class WebhookPublicModel {
     });
   }
 
-  /** @returns {ValidateSchemaRequest} */
-  static ValidateSchemaRequest() {
+  /** @returns {ValidateSchemaPayload} */
+  static ValidateSchemaPayload() {
     return Joi.object({
       event_name: Joi.string().allow("").required(),
       event_type: Joi.string().allow("").required(),
@@ -213,16 +218,16 @@ class WebhookPublicModel {
     });
   }
 
-  /** @returns {ValidateSchemaResponse} */
-  static ValidateSchemaResponse() {
+  /** @returns {ValidateSchemaResult} */
+  static ValidateSchemaResult() {
     return Joi.object({
       status: Joi.boolean(),
       message: Joi.string().allow(""),
     });
   }
 
-  /** @returns {TransformEventResponse} */
-  static TransformEventResponse() {
+  /** @returns {TransformEventResult} */
+  static TransformEventResult() {
     return Joi.object({
       event_trace_id: Joi.array().items(Joi.string().allow("")),
       data: WebhookPublicModel.TransformEventData(),

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

@@ -7,11 +7,11 @@ export = WebhookPublicValidator;
  */
 /**
  * @typedef TestHandlerTransformationParam
- * @property {WebhookPublicModel.TransformEventRequest} body
+ * @property {WebhookPublicModel.TransformEventPayload} body
  */
 /**
  * @typedef ValidateSchemaParam
- * @property {WebhookPublicModel.ValidateSchemaRequest} body
+ * @property {WebhookPublicModel.ValidateSchemaPayload} body
  */
 declare class WebhookPublicValidator {
     /** @returns {FetchAllWebhookEventsParam} */
@@ -32,10 +32,10 @@ type QueryWebhookEventDetailsParam = {
     body: WebhookPublicModel.EventConfigBase[];
 };
 type TestHandlerTransformationParam = {
-    body: WebhookPublicModel.TransformEventRequest;
+    body: WebhookPublicModel.TransformEventPayload;
 };
 type ValidateSchemaParam = {
-    body: WebhookPublicModel.ValidateSchemaRequest;
+    body: WebhookPublicModel.ValidateSchemaPayload;
 };
 type FetchAllWebhookEventsParam = any;
 type NotifyDepricatedEventParam = any;