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

package/sdk/platform/User/UserPlatformApplicationClient.js

@@ -98,8 +98,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.BlockUserSuccess>} - Success response
    * @name blockOrUnblockUsers
-   * @summary: Block/Unblock user
-   * @description: Block/Unblock user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/blockOrUnblockUsers/).
+   * @summary: Block/unblock users.
+   * @description: Control user access by blocking or unblocking their accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/blockOrUnblockUsers/).
    */
   async blockOrUnblockUsers(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -177,8 +177,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
    * @name createUser
-   * @summary: Create user
-   * @description: Create user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUser/).
+   * @summary: Create user.
+   * @description: Register and add a new user to the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUser/).
    */
   async createUser(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -336,8 +336,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
    * @name createUserGroup
-   * @summary: Create an User Group
-   * @description: Use this API to create new user Group - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserGroup/).
+   * @summary: Create user group.
+   * @description: Form and add a new user group. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserGroup/).
    */
   async createUserGroup(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -416,8 +416,8 @@ class User {
    * @returns {Promise<UserPlatformModel.CreateUserSessionResponseSchema>} -
    *   Success response
    * @name createUserSession
-   * @summary: Create user session
-   * @description: Create user session - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserSession/).
+   * @summary: Create user session.
+   * @description: Establish a session for user interactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserSession/).
    */
   async createUserSession(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -498,8 +498,8 @@ class User {
    * @returns {Promise<UserPlatformModel.SessionsDeleteResponseSchema>} -
    *   Success response
    * @name deleteActiveSessions
-   * @summary: Delete a list of all session for a user
-   * @description: Use this API to Delete a list of session of customers who have registered in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
+   * @summary: Delete active sessions.
+   * @description: End multiple active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
    */
   async deleteActiveSessions(
     { id, reason, requestHeaders } = { requestHeaders: {} },
@@ -582,8 +582,8 @@ class User {
    * @returns {Promise<UserPlatformModel.SessionDeleteResponseSchema>} -
    *   Success response
    * @name deleteSession
-   * @summary: Delete a session for a user
-   * @description: Use this API to Delete a session of customers who have registered in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteSession/).
+   * @summary: Delete session.
+   * @description: Terminate an active user session. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteSession/).
    */
   async deleteSession(
     { id, sessionId, reason, requestHeaders } = { requestHeaders: {} },
@@ -818,8 +818,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.SessionListResponseSchema>} - Success response
    * @name getActiveSessions
-   * @summary: Get a list of all session with info for a user
-   * @description: Use this API to retrieve a list of session with info of customers who have registered in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getActiveSessions/).
+   * @summary: Get active sessions.
+   * @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getActiveSessions/).
    */
   async getActiveSessions(
     { id, requestHeaders } = { requestHeaders: {} },
@@ -898,8 +898,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
    * @name getCustomers
-   * @summary: Get a list of customers
-   * @description: Use this API to retrieve a list of customers who have registered in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getCustomers/).
+   * @summary: Get customers.
+   * @description: Retrieve a list of customer profiles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getCustomers/).
    */
   async getCustomers(
     { q, pageSize, pageNo, requestHeaders } = { requestHeaders: {} },
@@ -982,8 +982,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
    * @name getPlatformConfig
-   * @summary: Get platform configurations
-   * @description: Use this API to get all the platform configurations such as mobile image, desktop image, social logins, and all other text. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
+   * @summary: Get platform config.
+   * @description: Retrieve configuration settings for the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
    */
   async getPlatformConfig(
     { requestHeaders } = { requestHeaders: {} },
@@ -1496,8 +1496,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
    * @name getUserGroupById
-   * @summary: Get an User Group by Id
-   * @description: Use this API to get details of an existing user Group - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroupById/).
+   * @summary: Get user group by ID.
+   * @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroupById/).
    */
   async getUserGroupById(
     { groupId, requestHeaders } = { requestHeaders: {} },
@@ -1576,8 +1576,8 @@ class User {
    * @returns {Promise<UserPlatformModel.UserGroupListResponseSchema>} -
    *   Success response
    * @name getUserGroups
-   * @summary: Get User Groups mathcing criteria
-   * @description: Use this API to get User Groups mathing criteria passed in query - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroups/).
+   * @summary: Get user groups.
+   * @description: Retrieve a list of user groups. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroups/).
    */
   async getUserGroups(
     { pageNo, pageSize, name, type, status, groupUid, requestHeaders } = {
@@ -1671,8 +1671,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.UserSearchResponseSchema>} - Success response
    * @name searchUsers
-   * @summary: Search an existing user.
-   * @description: Use this API to retrieve an existing user from a list. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/searchUsers/).
+   * @summary: Search users.
+   * @description: Search and filter user profiles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/searchUsers/).
    */
   async searchUsers(
     { q, query, requestHeaders } = { requestHeaders: {} },
@@ -1752,8 +1752,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.UnDeleteUserSuccess>} - Success response
    * @name unDeleteUser
