@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.5

package/sdk/platform/Webhook/WebhookPlatformModel.d.ts

@@ -203,6 +203,33 @@ export = WebhookPlatformModel;
  * @property {string} [type]
  * @property {string} [secret]
  */
+/**
+ * @typedef SubscriberFailureResponse
+ * @property {string} [message]
+ * @property {string} [code]
+ * @property {string} [stack]
+ */
+/**
+ * @typedef EventConfigs
+ * @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 {SubscriberEventMapping} [subscriber_event_mapping]
+ */
+/**
+ * @typedef SubscriberEventMapping
+ * @property {number} [id]
+ * @property {number} [event_id]
+ * @property {number} [subscriber_id]
+ * @property {string} [created_on]
+ */
 /**
  * @typedef SubscriberResponse
  * @property {number} [id]
@@ -256,7 +283,7 @@ export = WebhookPlatformModel;
 declare class WebhookPlatformModel {
 }
 declare namespace WebhookPlatformModel {
-    export { Error, Event, RetryEventRequest, Item, RetryCountResponse, RetrySuccessResponse, Err, RetryFailureResponse, RetryStatusResponse, EventProcessRequest, DownloadReportResponse, EventProcessReports, EventProcessReportObject, Page, PingWebhook, PingWebhookResponse, EventConfig, EventConfigResponse, ReportFiltersPayload, ReportFilterResponse, HistoryPayload, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResponse, CancelResponse, Association, AuthMeta, SubscriberResponse, SubscriberConfig, SubscriberConfigResponse, SubscriberConfigList, SubscriberStatus };
+    export { Error, Event, RetryEventRequest, Item, RetryCountResponse, RetrySuccessResponse, Err, RetryFailureResponse, RetryStatusResponse, EventProcessRequest, DownloadReportResponse, EventProcessReports, EventProcessReportObject, Page, PingWebhook, PingWebhookResponse, EventConfig, EventConfigResponse, ReportFiltersPayload, ReportFilterResponse, HistoryPayload, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResponse, CancelResponse, Association, AuthMeta, SubscriberFailureResponse, EventConfigs, SubscriberEventMapping, SubscriberResponse, SubscriberConfig, SubscriberConfigResponse, SubscriberConfigList, SubscriberStatus };
 }
 /** @returns {Error} */
 declare function Error(): Error;
@@ -610,6 +637,36 @@ type AuthMeta = {
     type?: string;
     secret?: string;
 };
