@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.4.0-beta.1

package/sdk/platform/User/UserPlatformModel.js

@@ -33,10 +33,48 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef CreateUserGroupSchema
+ * @typedef Conditions
+ * @property {string} [key]
+ * @property {string} [type]
+ * @property {string} [user_attribute_definition_id]
+ * @property {string} [value]
+ */
+
+/**
+ * @typedef ConditionsSchema
+ * @property {string} [type]
+ * @property {string} [user_attribute_definition_id]
+ * @property {string} [value]
+ */
+
+/**
+ * @typedef CreateUserAttributeDefinition
+ * @property {boolean} [customer_editable]
+ * @property {string} [default_value]
+ * @property {string} [description]
+ * @property {boolean} [encrypted]
+ * @property {boolean} [multi_value]
+ * @property {string} [name]
+ * @property {number} [pin_order]
+ * @property {boolean} [pinned]
+ * @property {string} [slug]
+ * @property {string} [type]
+ * @property {Object[]} [validations]
+ */
+
+/**
+ * @typedef CreateUserAttributeRequest
+ * @property {Object} [attribute]
+ * @property {boolean} [customer_overriden]
+ */
+
+/**
+ * @typedef CreateUserGroup
+ * @property {ConditionsSchema[]} [conditions]
  * @property {string} description
- * @property {string} file_url
+ * @property {string} [file_url]
  * @property {string} name
+ * @property {string} [type]
  */
 
 /**
@@ -278,6 +316,11 @@ const Joi = require("joi");
  * @property {Google} [google]
  */
 
+/**
+ * @typedef SuccessMessageResponse
+ * @property {string} [success]
+ */
+
 /**
  * @typedef UnDeleteUserRequestSchema
  * @property {string} [reason]
@@ -292,9 +335,11 @@ const Joi = require("joi");
 
 /**
  * @typedef UpdateUserGroupSchema
+ * @property {ConditionsSchema[]} [conditions]
  * @property {string} [description]
  * @property {string} [file_url]
  * @property {string} [name]
+ * @property {string} [type]
  */
 
 /**
@@ -308,6 +353,66 @@ const Joi = require("joi");
  * @property {UserPhoneNumbers[]} [phone_numbers]
  */
 