-   * @summary: undelete user who deleted from application and have not elapsed the platform configured delete days
-   * @description: undelete user who deleted from application and have not elapsed the platform configured delete days - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/unDeleteUser/).
+   * @summary: Undelete user.
+   * @description: Restore a previously deleted user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/unDeleteUser/).
    */
   async unDeleteUser(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1831,8 +1831,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
    * @name updatePlatformConfig
-   * @summary: Update platform configurations
-   * @description: Use this API to edit the existing platform configurations such as mobile image, desktop image, social logins, and all other text. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updatePlatformConfig/).
+   * @summary: Update platform config.
+   * @description: Modify and update platform configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updatePlatformConfig/).
    */
   async updatePlatformConfig(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1910,8 +1910,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
    * @name updateUser
-   * @summary: Update user
-   * @description: Use this API to update user details, Note: Existing emails and phone numbers of user will be replaced directly if phone_numbers or emails field sent in request data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUser/).
+   * @summary: Update user.
+   * @description: Modify and update user profile information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUser/).
    */
   async updateUser(
     { userId, body, requestHeaders } = { requestHeaders: {} },
@@ -2159,8 +2159,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
    * @name updateUserGroup
-   * @summary: Update an User Group
-   * @description: Use this API to update an existing user Group - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroup/).
+   * @summary: Update user group.
+   * @description: Modify and update user group details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroup/).
    */
   async updateUserGroup(
     { groupId, body, requestHeaders } = { requestHeaders: {} },
@@ -2243,7 +2243,7 @@ class User {
    * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
    * @name updateUserGroupPartially
    * @summary: Add or Remove an user from particular user group and update user group details
-   * @description: Use this API to update user group details and add or remove an user to the user group. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
+   * @description: Update user group partially on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
    */
   async updateUserGroupPartially(
     { groupId, body, requestHeaders } = { requestHeaders: {} },

package/sdk/platform/User/UserPlatformModel.d.ts

@@ -322,7 +322,7 @@ export = UserPlatformModel;
 /**
  * @typedef SocialTokens
  * @property {Facebook} [facebook]
- * @property {Accountkit} [accountkit]
+ * @property {Accountkit} [account_kit]
  * @property {Google} [google]
  */
 /**
@@ -959,7 +959,7 @@ type FlashCard = {
 declare function SocialTokens(): SocialTokens;
 type SocialTokens = {
     facebook?: Facebook;
-    accountkit?: Accountkit;
+    account_kit?: Accountkit;
     google?: Google;
 };
 /** @returns {DeleteAccountReasons} */

package/sdk/platform/User/UserPlatformModel.js

@@ -366,7 +366,7 @@ const Joi = require("joi");
 /**
  * @typedef SocialTokens
  * @property {Facebook} [facebook]
- * @property {Accountkit} [accountkit]
+ * @property {Accountkit} [account_kit]
  * @property {Google} [google]
  */
 
@@ -985,7 +985,7 @@ class UserPlatformModel {
   static SocialTokens() {
     return Joi.object({
       facebook: UserPlatformModel.Facebook(),
-      accountkit: UserPlatformModel.Accountkit(),
+      account_kit: UserPlatformModel.Accountkit(),
       google: UserPlatformModel.Google(),
     });
   }

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

@@ -8,9 +8,8 @@ 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 job by name.
+     * @description: Cancel a specific job by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
      */
     cancelJobByName({ filename, requestHeaders }?: WebhookPlatformValidator.CancelJobByNameParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.CancelResponse>;
     /**
@@ -19,9 +18,8 @@ declare class Webhook {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @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 delivery report.
+     * @description: Download detailed delivery reports for events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
      */
     downloadDeliveryReport({ body, requestHeaders }?: WebhookPlatformValidator.DownloadDeliveryReportParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.DownloadReportResponse>;
     /**
@@ -30,9 +28,8 @@ declare class Webhook {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
      * @name 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/).
+     * @summary: Fetch all event configurations.
+     * @description: Retrieve all configurations for event handling. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
      */
     fetchAllEventConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventConfigResponse>;
     /**
@@ -41,9 +38,8 @@ declare class Webhook {
      * @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 delivery reports.
+     * @description: Retrieve reports on the delivery status of events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
      */
     getDeliveryReports({ body, requestHeaders }?: WebhookPlatformValidator.GetDeliveryReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventProcessReports>;
     /**
@@ -52,9 +48,8 @@ declare class Webhook {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @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/).
+     * @summary: Get event counts.
+     * @description: Retrieve the counts of events based on their status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getEventCounts/).
      */
     getEventCounts({ body, requestHeaders }?: WebhookPlatformValidator.GetEventCountsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetryCountResponse>;
     /**
@@ -63,9 +58,8 @@ declare class Webhook {
      * @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 historical reports.
+     * @description: Retrieve historical reports of webhook events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
      */
     getHistoricalReports({ body, requestHeaders }?: WebhookPlatformValidator.GetHistoricalReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.HistoryResponse>;
     /**
@@ -74,9 +68,8 @@ declare class Webhook {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<WebhookPlatformModel.RetryStatusResponse>} - Success response
      * @name getManualRetryStatus
-     * @summary: Get the retry status for a company's failed events.
-     * @description: Retrieves the status of retry for a specific company's failed events. This endpoint returns the total number of events, the count of successfully retried events, the count of failed retry attempts, and the overall status of the retry process.
-     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getManualRetryStatus/).
+     * @summary: Get manual retry status.
+     * @description: Check the status of a manual retry operation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getManualRetryStatus/).
      */
     getManualRetryStatus({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetryStatusResponse>;
     /**
@@ -85,9 +78,8 @@ declare class Webhook {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @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 report filters.
+     * @description: Retrieve filters used for generating reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
      */
     getReportFilters({ body, requestHeaders }?: WebhookPlatformValidator.GetReportFiltersParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.ReportFilterResponse[]>;
     /**
@@ -96,8 +88,8 @@ declare class Webhook {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
      * @name getSubscriberById
-     * @summary: Get Subscriber By Subscriber ID
-     * @description: Get Subscriber By Subscriber ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
+     * @summary: Get subscriber by ID.
+     * @description: Retrieve a subscriber's details by their unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
      */
     getSubscriberById({ subscriberId, requestHeaders }?: WebhookPlatformValidator.GetSubscriberByIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberResponse>;
     /**
@@ -106,9 +98,8 @@ declare class Webhook {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
      * @name 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/).
+     * @summary: Get subscribers by company.
+     * @description: Retrieve subscribers associated with a company. - 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.SubscriberConfigList>;
     /**
@@ -117,8 +108,8 @@ declare class Webhook {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
      * @name getSubscribersByExtensionId
-     * @summary: Get Subscribers By Extension ID
-     * @description: Get Subscribers By ExtensionID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
+     * @summary: Get subscribers by extension ID.
+     * @description: Retrieve subscribers associated with a specific extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
      */
     getSubscribersByExtensionId({ extensionId, pageNo, pageSize, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByExtensionIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigList>;
     /**
@@ -127,9 +118,8 @@ declare class Webhook {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @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/).
+     * @summary: Manual retry cancellation.
+     * @description: Cancel a manual retry operation for a failed event. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryCancel/).
      */
     manualRetryCancel({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
     /**
@@ -138,9 +128,8 @@ declare class Webhook {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @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/).
+     * @summary: Manual retry of failed event.
+     * @description: Trigger a manual retry for an event that failed to deliver. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryOfFailedEvent/).
      */
     manualRetryOfFailedEvent({ body, requestHeaders }?: WebhookPlatformValidator.ManualRetryOfFailedEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetrySuccessResponse>;
     /**
@@ -149,9 +138,8 @@ declare class Webhook {
      * @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 webhook.
+     * @description: Send a test ping to a webhook for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
      */
     pingWebhook({ body, requestHeaders }?: WebhookPlatformValidator.PingWebhookParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.PingWebhookResponse>;
     /**
@@ -161,9 +149,8 @@ declare class Webhook {
      * @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 to event.
+     * @description: Add a subscriber to receive events of a specific type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
      */
     registerSubscriberToEvent({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
     /**
@@ -173,8 +160,8 @@ declare class Webhook {
      * @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/).
+     * @summary: Update subscriber config.
+     * @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
      */
     updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
 }

package/sdk/platform/Webhook/WebhookPlatformClient.js

@@ -20,9 +20,8 @@ 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 job by name.
+   * @description: Cancel a specific job by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
    */
   async cancelJobByName(
     { filename, requestHeaders } = { requestHeaders: {} },
@@ -100,9 +99,8 @@ class Webhook {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @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 delivery report.
+   * @description: Download detailed delivery reports for events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
    */
   async downloadDeliveryReport(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -182,9 +180,8 @@ class Webhook {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
    * @name 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/).
+   * @summary: Fetch all event configurations.
+   * @description: Retrieve all configurations for event handling. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
    */
   async fetchAllEventConfigurations(
     { requestHeaders } = { requestHeaders: {} },
@@ -260,9 +257,8 @@ class Webhook {
    * @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 delivery reports.
+   * @description: Retrieve reports on the delivery status of events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
    */
   async getDeliveryReports(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -340,9 +336,8 @@ class Webhook {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @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/).
+   * @summary: Get event counts.
+   * @description: Retrieve the counts of events based on their status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getEventCounts/).
    */
   async getEventCounts(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -420,9 +415,8 @@ class Webhook {
    * @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 historical reports.
+   * @description: Retrieve historical reports of webhook events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
    */
   async getHistoricalReports(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -500,9 +494,8 @@ class Webhook {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<WebhookPlatformModel.RetryStatusResponse>} - Success response
    * @name getManualRetryStatus
-   * @summary: Get the retry status for a company's failed events.
-   * @description: Retrieves the status of retry for a specific company's failed events. This endpoint returns the total number of events, the count of successfully retried events, the count of failed retry attempts, and the overall status of the retry process.
-   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getManualRetryStatus/).
+   * @summary: Get manual retry status.
+   * @description: Check the status of a manual retry operation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getManualRetryStatus/).
    */
   async getManualRetryStatus(
     { requestHeaders } = { requestHeaders: {} },
@@ -576,9 +569,8 @@ class Webhook {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @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 report filters.
+   * @description: Retrieve filters used for generating reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
    */
   async getReportFilters(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -653,8 +645,8 @@ class Webhook {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
    * @name getSubscriberById
-   * @summary: Get Subscriber By Subscriber ID
-   * @description: Get Subscriber By Subscriber ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
+   * @summary: Get subscriber by ID.
+   * @description: Retrieve a subscriber's details by their unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
    */
   async getSubscriberById(
     { subscriberId, requestHeaders } = { requestHeaders: {} },
@@ -732,9 +724,8 @@ class Webhook {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
    * @name 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/).
+   * @summary: Get subscribers by company.
+   * @description: Retrieve subscribers associated with a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
    */
   async getSubscribersByCompany(
     { pageNo, pageSize, extensionId, requestHeaders } = { requestHeaders: {} },
@@ -821,8 +812,8 @@ class Webhook {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
    * @name getSubscribersByExtensionId
-   * @summary: Get Subscribers By Extension ID
-   * @description: Get Subscribers By ExtensionID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
+   * @summary: Get subscribers by extension ID.
+   * @description: Retrieve subscribers associated with a specific extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
    */
   async getSubscribersByExtensionId(
     { extensionId, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -908,9 +899,8 @@ class Webhook {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @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/).
+   * @summary: Manual retry cancellation.
+   * @description: Cancel a manual retry operation for a failed event. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryCancel/).
    */
   async manualRetryCancel(
     { requestHeaders } = { requestHeaders: {} },
@@ -981,9 +971,8 @@ class Webhook {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @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/).
+   * @summary: Manual retry of failed event.
+   * @description: Trigger a manual retry for an event that failed to deliver. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryOfFailedEvent/).
    */
   async manualRetryOfFailedEvent(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1063,9 +1052,8 @@ class Webhook {
    * @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 webhook.
+   * @description: Send a test ping to a webhook for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
    */
   async pingWebhook(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1142,9 +1130,8 @@ class Webhook {
    * @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 to event.
+   * @description: Add a subscriber to receive events of a specific type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
    */
   async registerSubscriberToEvent(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1225,8 +1212,8 @@ class Webhook {
    * @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/).
+   * @summary: Update subscriber config.
+   * @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
    */
   async updateSubscriberConfig(
     { body, requestHeaders } = { requestHeaders: {} },