@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.4

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

@@ -9,8 +9,8 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.ArchiveUserSuccess>} - Success response
      * @name archiveUser
-     * @summary: archive user
-     * @description: archive user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/archiveUser/).
+     * @summary: Archive User
+     * @description: Delete user from sales channel, allowing re-registration with the same mobile/email for a new user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/archiveUser/).
      */
     archiveUser({ body, requestHeaders }?: UserPlatformApplicationValidator.ArchiveUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.ArchiveUserSuccess>;
     /**
@@ -19,8 +19,8 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.BlockUserSuccess>} - Success response
      * @name 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/).
+     * @summary: Block/Unblock Users
+     * @description: Manage user access by blocking or unblocking their accounts, restricting login for blocked accounts and allowing login for unblocked accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/blockOrUnblockUsers/).
      */
     blockOrUnblockUsers({ body, requestHeaders }?: UserPlatformApplicationValidator.BlockOrUnblockUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.BlockUserSuccess>;
     /**
@@ -29,8 +29,8 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
      * @name 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/).
+     * @summary: Create User
+     * @description: Register and add a new user to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUser/).
      */
     createUser({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserResponseSchema>;
     /**
@@ -43,7 +43,7 @@ declare class User {
      *   Success response
      * @name createUserAttributeDefinition
      * @summary: Create a User Attribute Definition
-     * @description: Use this API to areate a new User Attribute Definition - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserAttributeDefinition/).
+     * @description: Create a new User Attribute Definition - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserAttributeDefinition/).
      */
     createUserAttributeDefinition({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinitionResponse>;
     /**
@@ -52,7 +52,7 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
      * @name createUserGroup
-     * @summary: Create user group.
+     * @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/).
      */
     createUserGroup({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
@@ -63,8 +63,8 @@ declare class User {
      * @returns {Promise<UserPlatformModel.CreateUserSessionResponseSchema>} -
      *   Success response
      * @name 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/).
+     * @summary: Create User Session
+     * @description: Create session for user interactions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserSession/).
      */
     createUserSession({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserSessionParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserSessionResponseSchema>;
     /**
@@ -76,8 +76,8 @@ declare class User {
      * @returns {Promise<UserPlatformModel.SessionsDeleteResponseSchema>} -
      *   Success response
      * @name 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/).
+     * @summary: Delete User Active Sessions
+     * @description: Terminate all active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
      */
     deleteActiveSessions({ id, reason, requestHeaders }?: UserPlatformApplicationValidator.DeleteActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionsDeleteResponseSchema>;
     /**
@@ -87,7 +87,7 @@ declare class User {
      * @returns {Promise<UserPlatformModel.SessionDeleteResponseSchema>} -
      *   Success response
      * @name deleteSession
-     * @summary: Delete session.
+     * @summary: Delete User Session
      * @description: Terminate an active user session. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteSession/).
      */
     deleteSession({ id, sessionId, reason, requestHeaders }?: UserPlatformApplicationValidator.DeleteSessionParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionDeleteResponseSchema>;
@@ -97,8 +97,8 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.SuccessMessageResponse>} - Success response
      * @name deleteUserAttribute
-     * @summary: delete User Attribute
-     * @description: delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
+     * @summary: Delete User Attribute
+     * @description: Delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
      */
     deleteUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessageResponse>;
     /**
@@ -119,7 +119,7 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.SessionListResponseSchema>} - Success response
      * @name getActiveSessions
-     * @summary: Get active sessions.
+     * @summary: Get User 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/).
      */
     getActiveSessions({ id, requestHeaders }?: UserPlatformApplicationValidator.GetActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionListResponseSchema>;
@@ -129,8 +129,8 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
      * @name 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/).
+     * @summary: Get a List of Users
+     * @description: Retrieve details of users registered in the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getCustomers/).
      */
     getCustomers({ q, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetCustomersParam, { responseHeaders }?: object): Promise<UserPlatformModel.CustomerListResponseSchema>;
     /**
@@ -139,8 +139,8 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
      * @name 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/).
+     * @summary: Get Platform Config
+     * @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
      */
     getPlatformConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<UserPlatformModel.PlatformSchema>;
     /**
@@ -149,8 +149,8 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
      * @name getUserAttribute
-     * @summary: get User Attribute
-     * @description: get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
+     * @summary: Get User Attribute
+     * @description: Get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
      */
     getUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeResponse>;
     /**
@@ -162,7 +162,7 @@ declare class User {
      * @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
      * @name getUserAttributeById
      * @summary: Get User Attribute
-     * @description: Get User Attribute details by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
+     * @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
      */
     getUserAttributeById({ attributeId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeResponse>;
     /**
@@ -197,8 +197,8 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<Object>} - Success response
      * @name getUserAttributesForUser
-     * @summary: Get User Attributes for user
-     * @description: Get all user attributes for user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributesForUser/).
+     * @summary: Get All Customer Attributes
+     * @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributesForUser/).
      */
     getUserAttributesForUser({ userId, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributesForUserParam, { responseHeaders }?: object): Promise<any>;
     /**
@@ -207,7 +207,7 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
      * @name getUserGroupById
-     * @summary: Get user group by ID.
+     * @summary: Get User Group
      * @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroupById/).
      */
     getUserGroupById({ groupId, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
@@ -218,7 +218,7 @@ declare class User {
      * @returns {Promise<UserPlatformModel.UserGroupListResponseSchema>} -
      *   Success response
      * @name getUserGroups
-     * @summary: Get user groups.
+     * @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/).
      */
     getUserGroups({ pageNo, pageSize, name, type, status, groupUid, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupsParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupListResponseSchema>;
@@ -228,8 +228,8 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.UserSearchResponseSchema>} - Success response
      * @name searchUsers
-     * @summary: Search users.
-     * @description: Search and filter user profiles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/searchUsers/).
+     * @summary: Search an Existing Users
+     * @description: Search and filter users details registered in the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/searchUsers/).
      */
     searchUsers({ q, query, requestHeaders }?: UserPlatformApplicationValidator.SearchUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserSearchResponseSchema>;
     /**
@@ -238,7 +238,7 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.UnDeleteUserSuccess>} - Success response
      * @name unDeleteUser
-     * @summary: Undelete user.
+     * @summary: Restore Deleted User
      * @description: Restore a previously deleted user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/unDeleteUser/).
      */
     unDeleteUser({ body, requestHeaders }?: UserPlatformApplicationValidator.UnDeleteUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.UnDeleteUserSuccess>;
@@ -250,8 +250,8 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
      * @name 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/).
+     * @summary: Update Platform Config
+     * @description: Modify and update platform sales channel authentication configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updatePlatformConfig/).
      */
     updatePlatformConfig({ body, requestHeaders }?: UserPlatformApplicationValidator.UpdatePlatformConfigParam, { responseHeaders }?: object): Promise<UserPlatformModel.PlatformSchema>;
     /**
@@ -260,7 +260,7 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
      * @name updateUser
-     * @summary: Update user.
+     * @summary: Update User Details
      * @description: Modify and update user profile information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUser/).
      */
     updateUser({ userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserResponseSchema>;
@@ -292,7 +292,7 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
      * @name updateUserGroup
-     * @summary: Update user group.
+     * @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/).
      */
     updateUserGroup({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
@@ -304,10 +304,10 @@ declare class User {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
      * @name updateUserGroupPartially
-     * @summary: Add or Remove an user from particular user group and update user group details
+     * @summary: Modify User Group
      * @description: Update user group partially on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
      */
     updateUserGroupPartially({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupPartiallyParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
 }
-import UserPlatformApplicationValidator = require("./UserPlatformApplicationValidator");
-import UserPlatformModel = require("./UserPlatformModel");
+import UserPlatformApplicationValidator = require("sdk/output/javascript/code/sdk/platform/User/UserPlatformApplicationValidator");
+import UserPlatformModel = require("sdk/output/javascript/code/sdk/platform/User/UserPlatformModel");

package/sdk/platform/User/UserPlatformApplicationClient.js

@@ -21,8 +21,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.ArchiveUserSuccess>} - Success response
    * @name archiveUser
-   * @summary: archive user
-   * @description: archive user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/archiveUser/).
+   * @summary: Archive User
+   * @description: Delete user from sales channel, allowing re-registration with the same mobile/email for a new user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/archiveUser/).
    */
   async archiveUser(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -98,8 +98,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.BlockUserSuccess>} - Success response
    * @name 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/).
+   * @summary: Block/Unblock Users
+   * @description: Manage user access by blocking or unblocking their accounts, restricting login for blocked accounts and allowing login for unblocked 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: Register and add a new user to the platform. - 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 sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUser/).
    */
   async createUser(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -258,7 +258,7 @@ class User {
    *   Success response
    * @name createUserAttributeDefinition
    * @summary: Create a User Attribute Definition
-   * @description: Use this API to areate a new User Attribute Definition - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserAttributeDefinition/).
+   * @description: Create a new User Attribute Definition - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserAttributeDefinition/).
    */
   async createUserAttributeDefinition(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -336,7 +336,7 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
    * @name createUserGroup
-   * @summary: Create user group.
+   * @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(
@@ -416,8 +416,8 @@ class User {
    * @returns {Promise<UserPlatformModel.CreateUserSessionResponseSchema>} -
    *   Success response
    * @name 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/).
+   * @summary: Create User Session
+   * @description: Create 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 active sessions.
-   * @description: End multiple active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
+   * @summary: Delete User Active Sessions
+   * @description: Terminate all active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
    */
   async deleteActiveSessions(
     { id, reason, requestHeaders } = { requestHeaders: {} },
@@ -582,7 +582,7 @@ class User {
    * @returns {Promise<UserPlatformModel.SessionDeleteResponseSchema>} -
    *   Success response
    * @name deleteSession
-   * @summary: Delete session.
+   * @summary: Delete User Session
    * @description: Terminate an active user session. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteSession/).
    */
   async deleteSession(
@@ -666,8 +666,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.SuccessMessageResponse>} - Success response
    * @name deleteUserAttribute
-   * @summary: delete User Attribute
-   * @description: delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
+   * @summary: Delete User Attribute
+   * @description: Delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
    */
   async deleteUserAttribute(
     { attributeDefId, userId, requestHeaders } = { requestHeaders: {} },
@@ -818,7 +818,7 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.SessionListResponseSchema>} - Success response
    * @name getActiveSessions
-   * @summary: Get active sessions.
+   * @summary: Get User 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(
@@ -898,8 +898,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
    * @name 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/).
+   * @summary: Get a List of Users
+   * @description: Retrieve details of users registered in the sales channel - 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 config.
-   * @description: Retrieve configuration settings for the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
+   * @summary: Get Platform Config
+   * @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
    */
   async getPlatformConfig(
     { requestHeaders } = { requestHeaders: {} },
@@ -1057,8 +1057,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
    * @name getUserAttribute
-   * @summary: get User Attribute
-   * @description: get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
+   * @summary: Get User Attribute
+   * @description: Get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
    */
   async getUserAttribute(
     { attributeDefId, userId, requestHeaders } = { requestHeaders: {} },
@@ -1135,7 +1135,7 @@ class User {
    * @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
    * @name getUserAttributeById
    * @summary: Get User Attribute
-   * @description: Get User Attribute details by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
+   * @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
    */
   async getUserAttributeById(
     { attributeId, requestHeaders } = { requestHeaders: {} },
@@ -1411,8 +1411,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<Object>} - Success response
    * @name getUserAttributesForUser
-   * @summary: Get User Attributes for user
-   * @description: Get all user attributes for user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributesForUser/).
+   * @summary: Get All Customer Attributes
+   * @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributesForUser/).
    */
   async getUserAttributesForUser(
     { userId, pageSize, pageNo, requestHeaders } = { requestHeaders: {} },
@@ -1496,7 +1496,7 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
    * @name getUserGroupById
-   * @summary: Get user group by ID.
+   * @summary: Get User Group
    * @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(
@@ -1576,7 +1576,7 @@ class User {
    * @returns {Promise<UserPlatformModel.UserGroupListResponseSchema>} -
    *   Success response
    * @name getUserGroups
-   * @summary: Get user groups.
+   * @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(
@@ -1671,8 +1671,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.UserSearchResponseSchema>} - Success response
    * @name searchUsers
-   * @summary: Search users.
-   * @description: Search and filter user profiles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/searchUsers/).
+   * @summary: Search an Existing Users
+   * @description: Search and filter users details registered in the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/searchUsers/).
    */
   async searchUsers(
     { q, query, requestHeaders } = { requestHeaders: {} },
@@ -1752,7 +1752,7 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.UnDeleteUserSuccess>} - Success response
    * @name unDeleteUser
-   * @summary: Undelete user.
+   * @summary: Restore Deleted User
    * @description: Restore a previously deleted user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/unDeleteUser/).
    */
   async unDeleteUser(
@@ -1831,8 +1831,8 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
    * @name 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/).
+   * @summary: Update Platform Config
+   * @description: Modify and update platform sales channel authentication configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updatePlatformConfig/).
    */
   async updatePlatformConfig(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1910,7 +1910,7 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
    * @name updateUser
-   * @summary: Update user.
+   * @summary: Update User Details
    * @description: Modify and update user profile information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUser/).
    */
   async updateUser(
@@ -2159,7 +2159,7 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
    * @name updateUserGroup
-   * @summary: Update user group.
+   * @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(
@@ -2242,7 +2242,7 @@ class User {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
    * @name updateUserGroupPartially
-   * @summary: Add or Remove an user from particular user group and update user group details
+   * @summary: Modify User Group
    * @description: Update user group partially on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
    */
   async updateUserGroupPartially(

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

@@ -472,4 +472,4 @@ type UpdateUserGroupPartiallyParam = {
     body: UserPlatformModel.PartialUserGroupUpdateSchema;
 };
 type GetPlatformConfigParam = any;
-import UserPlatformModel = require("./UserPlatformModel");
+import UserPlatformModel = require("sdk/output/javascript/code/sdk/platform/User/UserPlatformModel");

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

@@ -214,6 +214,7 @@ export = UserPlatformModel;
  * @property {string} username
  * @property {Object} [meta]
  * @property {string} [external_id]
+ * @property {string} [rr_id]
  */
 /**
  * @typedef CreateUserResponseSchema
@@ -391,6 +392,7 @@ export = UserPlatformModel;
  * @property {string} [last_name]
  * @property {string} [gender]
  * @property {string} [external_id]
+ * @property {string} [rr_id]
  * @property {Object} [meta]
  * @property {UserPhoneNumbers[]} [phone_numbers]
  * @property {UserEmails[]} [emails]
@@ -429,6 +431,7 @@ export = UserPlatformModel;
  * @property {string} [created_at]
  * @property {string} [updated_at]
  * @property {string} [external_id]
+ * @property {string} [rr_id]
  */
 /**
  * @typedef UserSearchSchema
@@ -449,23 +452,24 @@ export = UserPlatformModel;
  * @property {string} [created_at]
  * @property {string} [updated_at]
  * @property {string} [external_id]
+ * @property {string} [rr_id]
  * @property {boolean} [archive]
  * @property {string} [status]
  */
 /**
  * @typedef PhoneNumber
- * @property {boolean} [active]
- * @property {boolean} [primary]
- * @property {boolean} [verified]
- * @property {string} [phone]
- * @property {number} [country_code]
+ * @property {string} [phone] - Phone number
+ * @property {number} [country_code] - Country code
+ * @property {boolean} [active] - Is the phone number active
+ * @property {boolean} [primary] - Is it a primary phone number
+ * @property {boolean} [verified] - Is the phone number verified
  */
 /**
  * @typedef Email
- * @property {boolean} [primary]
- * @property {boolean} [verified]
- * @property {string} [email]
- * @property {boolean} [active]
+ * @property {string} [email] - Email address
+ * @property {boolean} [active] - Is the email active
+ * @property {boolean} [primary] - Is it a primary email
+ * @property {boolean} [verified] - Is the email verified
  */
 declare class UserPlatformModel {
 }
@@ -835,6 +839,7 @@ type CreateUserRequestSchema = {
     username: string;
     meta?: any;
     external_id?: string;
+    rr_id?: string;
 };
 /** @returns {CreateUserResponseSchema} */
 declare function CreateUserResponseSchema(): CreateUserResponseSchema;
@@ -1056,6 +1061,7 @@ type UpdateUserRequestSchema = {
     last_name?: string;
     gender?: string;
     external_id?: string;
+    rr_id?: string;
     meta?: any;
     phone_numbers?: UserPhoneNumbers[];
     emails?: UserEmails[];
@@ -1097,6 +1103,7 @@ type UserSchema = {
     created_at?: string;
     updated_at?: string;
     external_id?: string;
+    rr_id?: string;
 };
 /** @returns {UserSearchSchema} */
 declare function UserSearchSchema(): UserSearchSchema;
@@ -1118,23 +1125,51 @@ type UserSearchSchema = {
     created_at?: string;
     updated_at?: string;
     external_id?: string;
+    rr_id?: string;
     archive?: boolean;
     status?: string;
 };
 /** @returns {PhoneNumber} */
 declare function PhoneNumber(): PhoneNumber;
 type PhoneNumber = {
+    /**
+     * - Phone number
+     */
+    phone?: string;
+    /**
+     * - Country code
+     */
+    country_code?: number;
+    /**
+     * - Is the phone number active
+     */
     active?: boolean;
+    /**
+     * - Is it a primary phone number
+     */
     primary?: boolean;
+    /**
+     * - Is the phone number verified
+     */
     verified?: boolean;
-    phone?: string;
-    country_code?: number;
 };
 /** @returns {Email} */
 declare function Email(): Email;
 type Email = {
-    primary?: boolean;
-    verified?: boolean;
+    /**
+     * - Email address
+     */
     email?: string;
+    /**
+     * - Is the email active
+     */
     active?: boolean;
+    /**
+     * - Is it a primary email
+     */
+    primary?: boolean;
+    /**
+     * - Is the email verified
+     */
+    verified?: boolean;
 };