@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

package/sdk/public/Partner/PartnerPublicModel.js

@@ -0,0 +1,280 @@
+const Joi = require("joi");
+
+/**
+ * @typedef Benefits
+ * @property {string} [description]
+ * @property {string} [title]
+ */
+
+/**
+ * @typedef CategoryCommon
+ * @property {CategoryL1[]} [category_l1]
+ * @property {CategoryL2[]} [category_l2]
+ */
+
+/**
+ * @typedef CategoryL1
+ * @property {string} [_id]
+ * @property {string} [description]
+ * @property {string} [display]
+ * @property {number} [level]
+ * @property {string} [logo]
+ * @property {string} [slug]
+ * @property {string} [value]
+ */
+
+/**
+ * @typedef CategoryL2
+ * @property {string} [_id]
+ * @property {string} [display]
+ * @property {number} [level]
+ * @property {string} [parent]
+ * @property {string} [slug]
+ * @property {string} [value]
+ */
+
+/**
+ * @typedef ContactInfo
+ * @property {Support} [support]
+ */
+
+/**
+ * @typedef Details
+ * @property {Benefits[]} [benefits]
+ * @property {string} [demo_url]
+ * @property {string} [description]
+ * @property {string[]} [integration]
+ * @property {Screenshots} [screenshots]
+ * @property {Object[]} [video_url]
+ * @property {string[]} [youtube]
+ */
+
+/**
+ * @typedef ExtensionUsingSlug
+ * @property {string} [_id]
+ * @property {CategoryCommon} [category]
+ * @property {ContactInfo} [contact_info]
+ * @property {string} [created_at]
+ * @property {string} [current_status]
+ * @property {Details} [details]
+ * @property {string} [extension_id]
+ * @property {boolean} [is_coming_soon]
+ * @property {ListingInfo} [listing_info]
+ * @property {string} [modified_at]
+ * @property {Organization} [organization]
+ * @property {string} [organization_id]
+ * @property {string} [plan_type]
+ * @property {Plans[]} [plans]
+ * @property {string} [plans_url]
+ * @property {string} [review_instructions]
+ * @property {string[]} [scope]
+ * @property {string} [slug]
+ */
+
+/**
+ * @typedef ListingInfo
+ * @property {string} [icon]
+ * @property {string[]} [keywords]
+ * @property {string} [name]
+ * @property {string} [tagline]
+ */
+
+/**
+ * @typedef Organization
+ * @property {string} [name]
+ * @property {string} [slug]
+ */
+
+/**
+ * @typedef Plans
+ * @property {string} [additional_charges]
+ * @property {string} [features]
+ * @property {string} [name]
+ * @property {Price} [price]
+ * @property {Recurring} [recurring]
+ * @property {number} [trial_days]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef Price
+ * @property {number} [amount]
+ * @property {string} [currency]
+ */
+
+/**
+ * @typedef Recurring
+ * @property {number} [recurring_time]
+ * @property {string} [type]
+ * @property {number} [yearly_amount]
+ */
+
+/**
+ * @typedef Screenshots
+ * @property {string[]} [desktop]
+ * @property {string[]} [mobile]
+ */
+
+/**
+ * @typedef Support
+ * @property {string} [email]
+ * @property {string} [faq_url]
+ * @property {string} [phone]
+ * @property {string} [privacy_policy_url]
+ * @property {string} [website_url]
+ */
+
+class PartnerPublicModel {
+  /** @returns {Benefits} */
+  static Benefits() {
+    return Joi.object({
+      description: Joi.string().allow(""),
+      title: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CategoryCommon} */
+  static CategoryCommon() {
+    return Joi.object({
+      category_l1: Joi.array().items(PartnerPublicModel.CategoryL1()),
+      category_l2: Joi.array().items(PartnerPublicModel.CategoryL2()),
+    });
+  }
+
+  /** @returns {CategoryL1} */
+  static CategoryL1() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      display: Joi.string().allow(""),
+      level: Joi.number(),
+      logo: Joi.string().allow(""),
+      slug: Joi.string().allow(""),
+      value: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CategoryL2} */
+  static CategoryL2() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      display: Joi.string().allow(""),
+      level: Joi.number(),
+      parent: Joi.string().allow(""),
+      slug: Joi.string().allow(""),
+      value: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ContactInfo} */
+  static ContactInfo() {
+    return Joi.object({
+      support: PartnerPublicModel.Support(),
+    });
+  }
+
+  /** @returns {Details} */
+  static Details() {
+    return Joi.object({
+      benefits: Joi.array().items(PartnerPublicModel.Benefits()),
+      demo_url: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      integration: Joi.array().items(Joi.string().allow("")),
+      screenshots: PartnerPublicModel.Screenshots(),
+      video_url: Joi.array().items(Joi.any()),
+      youtube: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+
+  /** @returns {ExtensionUsingSlug} */
+  static ExtensionUsingSlug() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      category: PartnerPublicModel.CategoryCommon(),
+      contact_info: PartnerPublicModel.ContactInfo(),
+      created_at: Joi.string().allow(""),
+      current_status: Joi.string().allow(""),
+      details: PartnerPublicModel.Details(),
+      extension_id: Joi.string().allow(""),
+      is_coming_soon: Joi.boolean(),
+      listing_info: PartnerPublicModel.ListingInfo(),
+      modified_at: Joi.string().allow(""),
+      organization: PartnerPublicModel.Organization(),
+      organization_id: Joi.string().allow(""),
+      plan_type: Joi.string().allow(""),
+      plans: Joi.array().items(PartnerPublicModel.Plans()),
+      plans_url: Joi.string().allow(""),
+      review_instructions: Joi.string().allow(""),
+      scope: Joi.array().items(Joi.string().allow("")),
+      slug: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ListingInfo} */
+  static ListingInfo() {
+    return Joi.object({
+      icon: Joi.string().allow(""),
+      keywords: Joi.array().items(Joi.string().allow("")),
+      name: Joi.string().allow(""),
+      tagline: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {Organization} */
+  static Organization() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+      slug: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {Plans} */
+  static Plans() {
+    return Joi.object({
+      additional_charges: Joi.string().allow(""),
+      features: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      price: PartnerPublicModel.Price(),
+      recurring: PartnerPublicModel.Recurring(),
+      trial_days: Joi.number(),
+      type: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {Price} */
+  static Price() {
+    return Joi.object({
+      amount: Joi.number(),
+      currency: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {Recurring} */
+  static Recurring() {
+    return Joi.object({
+      recurring_time: Joi.number(),
+      type: Joi.string().allow(""),
+      yearly_amount: Joi.number(),
+    });
+  }
+
+  /** @returns {Screenshots} */
+  static Screenshots() {
+    return Joi.object({
+      desktop: Joi.array().items(Joi.string().allow("")),
+      mobile: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+
+  /** @returns {Support} */
+  static Support() {
+    return Joi.object({
+      email: Joi.string().allow(""),
+      faq_url: Joi.string().allow(""),
+      phone: Joi.string().allow(""),
+      privacy_policy_url: Joi.string().allow(""),
+      website_url: Joi.string().allow(""),
+    });
+  }
+}
+module.exports = PartnerPublicModel;

package/sdk/public/Partner/PartnerPublicValidator.d.ts

@@ -0,0 +1,18 @@
+export = PartnerPublicValidator;
+/**
+ * @typedef GetPanelExtensionDetailsParam
+ * @property {string} slug - Pass the slug of the extension
+ */
+declare class PartnerPublicValidator {
+    /** @returns {GetPanelExtensionDetailsParam} */
+    static getPanelExtensionDetails(): GetPanelExtensionDetailsParam;
+}
+declare namespace PartnerPublicValidator {
+    export { GetPanelExtensionDetailsParam };
+}
+type GetPanelExtensionDetailsParam = {
+    /**
+     * - Pass the slug of the extension
+     */
+    slug: string;
+};

package/sdk/public/Partner/PartnerPublicValidator.js

@@ -0,0 +1,19 @@
+const Joi = require("joi");
+
+const PartnerPublicModel = require("./PartnerPublicModel");
+
+/**
+ * @typedef GetPanelExtensionDetailsParam
+ * @property {string} slug - Pass the slug of the extension
+ */
+
+class PartnerPublicValidator {
+  /** @returns {GetPanelExtensionDetailsParam} */
+  static getPanelExtensionDetails() {
+    return Joi.object({
+      slug: Joi.string().allow("").required(),
+    }).required();
+  }
+}
+
+module.exports = PartnerPublicValidator;

package/sdk/public/PublicAPIClient.d.ts

@@ -1,4 +1,8 @@
 export = PublicAPIClient;
+/**
+ * @typedef {Object} Options
+ * @property {boolean} responseHeaders - Whether response headers are returned or not.
+ */
 declare class PublicAPIClient {
     /**
      * @param {object} conf
@@ -7,5 +11,14 @@ declare class PublicAPIClient {
      * @param {object} query
      * @param {object} body
      */
-    static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: any): any;
+    static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: any, options: any): any;
 }
+declare namespace PublicAPIClient {
+    export { Options };
+}
+type Options = {
+    /**
+     * - Whether response headers are returned or not.
+     */
+    responseHeaders: boolean;
+};

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

@@ -14,6 +14,7 @@ declare class PublicClient {
     config: import("./PublicConfig");
     configuration: Configuration;
     inventory: Inventory;
+    partner: Partner;
     webhook: Webhook;
     /**
      * Sets the extra headers for the public client.
@@ -25,4 +26,5 @@ declare class PublicClient {
 }
 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,6 +2,8 @@ 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");
@@ -24,6 +26,8 @@ class PublicClient {
 
     this.inventory = new Inventory(config);
 
+    this.partner = new Partner(config);
+
     this.webhook = new Webhook(config);
   }
 

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

@@ -9,22 +9,25 @@ declare class Webhook {
     _urls: {};
     updateUrls(urls: any): void;
     /**
+     * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
      */
-    fetchAllWebhookEvents({ headers }?: any): Promise<WebhookPublicModel.EventConfigResponse>;
+    fetchAllWebhookEvents({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPublicModel.EventConfigResponse>;
     /**
      * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/queryWebhookEventDetails/).
      */
-    queryWebhookEventDetails({ body }?: WebhookPublicValidator.QueryWebhookEventDetailsParam, { headers }?: any): Promise<WebhookPublicModel.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

@@ -32,13 +32,18 @@ class Webhook {
   }
 
   /**
+   * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
    */
-  async fetchAllWebhookEvents({ headers } = { headers: false }) {
+  async fetchAllWebhookEvents(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = WebhookPublicValidator.fetchAllWebhookEvents().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -74,12 +79,12 @@ class Webhook {
       }),
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -102,6 +107,7 @@ class Webhook {
 
   /**
    * @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
@@ -109,8 +115,8 @@ class Webhook {
    * @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 } = {},
-    { headers } = { headers: false }
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
@@ -149,12 +155,12 @@ class Webhook {
       }),
       query_params,
       body,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }