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

package/sdk/public/Partner/PartnerPublicModel.js

@@ -2,29 +2,24 @@ const Joi = require("joi");
 
 /**
  * @typedef CategoryL1
- * @property {string} [description]
- * @property {string} [display]
- * @property {number} [level]
- * @property {string} [logo]
- * @property {string} [slug]
- * @property {string} [value]
- * @property {string} [_id]
+ * @property {string} [slug] - URL-friendly identifier for the category.
+ * @property {string} [_id] - Unique identifier for the level 1 category.
  */
 
 /**
  * @typedef CategoryL2
- * @property {string} [parent]
- * @property {string} [display]
- * @property {number} [level]
- * @property {string} [slug]
- * @property {string} [value]
- * @property {string} [_id]
+ * @property {string} [parent] - ID of the parent category (Level 1) to which
+ *   this category belongs.
+ * @property {string} [slug] - URL-friendly identifier for the category.
+ * @property {string} [_id] - Unique identifier for the level 2 category.
  */
 
 /**
  * @typedef CategoryCommon
- * @property {CategoryL1[]} [category_l1]
- * @property {CategoryL2[]} [category_l2]
+ * @property {CategoryL1[]} [categories_l1] - Array of level 1 categories
+ *   associated with an extension.
+ * @property {CategoryL2[]} [categories_l2] - Array of level 2 categories
+ *   associated with an extension.
  */
 
 /**
@@ -32,108 +27,117 @@ const Joi = require("joi");
  * @property {Support} [support]
  */
 