+/**
+ * @typedef UserAttributeDefinition
+ * @property {number} [__v] - The version number of the attribute.
+ * @property {string} [_id] - The unique identifier for the attribute definition.
+ * @property {string} [application_id] - The application ID.
+ * @property {string} [created_at] - The creation date of the attribute.
+ * @property {boolean} [customer_editable] - Whether the attribute is customer-editable.
+ * @property {string} [description] - The description of the attribute.
+ * @property {boolean} [encrypted] - Whether the attribute is encrypted.
+ * @property {boolean} [is_locked] - Whether the attribute is locked.
+ * @property {string} [modified_at] - The modification date of the attribute.
+ * @property {boolean} [multi_value] - Whether the attribute supports multiple values.
+ * @property {string} [name] - The attribute name.
+ * @property {number} [pin_order] - The order in which the attribute is pinned.
+ * @property {boolean} [pinned] - Whether the attribute is pinned.
+ * @property {string} [slug] - The attribute key.
+ * @property {string} [type] - The attribute type.
+ * @property {Object[]} [validations]
+ */
+
+/**
+ * @typedef UserAttributeDefinitionResponse
+ * @property {string} [_id] - The unique identifier for the attribute definition.
+ * @property {string} [application_id] - The application ID.
+ * @property {string} [created_at] - The creation date of the attribute definition.
+ * @property {string} [created_by] - The user who created the attribute.
+ * @property {boolean} [customer_editable] - Whether the attribute is customer-editable.
+ * @property {string} [description] - The description of the attribute.
+ * @property {boolean} [encrypted] - Whether the attribute is encrypted.
+ * @property {boolean} [is_locked] - Whether the attribute is locked.
+ * @property {string} [modified_at] - The last modification date of the
+ *   attribute definition.
+ * @property {boolean} [multi_value] - Whether the attribute supports multiple values.
+ * @property {string} [name] - The attribute name.
+ * @property {number} [pin_order] - The order in which the attribute is pinned.
+ * @property {boolean} [pinned] - Whether the attribute is pinned.
+ * @property {string} [slug] - The attribute key.
+ * @property {string} [type] - The attribute type.
+ * @property {string} [updated_by] - The user who last updated the attribute.
+ * @property {UserAttributeDefinitionValidation[]} [validations]
+ */
+
+/**
+ * @typedef UserAttributeDefinitionValidation
+ * @property {string} [type] - The type of validation.
+ * @property {Object} [value] - The validation value.
+ */
+
+/**
+ * @typedef UserAttributeResponse
+ * @property {string} [_id] - The unique identifier for the attribute definition.
+ * @property {string} [application_id] - The application ID.
+ * @property {Object} [attribute]
+ * @property {boolean} [customer_overriden] - Whether the attribute is customer-editable.
+ * @property {string} [name] - The name of user attribute definition.
+ * @property {string} [type] - The attribute type.
+ * @property {string} [updated_by]
+ * @property {string} [user_id] - The unique identifier for the user.
+ */
+
 /**
  * @typedef UserEmails
  * @property {boolean} [active]
@@ -327,12 +432,16 @@ const Joi = require("joi");
  * @property {number} [__v]
  * @property {string} [_id]
  * @property {string} [application_id]
+ * @property {Conditions[]} [conditions]
  * @property {string} [created_at]
  * @property {string} [description]
+ * @property {UserResponseErrorSchema} [error]
  * @property {string} [file_url]
+ * @property {boolean} [is_active]
  * @property {string} [modified_at]
  * @property {string} [name]
  * @property {string} [status]
+ * @property {string} [type]
  * @property {number} [uid]
  */
 
@@ -353,6 +462,12 @@ const Joi = require("joi");
  * @property {boolean} [verified]
  */
 
