@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/public/PublicClient.js

@@ -6,7 +6,17 @@ const Webhook = require("./Webhook/WebhookPublicClient");
 
 const { FDKClientValidationError } = require("../common/FDKError");
 
+/**
+ * Represents the client for the public APIs.
+ *
+ * @class
+ */
 class PublicClient {
+  /**
+   * Creates an instance of PublicClient.
+   *
+   * @param {import("./PublicConfig")} config - The configuration for the public client.
+   */
   constructor(config) {
     this.config = config;
 
@@ -17,6 +27,12 @@ class PublicClient {
     this.webhook = new Webhook(config);
   }
 
+  /**
+   * Sets the extra headers for the public client.
+   *
+   * @param {object} header - The header object to set.
+   * @throws {FDKClientValidationError} When the provided header is not an object.
+   */
   setExtraHeaders(header) {
     if (typeof header === "object") {
       this.config.extraHeaders.push(header);

package/sdk/public/PublicConfig.d.ts

@@ -1,10 +1,31 @@
 export = PublicConfig;
+/**
+ * Represents the configuration for the public APIs.
+ *
+ * @class
+ */
 declare class PublicConfig {
-    /** @param {object} _conf */
-    constructor(_conf: object, _opts: any);
-    domain: any;
-    userAgent: any;
-    language: any;
-    currency: any;
+    /**
+     * Creates an instance of PublicConfig.
+     *
+     * @param {object} _conf - The configuration for the public APIs.
+     * @param {string} [_conf.domain='https://api.fynd.com'] - The domain for
+     *   API. Write the full domain. Default is `'https://api.fynd.com'`
+     * @param {string} [_conf.userAgent=''] - The user agent for the API
+     *   requests. Default is `''`
+     * @param {string} [_conf.language] - The language for localization.
+     * @param {string} [_conf.currency] - The currency for pricing and financial
+     *   calculations.
+     */
+    constructor(_conf: {
+        domain?: string;
+        userAgent?: string;
+        language?: string;
+        currency?: string;
+    }, _opts: any);
+    domain: string;
+    userAgent: string;
+    language: string;
+    currency: string;
     extraHeaders: any[];
 }

package/sdk/public/PublicConfig.js

@@ -1,5 +1,21 @@
+/**
+ * Represents the configuration for the public APIs.
+ *
+ * @class
+ */
 class PublicConfig {
-  /** @param {object} _conf */
+  /**
+   * Creates an instance of PublicConfig.
+   *
+   * @param {object} _conf - The configuration for the public APIs.
+   * @param {string} [_conf.domain='https://api.fynd.com'] - The domain for
+   *   API. Write the full domain. Default is `'https://api.fynd.com'`
+   * @param {string} [_conf.userAgent=''] - The user agent for the API
+   *   requests. Default is `''`
+   * @param {string} [_conf.language] - The language for localization.
+   * @param {string} [_conf.currency] - The currency for pricing and financial
+   *   calculations.
+   */
   constructor(_conf, _opts) {
     this.domain = _conf.domain || "https://api.fynd.com";
     this.userAgent = _conf.userAgent || "";

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

@@ -9,20 +9,22 @@ declare class Webhook {
     _urls: {};
     updateUrls(urls: any): void;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<EventConfigResponse>} - Success response
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
+     * @name fetchAllWebhookEvents
      * @summary: Get All Webhook Events
-     * @description: Get All Webhook Events
+     * @description: Get All Webhook Events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
      */
-    fetchAllWebhookEvents({}?: any): Promise<EventConfigResponse>;
+    fetchAllWebhookEvents({ headers }?: any): Promise<WebhookPublicModel.EventConfigResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {EventConfigBase[]} arg.body
-     * @returns {Promise<EventConfigResponse>} - Success response
+     * @param {WebhookPublicValidator.QueryWebhookEventDetailsParam} arg - Arg object.
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
+     * @name queryWebhookEventDetails
      * @summary: Send webhook event name, type, version, category in request body to get complete details of event from server
-     * @description: Get Webhook Event Details for provided events
+     * @description: Get Webhook Event Details for provided events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/queryWebhookEventDetails/).
      */
-    queryWebhookEventDetails({ body }?: {
-        body: EventConfigBase[];
-    }): Promise<EventConfigResponse>;
+    queryWebhookEventDetails({ body }?: WebhookPublicValidator.QueryWebhookEventDetailsParam, { headers }?: any): Promise<WebhookPublicModel.EventConfigResponse>;
 }
+import WebhookPublicModel = require("./WebhookPublicModel");
+import WebhookPublicValidator = require("./WebhookPublicValidator");

package/sdk/public/Webhook/WebhookPublicClient.js

@@ -2,8 +2,8 @@ const PublicAPIClient = require("../PublicAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
-const WebhookValidator = require("./WebhookPublicValidator");
-const WebhookModel = require("./WebhookPublicModel");
+const WebhookPublicValidator = require("./WebhookPublicValidator");
+const WebhookPublicModel = require("./WebhookPublicModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -32,13 +32,14 @@ class Webhook {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @returns {Promise<EventConfigResponse>} - Success response
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
+   * @name fetchAllWebhookEvents
    * @summary: Get All Webhook Events
-   * @description: Get All Webhook Events
+   * @description: Get All Webhook Events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
    */
-  async fetchAllWebhookEvents({} = {}) {
-    const { error } = WebhookValidator.fetchAllWebhookEvents().validate(
+  async fetchAllWebhookEvents({ headers } = { headers: false }) {
+    const { error } = WebhookPublicValidator.fetchAllWebhookEvents().validate(
       {},
       { abortEarly: false, allowUnknown: true }
     );
@@ -49,16 +50,15 @@ class Webhook {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = WebhookValidator.fetchAllWebhookEvents().validate(
+    } = WebhookPublicValidator.fetchAllWebhookEvents().validate(
       {},
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for fetchAllWebhookEvents",
+        message: `Parameter Validation warrnings for public > Webhook > fetchAllWebhookEvents \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -74,12 +74,18 @@ class Webhook {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = WebhookModel.EventConfigResponse().validate(response, {
+    } = WebhookPublicModel.EventConfigResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -87,23 +93,28 @@ class Webhook {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for fetchAllWebhookEvents",
+        message: `Response Validation Warnnings for public > Webhook > fetchAllWebhookEvents \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {EventConfigBase[]} arg.body
-   * @returns {Promise<EventConfigResponse>} - Success response
+   * @param {WebhookPublicValidator.QueryWebhookEventDetailsParam} arg - Arg object.
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
+   * @name queryWebhookEventDetails
    * @summary: Send webhook event name, type, version, category in request body to get complete details of event from server
-   * @description: Get Webhook Event Details for provided events
+   * @description: Get Webhook Event Details for provided events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/queryWebhookEventDetails/).
    */
-  async queryWebhookEventDetails({ body } = {}) {
-    const { error } = WebhookValidator.queryWebhookEventDetails().validate(
+  async queryWebhookEventDetails(
+    { body } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = WebhookPublicValidator.queryWebhookEventDetails().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -114,16 +125,15 @@ class Webhook {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = WebhookValidator.queryWebhookEventDetails().validate(
+    } = WebhookPublicValidator.queryWebhookEventDetails().validate(
       { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for queryWebhookEventDetails",
+        message: `Parameter Validation warrnings for public > Webhook > queryWebhookEventDetails \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -139,12 +149,18 @@ class Webhook {
       }),
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = WebhookModel.EventConfigResponse().validate(response, {
+    } = WebhookPublicModel.EventConfigResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -152,9 +168,8 @@ class Webhook {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for queryWebhookEventDetails",
+        message: `Response Validation Warnnings for public > Webhook > queryWebhookEventDetails \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;

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

@@ -1,17 +1,243 @@
-export = WebhookModel;
-declare class WebhookModel {
-    static Association(): any;
-    static AuthMeta(): any;
-    static EventConfig(): any;
-    static EventConfigBase(): any;
-    static EventConfigList(): any;
-    static EventConfigResponse(): any;
-    static EventPayload(): any;
-    static EventProcessedStatus(): any;
-    static Page(): any;
-    static SubscriberConfig(): any;
-    static SubscriberConfigList(): any;
-    static SubscriberEvent(): any;
-    static SubscriberResponse(): any;
-    static SubscriberStatus(): any;
+export = WebhookPublicModel;
+/**
+ * @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 */
+declare class WebhookPublicModel {
 }
+declare namespace WebhookPublicModel {
+    export { Association, AuthMeta, EventConfig, EventConfigBase, EventConfigList, EventConfigResponse, EventPayload, EventProcessedStatus, Page, SubscriberConfig, SubscriberConfigList, SubscriberEvent, SubscriberResponse, SubscriberStatus };
+}
+/** @returns {Association} */
+declare function Association(): Association;
+type Association = {
+    application_id?: string[];
+    company_id?: number;
+    criteria?: string;
+    extension_id?: string;
+};
+/** @returns {AuthMeta} */
+declare function AuthMeta(): AuthMeta;
+type AuthMeta = {
+    secret?: string;
+    type?: string;
+};
+/** @returns {EventConfig} */
+declare function EventConfig(): EventConfig;
+type EventConfig = {
+    created_on?: string;
+    description?: string;
+    display_name?: string;
+    event_category?: string;
+    event_name?: string;
+    event_type?: string;
+    id?: number;
+    version?: string;
+};
+/** @returns {EventConfigBase} */
+declare function EventConfigBase(): EventConfigBase;
+type EventConfigBase = {
+    event_category?: string;
+    event_name?: string;
+    event_type?: string;
+    version?: string;
+};
+/** @returns {EventConfigList} */
+declare function EventConfigList(): EventConfigList;
+type EventConfigList = {
+    items?: EventConfig[];
+    page?: Page;
+};
+/** @returns {EventConfigResponse} */
+declare function EventConfigResponse(): EventConfigResponse;
+type EventConfigResponse = {
+    event_configs?: EventConfig[];
+};
+/** @returns {EventPayload} */
+declare function EventPayload(): EventPayload;
+type EventPayload = {
+    event_name?: string;
+    event_trace_id?: string;
+    event_type?: string;
+    id?: number;
+    message_id?: string;
+    status?: boolean;
+    version?: string;
+};
+/** @returns {EventProcessedStatus} */
+declare function EventProcessedStatus(): EventProcessedStatus;
+type EventProcessedStatus = {
+    attempt?: number;
+    created_on?: string;
+    id?: number;
+    processed_on?: string;
+    response_code?: string;
+    response_message?: string;
+    status?: boolean;
+    subscriber_id?: string;
+};
+/** @returns {Page} */
+declare function Page(): Page;
+type Page = {
+    current?: number;
+    has_next?: boolean;
+    has_previous?: boolean;
+    item_total?: number;
+    next_id?: string;
+    size?: number;
+    type: string;
+};
+/** @returns {SubscriberConfig} */
+declare function SubscriberConfig(): SubscriberConfig;
+type SubscriberConfig = {
+    association?: Association;
+    auth_meta?: AuthMeta;
+    custom_headers?: any;
+    email_id?: string;
+    event_id?: number[];
+    id?: number;
+    name?: string;
+    status?: SubscriberStatus;
+    webhook_url?: string;
+};
+/** @returns {SubscriberConfigList} */
+declare function SubscriberConfigList(): SubscriberConfigList;
+type SubscriberConfigList = {
+    items?: SubscriberResponse[];
+    page?: Page;
+};
+/** @returns {SubscriberEvent} */
+declare function SubscriberEvent(): SubscriberEvent;
+type SubscriberEvent = {
+    created_date?: string;
+    event_id?: number;
+    id?: number;
+    subscriber_id?: number;
+};
+/** @returns {SubscriberResponse} */
+declare function SubscriberResponse(): SubscriberResponse;
+type SubscriberResponse = {
+    association?: Association;
+    auth_meta?: AuthMeta;
+    created_on?: string;
+    custom_headers?: any;
+    email_id?: string;
+    event_configs?: EventConfig[];
+    id?: number;
+    name?: string;
+    status?: SubscriberStatus;
+    updated_on?: string;
+    webhook_url?: string;
+};
+/**
+ * Enum: SubscriberStatus Used By: Webhook
+ *
+ * @returns {SubscriberStatus}
+ */
+declare function SubscriberStatus(): SubscriberStatus;
+type SubscriberStatus = "active" | "inactive" | "blocked";