+/**
+ * @typedef CommingSoon
+ * @property {boolean} [is_coming_soon] - Flag indicating whether the extension
+ *   is marked as "coming soon."
+ * @property {number} [upvote_count] - Number of upvotes for the "coming soon" extension.
+ */
+
 /**
  * @typedef ExtensionUsingSlug
  * @property {CategoryCommon} [category]
  * @property {ContactInfo} [contact_info]
- * @property {string} [created_at]
- * @property {string} [current_status]
+ * @property {string} [created_at] - Timestamp indicating when the extension was created.
+ * @property {string} [current_status] - Current status of the extension.
  * @property {Details} [details]
- * @property {string} [extension_id]
- * @property {boolean} [is_coming_soon]
+ * @property {string} [extension_id] - Unique identifier for the extension.
+ * @property {CommingSoon} [coming_soon]
  * @property {ListingInfo} [listing_info]
- * @property {string} [modified_at]
+ * @property {string} [modified_at] - Timestamp indicating when the extension
+ *   was last modified.
  * @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]
- * @property {string} [_id]
+ * @property {string} [organization_id] - Unique identifier for the organization
+ *   where the extension is created.
+ * @property {string} [plan_type] - Type of pricing plan for the extension
+ *   (e.g., free, one-time, recurring).
+ * @property {Plans[]} [plans] - Array of pricing plans associated with the extension.
+ * @property {string} [plans_url] - URL to access detailed pricing plan information.
+ * @property {string[]} [scope] - Array of permissions or scopes required by the
+ *   extension.
+ * @property {string} [slug] - URL-friendly identifier for the extension.
+ * @property {string} [_id] - Unique identifier for the extension.
  */
 
 /**
  * @typedef Organization
- * @property {string} [name]
- * @property {string} [slug]
+ * @property {string} [name] - Name of the organization.
+ * @property {string} [slug] - URL-friendly identifier for the organization.
  */
 
 /**
  * @typedef ListingInfo
- * @property {string} [icon]
- * @property {string[]} [keywords]
- * @property {string} [name]
- * @property {string} [tagline]
+ * @property {string} [icon] - URL for the extension's icon.
+ * @property {string[]} [keywords] - Array of keywords associated with the extension.
+ * @property {string} [name] - Display name of the extension.
+ * @property {string} [tagline] - Short tagline summarizing the extension's purpose.
  */
 
 /**
  * @typedef Benefits
- * @property {string} [title]
- * @property {string} [description]
+ * @property {string} [title] - Title of the benefit offered by the extension.
+ * @property {string} [description] - Detailed explanation of the benefit.
  */
 
 /**
  * @typedef Screenshots
- * @property {string[]} [desktop]
- * @property {string[]} [mobile]
+ * @property {string[]} [desktop] - Array of URLs for desktop screenshots.
+ * @property {string[]} [mobile] - Array of URLs for mobile screenshots.
  */
 
 /**
  * @typedef Details
- * @property {Benefits[]} [benefits]
- * @property {string} [demo_url]
- * @property {string} [description]
- * @property {string[]} [integration]
- * @property {Object[]} [video_url]
- * @property {string[]} [youtube]
+ * @property {Benefits[]} [benefits] - Array of benefits provided by the extension.
+ * @property {string} [demo_url] - URL for a demo or preview of the extension.
+ * @property {string} [description] - Detailed description of the extension.
+ * @property {string[]} [integration] - Array of integration points supported by
+ *   the extension.
+ * @property {Object[]} [video_url] - Array of video URLs showcasing the extension.
+ * @property {string[]} [youtube] - Array of YouTube video URLs about the extension.
  * @property {Screenshots} [screenshots]
  */
 
 /**
  * @typedef Support
- * @property {string} [email]
- * @property {string} [faq_url]
- * @property {string} [phone]
- * @property {string} [privacy_policy_url]
- * @property {string} [website_url]
+ * @property {string} [email] - Support email address.
+ * @property {string} [faq_url] - URL for the FAQ page.
+ * @property {string} [phone] - Support phone number.
+ * @property {string} [privacy_policy_url] - URL for the privacy policy.
+ * @property {string} [website_url] - Official website URL.
+ * @property {string} [terms_of_service] - URL for the terms of service.
+ * @property {string} [country_code] - The dialing code for the country, used
+ *   with mobile numbers.
  */
 
 /**
  * @typedef Price
- * @property {number} [amount]
- * @property {string} [currency]
+ * @property {number} [amount] - Amount for the pricing.
+ * @property {string} [currency] - Currency in which the price is specified.
  */
 
 /**
  * @typedef Plans
- * @property {string} [additional_charges]
- * @property {string} [features]
- * @property {string} [name]
- * @property {number} [trial_days]
- * @property {string} [type]
+ * @property {string} [additional_charges] - Additional charges applicable to the plan.
+ * @property {string} [features] - Features included in the plan.
+ * @property {string} [name] - Name of the plan.
+ * @property {number} [trial_days] - Number of trial days offered with the plan.
+ * @property {string} [type] - Type of plan (e.g., free, recurring, one-time).
  * @property {Price} [price]
  * @property {Recurring} [recurring]
  */
 
 /**
  * @typedef Recurring
- * @property {number} [recurring_time]
- * @property {number} [yearly_amount]
- * @property {string} [type]
+ * @property {number} [recurring_time] - Frequency of the recurring charge in days.
+ * @property {number} [yearly_amount] - Total yearly amount for the recurring plan.
+ * @property {string} [type] - Type of recurring plan (e.g., monthly, yearly).
  */
 
 class PartnerPublicModel {
   /** @returns {CategoryL1} */
   static CategoryL1() {
     return Joi.object({
-      description: Joi.string().allow(""),
-      display: Joi.string().allow(""),
-      level: Joi.number(),
-      logo: Joi.string().allow(""),
       slug: Joi.string().allow(""),
-      value: Joi.string().allow(""),
       _id: Joi.string().allow(""),
     });
   }
@@ -142,10 +146,7 @@ class PartnerPublicModel {
   static CategoryL2() {
     return Joi.object({
       parent: Joi.string().allow(""),
-      display: Joi.string().allow(""),
-      level: Joi.number(),
       slug: Joi.string().allow(""),
-      value: Joi.string().allow(""),
       _id: Joi.string().allow(""),
     });
   }
@@ -153,8 +154,8 @@ class PartnerPublicModel {
   /** @returns {CategoryCommon} */
   static CategoryCommon() {
     return Joi.object({
-      category_l1: Joi.array().items(PartnerPublicModel.CategoryL1()),
-      category_l2: Joi.array().items(PartnerPublicModel.CategoryL2()),
+      categories_l1: Joi.array().items(PartnerPublicModel.CategoryL1()),
+      categories_l2: Joi.array().items(PartnerPublicModel.CategoryL2()),
     });
   }
 
@@ -165,6 +166,14 @@ class PartnerPublicModel {
     });
   }
 
+  /** @returns {CommingSoon} */
+  static CommingSoon() {
+    return Joi.object({
+      is_coming_soon: Joi.boolean(),
+      upvote_count: Joi.number(),
+    });
+  }
+
   /** @returns {ExtensionUsingSlug} */
   static ExtensionUsingSlug() {
     return Joi.object({
@@ -174,7 +183,7 @@ class PartnerPublicModel {
       current_status: Joi.string().allow(""),
       details: PartnerPublicModel.Details(),
       extension_id: Joi.string().allow(""),
-      is_coming_soon: Joi.boolean(),
+      coming_soon: PartnerPublicModel.CommingSoon(),
       listing_info: PartnerPublicModel.ListingInfo(),
       modified_at: Joi.string().allow(""),
       organization: PartnerPublicModel.Organization(),
@@ -182,7 +191,6 @@ class PartnerPublicModel {
       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(""),
       _id: Joi.string().allow(""),
@@ -244,6 +252,8 @@ class PartnerPublicModel {
       phone: Joi.string().allow(""),
       privacy_policy_url: Joi.string().allow(""),
       website_url: Joi.string().allow(""),
+      terms_of_service: Joi.string().allow(""),
+      country_code: Joi.string().allow(""),
     });
   }
 

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

@@ -1,7 +1,7 @@
 export = PartnerPublicValidator;
 /**
  * @typedef GetPanelExtensionDetailsParam
- * @property {string} slug - Pass the slug of the extension
+ * @property {string} slug - Slug of the extension
  */
 declare class PartnerPublicValidator {
     /** @returns {GetPanelExtensionDetailsParam} */
@@ -12,7 +12,7 @@ declare namespace PartnerPublicValidator {
 }
 type GetPanelExtensionDetailsParam = {
     /**
-     * - Pass the slug of the extension
+     * - Slug of the extension
      */
     slug: string;
 };

package/sdk/public/Partner/PartnerPublicValidator.js

@@ -4,7 +4,7 @@ const PartnerPublicModel = require("./PartnerPublicModel");
 
 /**
  * @typedef GetPanelExtensionDetailsParam
- * @property {string} slug - Pass the slug of the extension
+ * @property {string} slug - Slug of the extension
  */
 
 class PartnerPublicValidator {

package/sdk/public/PublicClient.d.ts

@@ -12,6 +12,7 @@ declare class PublicClient {
      */
     constructor(config: import("./PublicConfig"));
     config: import("./PublicConfig");
+    catalog: Catalog;
     configuration: Configuration;
     content: Content;
     partner: Partner;
@@ -24,6 +25,7 @@ declare class PublicClient {
      */
     setExtraHeaders(header: object): void;
 }
+import Catalog = require("./Catalog/CatalogPublicClient");
 import Configuration = require("./Configuration/ConfigurationPublicClient");
 import Content = require("./Content/ContentPublicClient");
 import Partner = require("./Partner/PartnerPublicClient");

package/sdk/public/PublicClient.js

@@ -1,3 +1,5 @@
+const Catalog = require("./Catalog/CatalogPublicClient");
+
 const Configuration = require("./Configuration/ConfigurationPublicClient");
 
 const Content = require("./Content/ContentPublicClient");
@@ -22,6 +24,8 @@ class PublicClient {
   constructor(config) {
     this.config = config;
 
+    this.catalog = new Catalog(config);
+
     this.configuration = new Configuration(config);
 
     this.content = new Content(config);

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

@@ -15,12 +15,12 @@ declare 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
+     * @returns {Promise<WebhookPublicModel.EventDetails>} - Success response
      * @name fetchAllWebhookEvents
      * @summary: Fetch all webhook events.
      * @description: Retrieve a list of all webhook events in the public server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
      */
-    fetchAllWebhookEvents({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPublicModel.EventConfigResponse>;
+    fetchAllWebhookEvents({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPublicModel.EventDetails>;
     /**
      * @param {WebhookPublicValidator.NotifyDepricatedEventParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -35,32 +35,32 @@ declare 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
+     * @returns {Promise<WebhookPublicModel.EventDetails>} - Success response
      * @name queryWebhookEventDetails
      * @summary: Query webhook event details.
      * @description: Query and obtain detailed information about webhook events in the public server configurations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/queryWebhookEventDetails/).
      */
-    queryWebhookEventDetails({ body, requestHeaders }?: WebhookPublicValidator.QueryWebhookEventDetailsParam, { responseHeaders }?: object): Promise<WebhookPublicModel.EventConfigResponse>;
+    queryWebhookEventDetails({ body, requestHeaders }?: WebhookPublicValidator.QueryWebhookEventDetailsParam, { responseHeaders }?: object): Promise<WebhookPublicModel.EventDetails>;
     /**
      * @param {WebhookPublicValidator.TestHandlerTransformationParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<WebhookPublicModel.TransformEventResponse>} - Success response
+     * @returns {Promise<WebhookPublicModel.TransformEventResult>} - Success response
      * @name testHandlerTransformation
      * @summary: Test transformation of handler
      * @description: Test transformation of handler - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/testHandlerTransformation/).
      */
-    testHandlerTransformation({ body, requestHeaders }?: WebhookPublicValidator.TestHandlerTransformationParam, { responseHeaders }?: object): Promise<WebhookPublicModel.TransformEventResponse>;
+    testHandlerTransformation({ body, requestHeaders }?: WebhookPublicValidator.TestHandlerTransformationParam, { responseHeaders }?: object): Promise<WebhookPublicModel.TransformEventResult>;
     /**
      * @param {WebhookPublicValidator.ValidateSchemaParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<WebhookPublicModel.ValidateSchemaResponse>} - Success response
+     * @returns {Promise<WebhookPublicModel.ValidateSchemaResult>} - Success response
      * @name validateSchema
      * @summary: Validate Schema for an event
      * @description: Validate Schema for an event - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/validateSchema/).
      */
-    validateSchema({ body, requestHeaders }?: WebhookPublicValidator.ValidateSchemaParam, { responseHeaders }?: object): Promise<WebhookPublicModel.ValidateSchemaResponse>;
+    validateSchema({ body, requestHeaders }?: WebhookPublicValidator.ValidateSchemaParam, { responseHeaders }?: object): Promise<WebhookPublicModel.ValidateSchemaResult>;
 }
 import WebhookPublicModel = require("./WebhookPublicModel");
 import WebhookPublicValidator = require("./WebhookPublicValidator");

package/sdk/public/Webhook/WebhookPublicClient.js

@@ -6,6 +6,7 @@ const {
 const PublicAPIClient = require("../PublicAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
 
 const WebhookPublicValidator = require("./WebhookPublicValidator");
 const WebhookPublicModel = require("./WebhookPublicModel");
@@ -46,7 +47,7 @@ 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
+   * @returns {Promise<WebhookPublicModel.EventDetails>} - Success response
    * @name fetchAllWebhookEvents
    * @summary: Fetch all webhook events.
    * @description: Retrieve a list of all webhook events in the public server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
@@ -55,14 +56,6 @@ class Webhook {
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const { error } = WebhookPublicValidator.fetchAllWebhookEvents().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -109,7 +102,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPublicModel.EventConfigResponse().validate(responseData, {
+    } = WebhookPublicModel.EventDetails().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -141,14 +134,6 @@ class Webhook {
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const { error } = WebhookPublicValidator.notifyDepricatedEvent().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -218,7 +203,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
+   * @returns {Promise<WebhookPublicModel.EventDetails>} - Success response
    * @name queryWebhookEventDetails
    * @summary: Query webhook event details.
    * @description: Query and obtain detailed information about webhook events in the public server configurations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/queryWebhookEventDetails/).
@@ -227,14 +212,6 @@ class Webhook {
     { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const {
       error,
     } = WebhookPublicValidator.queryWebhookEventDetails().validate(
@@ -283,7 +260,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPublicModel.EventConfigResponse().validate(responseData, {
+    } = WebhookPublicModel.EventDetails().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -306,7 +283,7 @@ class Webhook {
    * @param {WebhookPublicValidator.TestHandlerTransformationParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PublicAPIClient").Options} - Options
-   * @returns {Promise<WebhookPublicModel.TransformEventResponse>} - Success response
+   * @returns {Promise<WebhookPublicModel.TransformEventResult>} - Success response
    * @name testHandlerTransformation
    * @summary: Test transformation of handler
    * @description: Test transformation of handler - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/testHandlerTransformation/).
@@ -315,14 +292,6 @@ class Webhook {
     { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const {
       error,
     } = WebhookPublicValidator.testHandlerTransformation().validate(
@@ -371,7 +340,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPublicModel.TransformEventResponse().validate(responseData, {
+    } = WebhookPublicModel.TransformEventResult().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -394,7 +363,7 @@ class Webhook {
    * @param {WebhookPublicValidator.ValidateSchemaParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PublicAPIClient").Options} - Options
-   * @returns {Promise<WebhookPublicModel.ValidateSchemaResponse>} - Success response
+   * @returns {Promise<WebhookPublicModel.ValidateSchemaResult>} - Success response
    * @name validateSchema
    * @summary: Validate Schema for an event
    * @description: Validate Schema for an event - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/validateSchema/).
@@ -403,14 +372,6 @@ class Webhook {
     { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const { error } = WebhookPublicValidator.validateSchema().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
@@ -457,7 +418,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPublicModel.ValidateSchemaResponse().validate(responseData, {
+    } = WebhookPublicModel.ValidateSchemaResult().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });