@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/sdk/public/Partner/PartnerPublicClient.js

@@ -0,0 +1,110 @@
+const PublicAPIClient = require("../PublicAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const constructUrl = require("../constructUrl");
+const Paginator = require("../../common/Paginator");
+const PartnerPublicValidator = require("./PartnerPublicValidator");
+const PartnerPublicModel = require("./PartnerPublicModel");
+const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
+
+class Partner {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      getPanelExtensionDetails:
+        "/service/panel/partners/v1.0/extensions/{slug}",
+    };
+    this._urls = Object.entries(this._relativeUrls).reduce(
+      (urls, [method, relativeUrl]) => {
+        urls[method] = `${_conf.domain}${relativeUrl}`;
+        return urls;
+      },
+      {}
+    );
+  }
+
+  updateUrls(urls) {
+    this._urls = {
+      ...this._urls,
+      ...urls,
+    };
+  }
+
+  /**
+   * @param {PartnerPublicValidator.GetPanelExtensionDetailsParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<PartnerPublicModel.ExtensionUsingSlug>} - Success response
+   * @name getPanelExtensionDetails
+   * @summary: Get extension details
+   * @description: Use this API to get extension details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/partner/getPanelExtensionDetails/).
+   */
+  async getPanelExtensionDetails(
+    { slug, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = PartnerPublicValidator.getPanelExtensionDetails().validate(
+      { slug },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = PartnerPublicValidator.getPanelExtensionDetails().validate(
+      { slug },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for public > Partner > getPanelExtensionDetails \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getPanelExtensionDetails"],
+        params: { slug },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = PartnerPublicModel.ExtensionUsingSlug().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: `Response Validation Warnnings for public > Partner > getPanelExtensionDetails \n ${res_error}`,
+      });
+    }
+
+    return response;
+  }
+}
+
+module.exports = Partner;

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

@@ -0,0 +1,240 @@
+export = PartnerPublicModel;
+/**
+ * @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]
+ */
+declare class PartnerPublicModel {
+}
+declare namespace PartnerPublicModel {
+    export { Benefits, CategoryCommon, CategoryL1, CategoryL2, ContactInfo, Details, ExtensionUsingSlug, ListingInfo, Organization, Plans, Price, Recurring, Screenshots, Support };
+}
+/** @returns {Benefits} */
+declare function Benefits(): Benefits;
+type Benefits = {
+    description?: string;
+    title?: string;
+};
+/** @returns {CategoryCommon} */
+declare function CategoryCommon(): CategoryCommon;
+type CategoryCommon = {
+    category_l1?: CategoryL1[];
+    category_l2?: CategoryL2[];
+};
+/** @returns {CategoryL1} */
+declare function CategoryL1(): CategoryL1;
+type CategoryL1 = {
+    _id?: string;
+    description?: string;
+    display?: string;
+    level?: number;
+    logo?: string;
+    slug?: string;
+    value?: string;
+};
+/** @returns {CategoryL2} */
+declare function CategoryL2(): CategoryL2;
+type CategoryL2 = {
+    _id?: string;
+    display?: string;
+    level?: number;
+    parent?: string;
+    slug?: string;
+    value?: string;
+};
+/** @returns {ContactInfo} */
+declare function ContactInfo(): ContactInfo;
+type ContactInfo = {
+    support?: Support;
+};
+/** @returns {Details} */
+declare function Details(): Details;
+type Details = {
+    benefits?: Benefits[];
+    demo_url?: string;
+    description?: string;
+    integration?: string[];
+    screenshots?: Screenshots;
+    video_url?: any[];
+    youtube?: string[];
+};
+/** @returns {ExtensionUsingSlug} */
+declare function ExtensionUsingSlug(): ExtensionUsingSlug;
+type ExtensionUsingSlug = {
+    _id?: string;
+    category?: CategoryCommon;
+    contact_info?: ContactInfo;
+    created_at?: string;
+    current_status?: string;
+    details?: Details;
+    extension_id?: string;
+    is_coming_soon?: boolean;
+    listing_info?: ListingInfo;
+    modified_at?: string;
+    organization?: Organization;
+    organization_id?: string;
+    plan_type?: string;
+    plans?: Plans[];
+    plans_url?: string;
+    review_instructions?: string;
+    scope?: string[];
+    slug?: string;
+};
+/** @returns {ListingInfo} */
+declare function ListingInfo(): ListingInfo;
+type ListingInfo = {
+    icon?: string;
+    keywords?: string[];
+    name?: string;
+    tagline?: string;
+};
+/** @returns {Organization} */
+declare function Organization(): Organization;
+type Organization = {
+    name?: string;
+    slug?: string;
+};
+/** @returns {Plans} */
+declare function Plans(): Plans;
+type Plans = {
+    additional_charges?: string;
+    features?: string;
+    name?: string;
+    price?: Price;
+    recurring?: Recurring;
+    trial_days?: number;
+    type?: string;
+};
+/** @returns {Price} */
+declare function Price(): Price;
+type Price = {
+    amount?: number;
+    currency?: string;
+};
+/** @returns {Recurring} */
+declare function Recurring(): Recurring;
+type Recurring = {
+    recurring_time?: number;
+    type?: string;
+    yearly_amount?: number;
+};
+/** @returns {Screenshots} */
+declare function Screenshots(): Screenshots;
+type Screenshots = {
+    desktop?: string[];
+    mobile?: string[];
+};
+/** @returns {Support} */
+declare function Support(): Support;
+type Support = {
+    email?: string;
+    faq_url?: string;
+    phone?: string;
+    privacy_policy_url?: string;
+    website_url?: string;
+};

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;
+};