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

package/sdk/public/Content/ContentPublicValidator.js

@@ -37,6 +37,13 @@ const ContentPublicModel = require("./ContentPublicModel");
 
 /** @typedef GetPricingBannerParam */
 
+/** @typedef GetSDKDocumentationParam */
+
+/**
+ * @typedef GetSDKDocumentationByTypeParam
+ * @property {string} type - Type of SDK
+ */
+
 class ContentPublicValidator {
   /** @returns {GetAllTagsParam} */
   static getAllTags() {
@@ -100,6 +107,18 @@ class ContentPublicValidator {
   static getPricingBanner() {
     return Joi.object({});
   }
+
+  /** @returns {GetSDKDocumentationParam} */
+  static getSDKDocumentation() {
+    return Joi.object({});
+  }
+
+  /** @returns {GetSDKDocumentationByTypeParam} */
+  static getSDKDocumentationByType() {
+    return Joi.object({
+      type: Joi.string().allow("").required(),
+    }).required();
+  }
 }
 
 module.exports = ContentPublicValidator;

package/sdk/public/PublicClient.d.ts

@@ -12,7 +12,6 @@ declare class PublicClient {
      */
     constructor(config: import("./PublicConfig"));
     config: import("./PublicConfig");
-    catalog: Catalog;
     configuration: Configuration;
     content: Content;
     partner: Partner;
@@ -25,7 +24,6 @@ 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,5 +1,3 @@
-const Catalog = require("./Catalog/CatalogPublicClient");
-
 const Configuration = require("./Configuration/ConfigurationPublicClient");
 
 const Content = require("./Content/ContentPublicClient");
@@ -24,8 +22,6 @@ 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.EventDetails>} - Success response
+     * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - 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.EventDetails>;
+    fetchAllWebhookEvents({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPublicModel.EventConfigResponse>;
     /**
      * @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.EventDetails>} - Success response
+     * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - 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.EventDetails>;
+    queryWebhookEventDetails({ body, requestHeaders }?: WebhookPublicValidator.QueryWebhookEventDetailsParam, { responseHeaders }?: object): Promise<WebhookPublicModel.EventConfigResponse>;
     /**
      * @param {WebhookPublicValidator.TestHandlerTransformationParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<WebhookPublicModel.TransformEventResult>} - Success response
+     * @returns {Promise<WebhookPublicModel.TransformEventResponse>} - 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.TransformEventResult>;
+    testHandlerTransformation({ body, requestHeaders }?: WebhookPublicValidator.TestHandlerTransformationParam, { responseHeaders }?: object): Promise<WebhookPublicModel.TransformEventResponse>;
     /**
      * @param {WebhookPublicValidator.ValidateSchemaParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<WebhookPublicModel.ValidateSchemaResult>} - Success response
+     * @returns {Promise<WebhookPublicModel.ValidateSchemaResponse>} - 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.ValidateSchemaResult>;
+    validateSchema({ body, requestHeaders }?: WebhookPublicValidator.ValidateSchemaParam, { responseHeaders }?: object): Promise<WebhookPublicModel.ValidateSchemaResponse>;
 }
 import WebhookPublicModel = require("./WebhookPublicModel");
 import WebhookPublicValidator = require("./WebhookPublicValidator");

package/sdk/public/Webhook/WebhookPublicClient.js

@@ -46,7 +46,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.EventDetails>} - Success response
+   * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - 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/).
@@ -109,7 +109,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPublicModel.EventDetails().validate(responseData, {
+    } = WebhookPublicModel.EventConfigResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -218,7 +218,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.EventDetails>} - Success response
+   * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - 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/).
@@ -283,7 +283,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPublicModel.EventDetails().validate(responseData, {
+    } = WebhookPublicModel.EventConfigResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -306,7 +306,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.TransformEventResult>} - Success response
+   * @returns {Promise<WebhookPublicModel.TransformEventResponse>} - 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/).
@@ -371,7 +371,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPublicModel.TransformEventResult().validate(responseData, {
+    } = WebhookPublicModel.TransformEventResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -394,7 +394,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.ValidateSchemaResult>} - Success response
+   * @returns {Promise<WebhookPublicModel.ValidateSchemaResponse>} - 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/).
@@ -457,7 +457,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPublicModel.ValidateSchemaResult().validate(responseData, {
+    } = WebhookPublicModel.ValidateSchemaResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });

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

@@ -1,348 +1,200 @@
 export = WebhookPublicModel;
 /**
  * @typedef EventConfig
- * @property {number} [id] - The unique identifier for the event configuration.
- * @property {string} [event_name] - The name of the event.
- * @property {string} [event_type] - The type of the event.
- * @property {string} [event_category] - The category of the event.
- * @property {Object} [event_schema] - The schema defining the event data structure.
- * @property {string} [version] - The version of the event configuration.
- * @property {string} [display_name] - A user-friendly name for the event.
- * @property {string} [description] - A detailed description of the event.
- * @property {string} [created_on] - The timestamp when the event configuration
- *   was created.
- * @property {string} [updated_on] - The timestamp when the event configuration
- *   was last updated.
- * @property {string} [group] - The group to which the event belongs.
+ * @property {number} [id]
+ * @property {string} [event_name]
+ * @property {string} [event_type]
+ * @property {string} [event_category]
+ * @property {Object} [event_schema]
+ * @property {string} [version]
+ * @property {string} [display_name]
+ * @property {string} [description]
+ * @property {string} [created_on]
+ * @property {string} [updated_on]
+ * @property {string} [group]
  */
 /**
- * @typedef EventDetails
- * @property {EventConfig[]} [event_configs] - A list of event configuration details.
+ * @typedef EventConfigResponse
+ * @property {EventConfig[]} [event_configs]
  */
 /**
  * @typedef EventConfigBase
- * @property {string} [event_name] - The name of the event.
- * @property {string} [event_type] - The type of the event.
- * @property {string} [event_category] - The category of the event.
- * @property {string} [version] - The version of the event configuration.
+ * @property {string} [event_name]
+ * @property {string} [event_type]
+ * @property {string} [event_category]
+ * @property {string} [version]
  */
 /**
  * @typedef EventNotifier
- * @property {string} [message] - The message to be sent in the notification.
- * @property {string[]} [emails] - List of email addresses to notify.
+ * @property {string} [message]
+ * @property {string[]} [emails]
  */
 /**
  * @typedef EventSchema
- * @property {Object} [payload] - The event data payload.
- * @property {Object} [meta] - Metadata related to the event.
+ * @property {Object} [payload]
+ * @property {Object} [meta]
  */
 /**
  * @typedef InternalTransformEvent
- * @property {string[]} [trace_id] - List of trace IDs related to the event.
- * @property {string} [name] - The name of the transformation event.
- * @property {string} [type] - The type of the transformation event.
- * @property {string} [version] - The version of the transformation event.
- * @property {number} [created_timestamp] - The timestamp when the event was created.
+ * @property {string[]} [trace_id]
+ * @property {string} [name]
+ * @property {string} [type]
+ * @property {string} [version]
+ * @property {number} [created_timestamp]
  */
 /**
  * @typedef TransformEventData
  * @property {InternalTransformEvent} [event]
- * @property {number} [company_id] - The company ID associated with the event.
- * @property {string[]} [contains] - List of strings related to the event.
- * @property {Object} [payload] - Event data payload.
+ * @property {number} [company_id]
+ * @property {string[]} [contains]
+ * @property {Object} [payload]
  */
 /**
  * @typedef TransformEventServiceMeta
- * @property {string} [name] - The name of the transformation service.
+ * @property {string} [name]
  */
 /**
  * @typedef TransformEventAssociation
- * @property {number} [company_id] - The company ID associated with the event.
+ * @property {number} [company_id]
  */
 /**
- * @typedef TransformEventPayload
- * @property {string} event_name - The name of the event.
- * @property {string} event_type - The type of the event.
- * @property {string} event_category - The category of the event.
- * @property {string} event_version - The version of the event.
+ * @typedef TransformEventRequest
+ * @property {string} event_name
+ * @property {string} event_type
+ * @property {string} event_category
+ * @property {string} event_version
  * @property {EventSchema} event
  */
 /**
- * @typedef ValidateSchemaPayload
- * @property {string} event_name - The name of the event to validate.
- * @property {string} event_type - The type of the event.
- * @property {string} event_category - The category of the event.
- * @property {string} event_version - The version of the event to validate.
+ * @typedef ValidateSchemaRequest
+ * @property {string} event_name
+ * @property {string} event_type
+ * @property {string} event_category
+ * @property {string} event_version
  * @property {EventSchema} event
- * @property {Object} event_schema - The schema defining the structure of the event.
+ * @property {Object} event_schema
  */
 /**
- * @typedef ValidateSchemaResult
- * @property {boolean} [status] - Indicates whether the schema is valid (true)
- *   or invalid (false).
- * @property {string} [message] - A message providing additional details about
- *   the validation result.
+ * @typedef ValidateSchemaResponse
+ * @property {boolean} [status]
+ * @property {string} [message]
  */
 /**
- * @typedef TransformEventResult
- * @property {string[]} [event_trace_id] - List of trace IDs related to the
- *   transformation event.
+ * @typedef TransformEventResponse
+ * @property {string[]} [event_trace_id]
  * @property {TransformEventData} [data]
- * @property {string} [event_name] - The name of the transformation event.
- * @property {string} [version] - The version of the transformation event.
- * @property {boolean} [status] - The status of the event processing.
- * @property {string} [event_type] - The type of the transformation event.
+ * @property {string} [event_name]
+ * @property {string} [version]
+ * @property {boolean} [status]
+ * @property {string} [event_type]
  * @property {TransformEventServiceMeta} [service_meta]
  * @property {TransformEventAssociation} [association]
  */
 declare class WebhookPublicModel {
 }
 declare namespace WebhookPublicModel {
-    export { EventConfig, EventDetails, EventConfigBase, EventNotifier, EventSchema, InternalTransformEvent, TransformEventData, TransformEventServiceMeta, TransformEventAssociation, TransformEventPayload, ValidateSchemaPayload, ValidateSchemaResult, TransformEventResult };
+    export { EventConfig, EventConfigResponse, EventConfigBase, EventNotifier, EventSchema, InternalTransformEvent, TransformEventData, TransformEventServiceMeta, TransformEventAssociation, TransformEventRequest, ValidateSchemaRequest, ValidateSchemaResponse, TransformEventResponse };
 }
 /** @returns {EventConfig} */
 declare function EventConfig(): EventConfig;
 type EventConfig = {
-    /**
-     * - The unique identifier for the event configuration.
-     */
     id?: number;
-    /**
-     * - The name of the event.
-     */
     event_name?: string;
-    /**
-     * - The type of the event.
-     */
     event_type?: string;
-    /**
-     * - The category of the event.
-     */
     event_category?: string;
-    /**
-     * - The schema defining the event data structure.
-     */
     event_schema?: any;
-    /**
-     * - The version of the event configuration.
-     */
     version?: string;
-    /**
-     * - A user-friendly name for the event.
-     */
     display_name?: string;
-    /**
-     * - A detailed description of the event.
-     */
     description?: string;
-    /**
-     * - The timestamp when the event configuration
-     * was created.
-     */
     created_on?: string;
-    /**
-     * - The timestamp when the event configuration
-     * was last updated.
-     */
     updated_on?: string;
-    /**
-     * - The group to which the event belongs.
-     */
     group?: string;
 };
-/** @returns {EventDetails} */
-declare function EventDetails(): EventDetails;
-type EventDetails = {
-    /**
-     * - A list of event configuration details.
-     */
+/** @returns {EventConfigResponse} */
+declare function EventConfigResponse(): EventConfigResponse;
+type EventConfigResponse = {
     event_configs?: EventConfig[];
 };
 /** @returns {EventConfigBase} */
 declare function EventConfigBase(): EventConfigBase;
 type EventConfigBase = {
-    /**
-     * - The name of the event.
-     */
     event_name?: string;
-    /**
-     * - The type of the event.
-     */
     event_type?: string;
-    /**
-     * - The category of the event.
-     */
     event_category?: string;
-    /**
-     * - The version of the event configuration.
-     */
     version?: string;
 };
 /** @returns {EventNotifier} */
 declare function EventNotifier(): EventNotifier;
 type EventNotifier = {
-    /**
-     * - The message to be sent in the notification.
-     */
     message?: string;
-    /**
-     * - List of email addresses to notify.
-     */
     emails?: string[];
 };
 /** @returns {EventSchema} */
 declare function EventSchema(): EventSchema;
 type EventSchema = {
-    /**
-     * - The event data payload.
-     */
     payload?: any;
-    /**
-     * - Metadata related to the event.
-     */
     meta?: any;
 };
 /** @returns {InternalTransformEvent} */
 declare function InternalTransformEvent(): InternalTransformEvent;
 type InternalTransformEvent = {
-    /**
-     * - List of trace IDs related to the event.
-     */
     trace_id?: string[];
-    /**
-     * - The name of the transformation event.
-     */
     name?: string;
-    /**
-     * - The type of the transformation event.
-     */
     type?: string;
-    /**
-     * - The version of the transformation event.
-     */
     version?: string;
-    /**
-     * - The timestamp when the event was created.
-     */
     created_timestamp?: number;
 };
 /** @returns {TransformEventData} */
 declare function TransformEventData(): TransformEventData;
 type TransformEventData = {
     event?: InternalTransformEvent;
-    /**
-     * - The company ID associated with the event.
-     */
     company_id?: number;
-    /**
-     * - List of strings related to the event.
-     */
     contains?: string[];
-    /**
-     * - Event data payload.
-     */
     payload?: any;
 };
 /** @returns {TransformEventServiceMeta} */
 declare function TransformEventServiceMeta(): TransformEventServiceMeta;
 type TransformEventServiceMeta = {
-    /**
-     * - The name of the transformation service.
-     */
     name?: string;
 };
 /** @returns {TransformEventAssociation} */
 declare function TransformEventAssociation(): TransformEventAssociation;
 type TransformEventAssociation = {
-    /**
-     * - The company ID associated with the event.
-     */
     company_id?: number;
 };
-/** @returns {TransformEventPayload} */
-declare function TransformEventPayload(): TransformEventPayload;
-type TransformEventPayload = {
-    /**
-     * - The name of the event.
-     */
+/** @returns {TransformEventRequest} */
+declare function TransformEventRequest(): TransformEventRequest;
+type TransformEventRequest = {
     event_name: string;
-    /**
-     * - The type of the event.
-     */
     event_type: string;
-    /**
-     * - The category of the event.
-     */
     event_category: string;
-    /**
-     * - The version of the event.
-     */
     event_version: string;
     event: EventSchema;
 };
-/** @returns {ValidateSchemaPayload} */
-declare function ValidateSchemaPayload(): ValidateSchemaPayload;
-type ValidateSchemaPayload = {
-    /**
-     * - The name of the event to validate.
-     */
+/** @returns {ValidateSchemaRequest} */
+declare function ValidateSchemaRequest(): ValidateSchemaRequest;
+type ValidateSchemaRequest = {
     event_name: string;
-    /**
-     * - The type of the event.
-     */
     event_type: string;
-    /**
-     * - The category of the event.
-     */
     event_category: string;
-    /**
-     * - The version of the event to validate.
-     */
     event_version: string;
     event: EventSchema;
-    /**
-     * - The schema defining the structure of the event.
-     */
     event_schema: any;
 };
-/** @returns {ValidateSchemaResult} */
-declare function ValidateSchemaResult(): ValidateSchemaResult;
-type ValidateSchemaResult = {
-    /**
-     * - Indicates whether the schema is valid (true)
-     * or invalid (false).
-     */
+/** @returns {ValidateSchemaResponse} */
+declare function ValidateSchemaResponse(): ValidateSchemaResponse;
+type ValidateSchemaResponse = {
     status?: boolean;
-    /**
-     * - A message providing additional details about
-     * the validation result.
-     */
     message?: string;
 };
-/** @returns {TransformEventResult} */
-declare function TransformEventResult(): TransformEventResult;
-type TransformEventResult = {
-    /**
-     * - List of trace IDs related to the
-     * transformation event.
-     */
+/** @returns {TransformEventResponse} */
+declare function TransformEventResponse(): TransformEventResponse;
+type TransformEventResponse = {
     event_trace_id?: string[];
     data?: TransformEventData;
-    /**
-     * - The name of the transformation event.
-     */
     event_name?: string;
-    /**
-     * - The version of the transformation event.
-     */
     version?: string;
-    /**
-     * - The status of the event processing.
-     */
     status?: boolean;
-    /**
-     * - The type of the transformation event.
-     */
     event_type?: string;
     service_meta?: TransformEventServiceMeta;
     association?: TransformEventAssociation;