+/**
+ * @typedef UserResponseErrorSchema
+ * @property {number} [count]
+ * @property {string} [file_url]
+ */
+
 /**
  * @typedef UserSchema
  * @property {string} [_id]
@@ -424,12 +539,58 @@ class UserPlatformModel {
     });
   }
 
-  /** @returns {CreateUserGroupSchema} */
-  static CreateUserGroupSchema() {
+  /** @returns {Conditions} */
+  static Conditions() {
+    return Joi.object({
+      key: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      user_attribute_definition_id: Joi.string().allow(""),
+      value: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ConditionsSchema} */
+  static ConditionsSchema() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+      user_attribute_definition_id: Joi.string().allow(""),
+      value: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CreateUserAttributeDefinition} */
+  static CreateUserAttributeDefinition() {
+    return Joi.object({
+      customer_editable: Joi.boolean(),
+      default_value: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      encrypted: Joi.boolean(),
+      multi_value: Joi.boolean(),
+      name: Joi.string().allow(""),
+      pin_order: Joi.number(),
+      pinned: Joi.boolean(),
+      slug: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      validations: Joi.array().items(Joi.any()),
+    });
+  }
+
+  /** @returns {CreateUserAttributeRequest} */
+  static CreateUserAttributeRequest() {
     return Joi.object({
+      attribute: Joi.any(),
+      customer_overriden: Joi.boolean(),
+    });
+  }
+
+  /** @returns {CreateUserGroup} */
+  static CreateUserGroup() {
+    return Joi.object({
+      conditions: Joi.array().items(UserPlatformModel.ConditionsSchema()),
       description: Joi.string().allow("").required(),
-      file_url: Joi.string().allow("").required(),
+      file_url: Joi.string().allow(""),
       name: Joi.string().allow("").required(),
+      type: Joi.string().allow(""),
     });
   }
 
@@ -730,6 +891,13 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {SuccessMessageResponse} */
+  static SuccessMessageResponse() {
+    return Joi.object({
+      success: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {UnDeleteUserRequestSchema} */
   static UnDeleteUserRequestSchema() {
     return Joi.object({
@@ -749,9 +917,11 @@ class UserPlatformModel {
   /** @returns {UpdateUserGroupSchema} */
   static UpdateUserGroupSchema() {
     return Joi.object({
+      conditions: Joi.array().items(UserPlatformModel.ConditionsSchema()),
       description: Joi.string().allow(""),
       file_url: Joi.string().allow(""),
       name: Joi.string().allow(""),
+      type: Joi.string().allow(""),
     });
   }
 
@@ -768,6 +938,75 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {UserAttributeDefinition} */
+  static UserAttributeDefinition() {
+    return Joi.object({
+      __v: Joi.number(),
+      _id: Joi.string().allow(""),
+      application_id: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      customer_editable: Joi.boolean(),
+      description: Joi.string().allow(""),
+      encrypted: Joi.boolean(),
+      is_locked: Joi.boolean(),
+      modified_at: Joi.string().allow(""),
+      multi_value: Joi.boolean(),
+      name: Joi.string().allow(""),
+      pin_order: Joi.number(),
+      pinned: Joi.boolean(),
+      slug: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      validations: Joi.array().items(Joi.any()),
+    });
+  }
+
+  /** @returns {UserAttributeDefinitionResponse} */
+  static UserAttributeDefinitionResponse() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      application_id: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      created_by: Joi.string().allow(""),
+      customer_editable: Joi.boolean(),
+      description: Joi.string().allow(""),
+      encrypted: Joi.boolean(),
+      is_locked: Joi.boolean(),
+      modified_at: Joi.string().allow(""),
+      multi_value: Joi.boolean(),
+      name: Joi.string().allow(""),
+      pin_order: Joi.number(),
+      pinned: Joi.boolean(),
+      slug: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      updated_by: Joi.string().allow(""),
+      validations: Joi.array().items(
+        UserPlatformModel.UserAttributeDefinitionValidation()
+      ),
+    });
+  }
+
+  /** @returns {UserAttributeDefinitionValidation} */
+  static UserAttributeDefinitionValidation() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+      value: Joi.any(),
+    });
+  }
+
+  /** @returns {UserAttributeResponse} */
+  static UserAttributeResponse() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      application_id: Joi.string().allow(""),
+      attribute: Joi.any(),
+      customer_overriden: Joi.boolean(),
+      name: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      updated_by: Joi.string().allow(""),
+      user_id: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {UserEmails} */
   static UserEmails() {
     return Joi.object({
@@ -792,12 +1031,16 @@ class UserPlatformModel {
       __v: Joi.number(),
       _id: Joi.string().allow(""),
       application_id: Joi.string().allow(""),
+      conditions: Joi.array().items(UserPlatformModel.Conditions()),
       created_at: Joi.string().allow(""),
       description: Joi.string().allow(""),
+      error: UserPlatformModel.UserResponseErrorSchema(),
       file_url: Joi.string().allow(""),
+      is_active: Joi.boolean(),
       modified_at: Joi.string().allow(""),
       name: Joi.string().allow(""),
       status: Joi.string().allow(""),
+      type: Joi.string().allow(""),
       uid: Joi.number(),
     });
   }
@@ -823,6 +1066,14 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {UserResponseErrorSchema} */
+  static UserResponseErrorSchema() {
+    return Joi.object({
+      count: Joi.number(),
+      file_url: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {UserSchema} */
   static UserSchema() {
     return Joi.object({

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

@@ -8,61 +8,64 @@ declare class Webhook {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<WebhookPlatformModel.CancelResponse>} - Success response
      * @name cancelJobByName
-     * @summary: Cancel a report export
-     * @description: Cancel the export of a specific report for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
+     * @summary: Cancel a report export.
+     * @description: Cancel the export of a specific report for a company.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
      */
     cancelJobByName({ filename, requestHeaders }?: WebhookPlatformValidator.CancelJobByNameParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.CancelResponse>;
     /**
      * @param {WebhookPlatformValidator.DownloadDeliveryReportParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<Object>} - Success response
+     * @returns {Promise<WebhookPlatformModel.DownloadReportResponse>} - Success response
      * @name downloadDeliveryReport
-     * @summary: Download processed events report for a company
-     * @description: Download reports for a specific company based on the provided filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
+     * @summary: Download processed events report for a company.
+     * @description: Download reports for a specific company based on the provided filters.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
      */
-    downloadDeliveryReport({ body, requestHeaders }?: WebhookPlatformValidator.DownloadDeliveryReportParam, { responseHeaders }?: object): Promise<any>;
+    downloadDeliveryReport({ body, requestHeaders }?: WebhookPlatformValidator.DownloadDeliveryReportParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.DownloadReportResponse>;
     /**
      * @param {WebhookPlatformValidator.FetchAllEventConfigurationsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
+     * @returns {Promise<Object>} - Success response
      * @name fetchAllEventConfigurations
-     * @summary:
-     * @description: Get All Webhook Events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
+     * @summary: Get All Webhook Events.
+     * @description: To fetch all webhook events.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
      */
-    fetchAllEventConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventConfigResponse>;
+    fetchAllEventConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
     /**
      * @param {WebhookPlatformValidator.GetDeliveryReportsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<WebhookPlatformModel.EventProcessReports>} - Success response
      * @name getDeliveryReports
-     * @summary: Get processed events report for a company
-     * @description: Retrieve a list of processed events for a specific company based on the provided filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
+     * @summary: Get processed events report for a company.
+     * @description: Retrieve a list of processed events for a specific company based on the provided filters.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
      */
     getDeliveryReports({ body, requestHeaders }?: WebhookPlatformValidator.GetDeliveryReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventProcessReports>;
     /**
      * @param {WebhookPlatformValidator.GetEventCountsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.FailedEventsCountSuccessResponse>}
-     *   - Success response
-     *
+     * @returns {Promise<WebhookPlatformModel.RetryCountResponse>} - Success response
      * @name getEventCounts
      * @summary: Get the count of failed events for a company within a specified date range.
      * @description: Retrieves the count of failed events for a specific company within the specified date range. The user can filter the count based on specific event types if provided.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getEventCounts/).
      */
-    getEventCounts({ body, requestHeaders }?: WebhookPlatformValidator.GetEventCountsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.FailedEventsCountSuccessResponse>;
+    getEventCounts({ body, requestHeaders }?: WebhookPlatformValidator.GetEventCountsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetryCountResponse>;
     /**
      * @param {WebhookPlatformValidator.GetHistoricalReportsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<WebhookPlatformModel.HistoryResponse>} - Success response
      * @name getHistoricalReports
-     * @summary: Get report download history
-     * @description: Retrieve history reports for a specific company based on the provided filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
+     * @summary: Get report download history.
+     * @description: Retrieve history reports for a specific company based on the provided filters.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
      */
     getHistoricalReports({ body, requestHeaders }?: WebhookPlatformValidator.GetHistoricalReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.HistoryResponse>;
     /**
@@ -80,12 +83,13 @@ declare class Webhook {
      * @param {WebhookPlatformValidator.GetReportFiltersParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.ReportFilterResponse>} - Success response
+     * @returns {Promise<WebhookPlatformModel.ReportFilterResponse[]>} - Success response
      * @name getReportFilters
-     * @summary: Get filters for a company
-     * @description: Retrieve filters for a specific company based on the provided subscriber IDs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
+     * @summary: Get filters for a company.
+     * @description: Retrieve filters for a specific company based on the provided subscriber IDs.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
      */
-    getReportFilters({ body, requestHeaders }?: WebhookPlatformValidator.GetReportFiltersParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.ReportFilterResponse>;
+    getReportFilters({ body, requestHeaders }?: WebhookPlatformValidator.GetReportFiltersParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.ReportFilterResponse[]>;
     /**
      * @param {WebhookPlatformValidator.GetSubscriberByIdParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -100,12 +104,13 @@ declare class Webhook {
      * @param {WebhookPlatformValidator.GetSubscribersByCompanyParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
+     * @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
      * @name getSubscribersByCompany
-     * @summary: Get Subscribers By Company ID
-     * @description: Get Subscribers By CompanyId - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
+     * @summary: Get Subscribers By CompanyId.
+     * @description: Get Subscribers By Company ID.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
      */
-    getSubscribersByCompany({ pageNo, pageSize, extensionId, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByCompanyParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberResponse>;
+    getSubscribersByCompany({ pageNo, pageSize, extensionId, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByCompanyParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigList>;
     /**
      * @param {WebhookPlatformValidator.GetSubscribersByExtensionIdParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -120,55 +125,58 @@ declare class Webhook {
      * @param {WebhookPlatformValidator.ManualRetryCancelParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.EventSuccessResponse>} - Success response
+     * @returns {Promise<string>} - Success response
      * @name manualRetryCancel
      * @summary: Cancel the active manual retry for a company's failed events.
      * @description: Cancels the active manual retry for a specific company's failed events. If a manual retry is currently in progress, it will be cancelled.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryCancel/).
      */
-    manualRetryCancel({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventSuccessResponse>;
+    manualRetryCancel({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
     /**
      * @param {WebhookPlatformValidator.ManualRetryOfFailedEventParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.EventProcessedSuccessResponse>} -
-     *   Success response
+     * @returns {Promise<WebhookPlatformModel.RetrySuccessResponse>} - Success response
      * @name manualRetryOfFailedEvent
      * @summary: Initiate a manual retry for event processing.
      * @description: Initiates a manual retry for event processing for a specific company. This endpoint allows the user to specify the date range (start_date and end_date) within which the events should be retried.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryOfFailedEvent/).
      */
-    manualRetryOfFailedEvent({ body, requestHeaders }?: WebhookPlatformValidator.ManualRetryOfFailedEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventProcessedSuccessResponse>;
+    manualRetryOfFailedEvent({ body, requestHeaders }?: WebhookPlatformValidator.ManualRetryOfFailedEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetrySuccessResponse>;
     /**
      * @param {WebhookPlatformValidator.PingWebhookParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<WebhookPlatformModel.PingWebhookResponse>} - Success response
      * @name pingWebhook
-     * @summary: Ping and validate webhook url
-     * @description: Ping and validate webhook url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
+     * @summary: Ping and validate webhook url.
+     * @description: Ping and validate webhook url.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
      */
     pingWebhook({ body, requestHeaders }?: WebhookPlatformValidator.PingWebhookParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.PingWebhookResponse>;
     /**
      * @param {WebhookPlatformValidator.RegisterSubscriberToEventParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.SubscriberConfig>} - Success response
+     * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
+     *   Success response
      * @name registerSubscriberToEvent
-     * @summary: Register Subscriber
-     * @description: Register Subscriber - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
+     * @summary: Register Subscriber.
+     * @description: Register Subscriber.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
      */
-    registerSubscriberToEvent({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfig>;
+    registerSubscriberToEvent({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
     /**
      * @param {WebhookPlatformValidator.UpdateSubscriberConfigParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.SubscriberConfig>} - Success response
+     * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
+     *   Success response
      * @name updateSubscriberConfig
      * @summary: Update Subscriber
      * @description: Update Subscriber - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
      */
-    updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfig>;
+    updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
 }
 import WebhookPlatformValidator = require("./WebhookPlatformValidator");
 import WebhookPlatformModel = require("./WebhookPlatformModel");