+/** @returns {SubscriberFailureResponse} */
+declare function SubscriberFailureResponse(): SubscriberFailureResponse;
+type SubscriberFailureResponse = {
+    message?: string;
+    code?: string;
+    stack?: string;
+};
+/** @returns {EventConfigs} */
+declare function EventConfigs(): EventConfigs;
+type EventConfigs = {
+    id?: number;
+    event_name?: string;
+    event_type?: string;
+    event_category?: string;
+    event_schema?: any;
+    version?: string;
+    display_name?: string;
+    description?: string;
+    created_on?: string;
+    updated_on?: string;
+    subscriber_event_mapping?: SubscriberEventMapping;
+};
+/** @returns {SubscriberEventMapping} */
+declare function SubscriberEventMapping(): SubscriberEventMapping;
+type SubscriberEventMapping = {
+    id?: number;
+    event_id?: number;
+    subscriber_id?: number;
+    created_on?: string;
+};
 /** @returns {SubscriberResponse} */
 declare function SubscriberResponse(): SubscriberResponse;
 type SubscriberResponse = {

package/sdk/platform/Webhook/WebhookPlatformModel.js

@@ -235,6 +235,36 @@ const Joi = require("joi");
  * @property {string} [secret]
  */
 
+/**
+ * @typedef SubscriberFailureResponse
+ * @property {string} [message]
+ * @property {string} [code]
+ * @property {string} [stack]
+ */
+
+/**
+ * @typedef EventConfigs
+ * @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 {SubscriberEventMapping} [subscriber_event_mapping]
+ */
+
+/**
+ * @typedef SubscriberEventMapping
+ * @property {number} [id]
+ * @property {number} [event_id]
+ * @property {number} [subscriber_id]
+ * @property {string} [created_on]
+ */
+
 /**
  * @typedef SubscriberResponse
  * @property {number} [id]
@@ -582,6 +612,42 @@ class WebhookPlatformModel {
     });
   }
 
+  /** @returns {SubscriberFailureResponse} */
+  static SubscriberFailureResponse() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+      code: Joi.string().allow(""),
+      stack: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {EventConfigs} */
+  static EventConfigs() {
+    return Joi.object({
+      id: Joi.number(),
+      event_name: Joi.string().allow(""),
+      event_type: Joi.string().allow(""),
+      event_category: Joi.string().allow(""),
+      event_schema: Joi.object().pattern(/\S/, Joi.any()),
+      version: Joi.string().allow(""),
+      display_name: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      created_on: Joi.string().allow(""),
+      updated_on: Joi.string().allow(""),
+      subscriber_event_mapping: WebhookPlatformModel.SubscriberEventMapping(),
+    });
+  }
+
+  /** @returns {SubscriberEventMapping} */
+  static SubscriberEventMapping() {
+    return Joi.object({
+      id: Joi.number(),
+      event_id: Joi.number(),
+      subscriber_id: Joi.number(),
+      created_on: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {SubscriberResponse} */
   static SubscriberResponse() {
     return Joi.object({

package/sdk/public/Configuration/ConfigurationPublicClient.d.ts

@@ -24,8 +24,8 @@ declare class Configuration {
      * @param {import("../PublicAPIClient").Options} - Options
      * @returns {Promise<ConfigurationPublicModel.ApplicationResponse>} - Success response
      * @name searchApplication
-     * @summary: Search Application
-     * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
+     * @summary: Search application.
+     * @description: Provide application name or domain url. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
      */
     searchApplication({ authorization, query, requestHeaders }?: ConfigurationPublicValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPublicModel.ApplicationResponse>;
 }

package/sdk/public/Configuration/ConfigurationPublicClient.js

@@ -120,8 +120,8 @@ class Configuration {
    * @param {import("../PublicAPIClient").Options} - Options
    * @returns {Promise<ConfigurationPublicModel.ApplicationResponse>} - Success response
    * @name searchApplication
-   * @summary: Search Application
-   * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
+   * @summary: Search application.
+   * @description: Provide application name or domain url. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
    */
   async searchApplication(
     { authorization, query, requestHeaders } = { requestHeaders: {} },

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

@@ -13,8 +13,8 @@ declare class Partner {
      * @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/).
+     * @summary: Get panel extension details.
+     * @description: Retrieve detailed information about panel extensions in the public server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/partner/getPanelExtensionDetails/).
      */
     getPanelExtensionDetails({ slug, requestHeaders }?: PartnerPublicValidator.GetPanelExtensionDetailsParam, { responseHeaders }?: object): Promise<PartnerPublicModel.ExtensionUsingSlug>;
 }

package/sdk/public/Partner/PartnerPublicClient.js

@@ -39,8 +39,8 @@ class Partner {
    * @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/).
+   * @summary: Get panel extension details.
+   * @description: Retrieve detailed information about panel extensions in the public server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/partner/getPanelExtensionDetails/).
    */
   async getPanelExtensionDetails(
     { slug, requestHeaders } = { requestHeaders: {} },

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

@@ -17,8 +17,8 @@ declare class Webhook {
      * @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/).
+     * @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>;
     /**
@@ -37,8 +37,8 @@ declare class Webhook {
      * @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/).
+     * @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>;
     /**

package/sdk/public/Webhook/WebhookPublicClient.js

@@ -46,8 +46,8 @@ class Webhook {
    * @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/).
+   * @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/).
    */
   async fetchAllWebhookEvents(
     { requestHeaders } = { requestHeaders: {} },
@@ -202,8 +202,8 @@ class Webhook {
    * @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/).
+   * @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/).
    */
   async queryWebhookEventDetails(
     { body, requestHeaders } = { requestHeaders: {} },