@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

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

@@ -4,197 +4,165 @@ declare class User {
     config: any;
     applicationId: any;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {ArchiveUserRequestSchema} arg.body
-     * @returns {Promise<ArchiveUserSuccess>} - Success response
+     * @param {UserPlatformApplicationValidator.ArchiveUserParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<UserPlatformModel.ArchiveUserSuccess>} - Success response
+     * @name archiveUser
      * @summary: archive user
-     * @description: archive user
+     * @description: archive user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/archiveUser/).
      */
-    archiveUser({ body }?: {
-        body: ArchiveUserRequestSchema;
-    }): Promise<ArchiveUserSuccess>;
+    archiveUser({ body }?: UserPlatformApplicationValidator.ArchiveUserParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.ArchiveUserSuccess>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {BlockUserRequestSchema} arg.body
-     * @returns {Promise<BlockUserSuccess>} - Success response
+     * @param {UserPlatformApplicationValidator.BlockOrUnblockUsersParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<UserPlatformModel.BlockUserSuccess>} - Success response
+     * @name blockOrUnblockUsers
      * @summary: Block/Unblock user
-     * @description: Block/Unblock user
+     * @description: Block/Unblock user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/blockOrUnblockUsers/).
      */
-    blockOrUnblockUsers({ body }?: {
-        body: BlockUserRequestSchema;
-    }): Promise<BlockUserSuccess>;
+    blockOrUnblockUsers({ body }?: UserPlatformApplicationValidator.BlockOrUnblockUsersParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.BlockUserSuccess>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {CreateUserRequestSchema} arg.body
-     * @returns {Promise<CreateUserResponseSchema>} - Success response
+     * @param {UserPlatformApplicationValidator.CreateUserParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
+     * @name createUser
      * @summary: Create user
-     * @description: Create user
+     * @description: Create user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUser/).
      */
-    createUser({ body }?: {
-        body: CreateUserRequestSchema;
-    }): Promise<CreateUserResponseSchema>;
+    createUser({ body }?: UserPlatformApplicationValidator.CreateUserParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.CreateUserResponseSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {CreateUserGroupSchema} arg.body
-     * @returns {Promise<UserGroupResponseSchema>} - Success response
+     * @param {UserPlatformApplicationValidator.CreateUserGroupParam} arg - Arg object
+     * @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
+     * @description: Use this API to create new user Group - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserGroup/).
      */
-    createUserGroup({ body }?: {
-        body: CreateUserGroupSchema;
-    }): Promise<UserGroupResponseSchema>;
+    createUserGroup({ body }?: UserPlatformApplicationValidator.CreateUserGroupParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.UserGroupResponseSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {CreateUserSessionRequestSchema} arg.body
-     * @returns {Promise<CreateUserSessionResponseSchema>} - Success response
+     * @param {UserPlatformApplicationValidator.CreateUserSessionParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<UserPlatformModel.CreateUserSessionResponseSchema>} -
+     *   Success response
+     * @name createUserSession
      * @summary: Create user session
-     * @description: Create user session
+     * @description: Create user session - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserSession/).
      */
-    createUserSession({ body }?: {
-        body: CreateUserSessionRequestSchema;
-    }): Promise<CreateUserSessionResponseSchema>;
+    createUserSession({ body }?: UserPlatformApplicationValidator.CreateUserSessionParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.CreateUserSessionResponseSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - ID of a customer.
-     * @param {string} arg.reason - Reason to delete sessions.
-     * @returns {Promise<SessionDeleteResponseSchema>} - Success response
+     * @param {UserPlatformApplicationValidator.DeleteActiveSessionsParam} arg
+     *   - Arg object
+     *
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<UserPlatformModel.SessionDeleteResponseSchema>} -
+     *   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.
-     */
-    deleteActiveSessions({ id, reason }?: {
-        id: string;
-        reason: string;
-    }): Promise<SessionDeleteResponseSchema>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - ID of a customer.
-     * @param {string} arg.sessionId - Session ID of a customer.
-     * @param {string} arg.reason - Reason for deleting session.
-     * @returns {Promise<SessionDeleteResponseSchema>} - Success response
+     * @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/).
+     */
+    deleteActiveSessions({ id, reason }?: UserPlatformApplicationValidator.DeleteActiveSessionsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.SessionDeleteResponseSchema>;
+    /**
+     * @param {UserPlatformApplicationValidator.DeleteSessionParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @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.
+     * @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/).
      */
-    deleteSession({ id, sessionId, reason }?: {
-        id: string;
-        sessionId: string;
-        reason: string;
-    }): Promise<SessionDeleteResponseSchema>;
+    deleteSession({ id, sessionId, reason }?: UserPlatformApplicationValidator.DeleteSessionParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.SessionDeleteResponseSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - ID of a customer.
-     * @returns {Promise<SessionListResponseSchema>} - Success response
+     * @param {UserPlatformApplicationValidator.GetActiveSessionsParam} arg - Arg object
+     * @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.
-     */
-    getActiveSessions({ id }?: {
-        id: string;
-    }): Promise<SessionListResponseSchema>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {Object} [arg.q] - The search query. Mobile number or email ID of
-     *   a customer.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each
-     *   page. Default value is 10.
-     * @param {number} [arg.pageNo] - The page number to navigate through the
-     *   given set of results. Default value is 1.
-     * @returns {Promise<CustomerListResponseSchema>} - Success response
+     * @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/).
+     */
+    getActiveSessions({ id }?: UserPlatformApplicationValidator.GetActiveSessionsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.SessionListResponseSchema>;
+    /**
+     * @param {UserPlatformApplicationValidator.GetCustomersParam} arg - Arg object
+     * @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.
+     * @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/).
      */
-    getCustomers({ q, pageSize, pageNo }?: {
-        q?: any;
-        pageSize?: number;
-        pageNo?: number;
-    }): Promise<CustomerListResponseSchema>;
+    getCustomers({ q, pageSize, pageNo }?: UserPlatformApplicationValidator.GetCustomersParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.CustomerListResponseSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<PlatformSchema>} - Success response
+     * @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.
+     * @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/).
      */
-    getPlatformConfig({}?: any): Promise<PlatformSchema>;
+    getPlatformConfig({ headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.PlatformSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.groupId - Numeric ID allotted to a User Group
-     * @returns {Promise<UserGroupResponseSchema>} - Success response
+     * @param {UserPlatformApplicationValidator.GetUserGroupByIdParam} arg - Arg object
+     * @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
-     */
-    getUserGroupById({ groupId }?: {
-        groupId: string;
-    }): Promise<UserGroupResponseSchema>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.pageNo] - Page number for pagination result
-     * @param {string} [arg.pageSize] - Page size for pagination result
-     * @param {string} [arg.name] - To seartch for User Groups which contains
-     *   given string in their name
-     * @param {string} [arg.status] - To get User Groups with given status
-     * @param {number} [arg.groupUid] - To get User Groups with given uid
-     * @returns {Promise<UserGroupListResponseSchema>} - Success response
+     * @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/).
+     */
+    getUserGroupById({ groupId }?: UserPlatformApplicationValidator.GetUserGroupByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.UserGroupResponseSchema>;
+    /**
+     * @param {UserPlatformApplicationValidator.GetUserGroupsParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @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
-     */
-    getUserGroups({ pageNo, pageSize, name, status, groupUid }?: {
-        pageNo?: string;
-        pageSize?: string;
-        name?: string;
-        status?: string;
-        groupUid?: number;
-    }): Promise<UserGroupListResponseSchema>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.q] - The search query. Mobile number or email ID of
-     *   a customer.
-     * @returns {Promise<UserSearchResponseSchema>} - Success response
+     * @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/).
+     */
+    getUserGroups({ pageNo, pageSize, name, status, groupUid }?: UserPlatformApplicationValidator.GetUserGroupsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.UserGroupListResponseSchema>;
+    /**
+     * @param {UserPlatformApplicationValidator.SearchUsersParam} arg - Arg object
+     * @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.
+     * @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/).
      */
-    searchUsers({ q }?: {
-        q?: string;
-    }): Promise<UserSearchResponseSchema>;
+    searchUsers({ q }?: UserPlatformApplicationValidator.SearchUsersParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.UserSearchResponseSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {UnDeleteUserRequestSchema} arg.body
-     * @returns {Promise<UnDeleteUserSuccess>} - Success response
+     * @param {UserPlatformApplicationValidator.UnDeleteUserParam} arg - Arg object
+     * @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
+     * @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/).
      */
-    unDeleteUser({ body }?: {
-        body: UnDeleteUserRequestSchema;
-    }): Promise<UnDeleteUserSuccess>;
+    unDeleteUser({ body }?: UserPlatformApplicationValidator.UnDeleteUserParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.UnDeleteUserSuccess>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {PlatformSchema} arg.body
-     * @returns {Promise<PlatformSchema>} - Success response
+     * @param {UserPlatformApplicationValidator.UpdatePlatformConfigParam} arg
+     *   - Arg object
+     *
+     * @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.
+     * @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/).
      */
-    updatePlatformConfig({ body }?: {
-        body: PlatformSchema;
-    }): Promise<PlatformSchema>;
+    updatePlatformConfig({ body }?: UserPlatformApplicationValidator.UpdatePlatformConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.PlatformSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.userId - User ID
-     * @param {UpdateUserRequestSchema} arg.body
-     * @returns {Promise<CreateUserResponseSchema>} - Success response
+     * @param {UserPlatformApplicationValidator.UpdateUserParam} arg - Arg object
+     * @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.
+     * @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/).
      */
-    updateUser({ userId, body }?: {
-        userId: string;
-        body: UpdateUserRequestSchema;
-    }): Promise<CreateUserResponseSchema>;
+    updateUser({ userId, body }?: UserPlatformApplicationValidator.UpdateUserParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.CreateUserResponseSchema>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.groupId - Numeric ID allotted to a User Group
-     * @param {UpdateUserGroupSchema} arg.body
-     * @returns {Promise<UserGroupResponseSchema>} - Success response
+     * @param {UserPlatformApplicationValidator.UpdateUserGroupParam} arg - Arg object
+     * @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
+     * @description: Use this API to update an existing user Group - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroup/).
      */
-    updateUserGroup({ groupId, body }?: {
-        groupId: string;
-        body: UpdateUserGroupSchema;
-    }): Promise<UserGroupResponseSchema>;
+    updateUserGroup({ groupId, body }?: UserPlatformApplicationValidator.UpdateUserGroupParam, { headers }?: import("../PlatformAPIClient").Options): Promise<UserPlatformModel.UserGroupResponseSchema>;
 }
+import UserPlatformApplicationValidator = require("./UserPlatformApplicationValidator");
+import UserPlatformModel = require("./UserPlatformModel");