@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/sdk/public/PublicAPIClient.js

@@ -1,5 +1,10 @@
 const { fdkAxios } = require("../common/AxiosHelper");
 
+/**
+ * @typedef {Object} Options
+ * @property {boolean} responseHeaders - Whether response headers are returned or not.
+ */
+
 class PublicAPIClient {
   /**
    * @param {object} conf
@@ -9,7 +14,7 @@ class PublicAPIClient {
    * @param {object} body
    */
 
-  static execute(conf, method, url, query, body, xHeaders) {
+  static execute(conf, method, url, query, body, xHeaders, options) {
     let headers = {};
     headers["User-Agent"] = conf.userAgent ? conf.userAgent : "";
     headers["Accept-Language"] = conf.language ? conf.language : "en-IN";
@@ -30,6 +35,7 @@ class PublicAPIClient {
         ...extraHeaders,
         ...xHeaders,
       },
+      responseHeaders: options.responseHeaders,
     };
     return fdkAxios.request(rawRequest);
   }

package/sdk/public/PublicClient.d.ts

@@ -1,12 +1,30 @@
 export = PublicClient;
+/**
+ * Represents the client for the public APIs.
+ *
+ * @class
+ */
 declare class PublicClient {
-    constructor(config: any);
-    config: any;
+    /**
+     * Creates an instance of PublicClient.
+     *
+     * @param {import("./PublicConfig")} config - The configuration for the public client.
+     */
+    constructor(config: import("./PublicConfig"));
+    config: import("./PublicConfig");
     configuration: Configuration;
     inventory: Inventory;
+    partner: Partner;
     webhook: Webhook;
-    setExtraHeaders(header: any): void;
+    /**
+     * 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: object): void;
 }
 import Configuration = require("./Configuration/ConfigurationPublicClient");
 import Inventory = require("./Inventory/InventoryPublicClient");
+import Partner = require("./Partner/PartnerPublicClient");
 import Webhook = require("./Webhook/WebhookPublicClient");

package/sdk/public/PublicClient.js

@@ -2,11 +2,23 @@ const Configuration = require("./Configuration/ConfigurationPublicClient");
 
 const Inventory = require("./Inventory/InventoryPublicClient");
 
+const Partner = require("./Partner/PartnerPublicClient");
+
 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;
 
@@ -14,9 +26,17 @@ class PublicClient {
 
     this.inventory = new Inventory(config);
 
+    this.partner = new Partner(config);
+
     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,25 @@ declare class Webhook {
     _urls: {};
     updateUrls(urls: any): void;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<EventConfigResponse>} - Success response
+     * @param {WebhookPublicValidator.FetchAllWebhookEventsParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @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({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPublicModel.EventConfigResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {EventConfigBase[]} arg.body
-     * @returns {Promise<EventConfigResponse>} - Success response
+     * @param {WebhookPublicValidator.QueryWebhookEventDetailsParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @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, requestHeaders }?: WebhookPublicValidator.QueryWebhookEventDetailsParam, { responseHeaders }?: object): 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,19 @@ class Webhook {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @returns {Promise<EventConfigResponse>} - Success response
+   * @param {WebhookPublicValidator.FetchAllWebhookEventsParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @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(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = WebhookPublicValidator.fetchAllWebhookEvents().validate(
       {},
       { abortEarly: false, allowUnknown: true }
     );
@@ -49,16 +55,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 +79,18 @@ class Webhook {
       }),
       query_params,
       undefined,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = WebhookModel.EventConfigResponse().validate(response, {
+    } = WebhookPublicModel.EventConfigResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -87,23 +98,29 @@ 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 {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @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, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = WebhookPublicValidator.queryWebhookEventDetails().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -114,16 +131,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 +155,18 @@ class Webhook {
       }),
       query_params,
       body,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = WebhookModel.EventConfigResponse().validate(response, {
+    } = WebhookPublicModel.EventConfigResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -152,9 +174,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,53 @@
-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 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 EventConfigResponse
+ * @property {EventConfig[]} [event_configs]
+ */
+declare class WebhookPublicModel {
 }
+declare namespace WebhookPublicModel {
+    export { EventConfig, EventConfigBase, EventConfigResponse };
+}
+/** @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 {EventConfigResponse} */
+declare function EventConfigResponse(): EventConfigResponse;
+type EventConfigResponse = {
+    event_configs?: EventConfig[];
+};

package/sdk/public/Webhook/WebhookPublicModel.js

@@ -1,20 +1,32 @@
 const Joi = require("joi");
 
-class WebhookModel {
-  static Association() {
-    return Joi.object({
-      application_id: Joi.array().items(Joi.string().allow("")),
-      company_id: Joi.number(),
-      criteria: Joi.string().allow(""),
-      extension_id: Joi.string().allow(""),
-    });
-  }
-  static AuthMeta() {
-    return Joi.object({
-      secret: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-    });
-  }
+/**
+ * @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 EventConfigResponse
+ * @property {EventConfig[]} [event_configs]
+ */
+
+class WebhookPublicModel {
+  /** @returns {EventConfig} */
   static EventConfig() {
     return Joi.object({
       created_on: Joi.string().allow(""),
@@ -27,6 +39,8 @@ class WebhookModel {
       version: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EventConfigBase} */
   static EventConfigBase() {
     return Joi.object({
       event_category: Joi.string().allow(""),
@@ -35,106 +49,12 @@ class WebhookModel {
       version: Joi.string().allow(""),
     });
   }
-  static EventConfigList() {
-    return Joi.object({
-      items: Joi.array().items(WebhookModel.EventConfig()),
-      page: WebhookModel.Page(),
-    });
-  }
+
+  /** @returns {EventConfigResponse} */
   static EventConfigResponse() {
     return Joi.object({
-      event_configs: Joi.array().items(WebhookModel.EventConfig()),
-    });
-  }
-  static EventPayload() {
-    return Joi.object({
-      event_name: Joi.string().allow(""),
-      event_trace_id: Joi.string().allow(""),
-      event_type: Joi.string().allow(""),
-      id: Joi.number(),
-      message_id: Joi.string().allow(""),
-      status: Joi.boolean(),
-      version: Joi.string().allow(""),
+      event_configs: Joi.array().items(WebhookPublicModel.EventConfig()),
     });
   }
-  static EventProcessedStatus() {
-    return Joi.object({
-      attempt: Joi.number(),
-      created_on: Joi.string().allow(""),
-      id: Joi.number(),
-      processed_on: Joi.string().allow(""),
-      response_code: Joi.string().allow(""),
-      response_message: Joi.string().allow(""),
-      status: Joi.boolean(),
-      subscriber_id: 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(),
-    });
-  }
-  static SubscriberConfig() {
-    return Joi.object({
-      association: WebhookModel.Association(),
-      auth_meta: WebhookModel.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(),
-      webhook_url: Joi.string().allow(""),
-    });
-  }
-  static SubscriberConfigList() {
-    return Joi.object({
-      items: Joi.array().items(WebhookModel.SubscriberResponse()),
-      page: WebhookModel.Page(),
-    });
-  }
-  static SubscriberEvent() {
-    return Joi.object({
-      created_date: Joi.string().allow(""),
-      event_id: Joi.number(),
-      id: Joi.number(),
-      subscriber_id: Joi.number(),
-    });
-  }
-  static SubscriberResponse() {
-    return Joi.object({
-      association: WebhookModel.Association(),
-      auth_meta: WebhookModel.AuthMeta(),
-      created_on: Joi.string().allow(""),
-      custom_headers: Joi.any(),
-      email_id: Joi.string().allow(""),
-      event_configs: Joi.array().items(WebhookModel.EventConfig()),
-      id: Joi.number(),
-      name: Joi.string().allow(""),
-      status: WebhookModel.SubscriberStatus(),
-      updated_on: Joi.string().allow(""),
-      webhook_url: Joi.string().allow(""),
-    });
-  }
-
-  /*
-        Enum: SubscriberStatus
-        Used By: Webhook
-    */
-  static SubscriberStatus() {
-    return Joi.string().valid(
-      "active",
-
-      "inactive",
-
-      "blocked"
-    );
-  }
 }
-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;

package/sdk/public/index.d.ts

@@ -3,5 +3,6 @@ export const PublicClient: typeof import("./PublicClient");
 export namespace PublicModel {
     const ConfigurationPublicModel: typeof import("./Configuration/ConfigurationPublicModel");
     const InventoryPublicModel: typeof import("./Inventory/InventoryPublicModel");
+    const PartnerPublicModel: typeof import("./Partner/PartnerPublicModel");
     const WebhookPublicModel: typeof import("./Webhook/WebhookPublicModel");
 }

package/sdk/public/index.js

@@ -6,6 +6,8 @@ module.exports = {
 
     InventoryPublicModel: require("./Inventory/InventoryPublicModel"),
 
+    PartnerPublicModel: require("./Partner/PartnerPublicModel"),
+
     WebhookPublicModel: require("./Webhook/WebhookPublicModel"),
   },
 };