@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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

@@ -5,117 +5,196 @@ declare class User {
     applicationId: any;
     /**
      * @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.
-     * @summary: Get a list of customers
-     * @description: Use this API to retrieve a list of customers who have registered in the application.
-     */
-    getCustomers({ q, pageSize, pageNo }?: {
-        q?: any;
-        pageSize?: number;
-        pageNo?: number;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.q] - The search query. Mobile number or email ID of
-     *   a customer.
-     * @summary: Search an existing user.
-     * @description: Use this API to retrieve an existing user from a list.
-     */
-    searchUsers({ q }?: {
-        q?: string;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {CreateUserRequestSchema} arg.body
-     * @summary: Create user
-     * @description: Create user
+     * @param {ArchiveUserRequestSchema} arg.body
+     * @returns {Promise<ArchiveUserSuccess>} - Success response
+     * @summary: archive user
+     * @description: archive user
      */
-    createUser({ body }?: {
-        body: CreateUserRequestSchema;
-    }): Promise<any>;
+    archiveUser({ body }?: {
+        body: ArchiveUserRequestSchema;
+    }): Promise<ArchiveUserSuccess>;
     /**
      * @param {Object} arg - Arg object.
      * @param {BlockUserRequestSchema} arg.body
+     * @returns {Promise<BlockUserSuccess>} - Success response
      * @summary: Block/Unblock user
      * @description: Block/Unblock user
      */
     blockOrUnblockUsers({ body }?: {
         body: BlockUserRequestSchema;
-    }): Promise<any>;
+    }): Promise<BlockUserSuccess>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {ArchiveUserRequestSchema} arg.body
-     * @summary: archive user
-     * @description: archive user
-     */
-    archiveUser({ body }?: {
-        body: ArchiveUserRequestSchema;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {UnDeleteUserRequestSchema} arg.body
-     * @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
+     * @param {CreateUserRequestSchema} arg.body
+     * @returns {Promise<CreateUserResponseSchema>} - Success response
+     * @summary: Create user
+     * @description: Create user
      */
-    unDeleteUser({ body }?: {
-        body: UnDeleteUserRequestSchema;
-    }): Promise<any>;
+    createUser({ body }?: {
+        body: CreateUserRequestSchema;
+    }): Promise<CreateUserResponseSchema>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.userId - User ID
-     * @param {UpdateUserRequestSchema} arg.body
-     * @summary: Update user
-     * @description: Update user
+     * @param {CreateUserGroupSchema} arg.body
+     * @returns {Promise<UserGroupResponseSchema>} - Success response
+     * @summary: Create an User Group
+     * @description: Use this API to create new user Group
      */
-    updateUser({ userId, body }?: {
-        userId: string;
-        body: UpdateUserRequestSchema;
-    }): Promise<any>;
+    createUserGroup({ body }?: {
+        body: CreateUserGroupSchema;
+    }): Promise<UserGroupResponseSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {CreateUserSessionRequestSchema} arg.body
+     * @returns {Promise<CreateUserSessionResponseSchema>} - Success response
      * @summary: Create user session
      * @description: Create user session
      */
     createUserSession({ body }?: {
         body: CreateUserSessionRequestSchema;
-    }): Promise<any>;
+    }): Promise<CreateUserSessionResponseSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - ID of a customer.
-     * @summary: Get a list of all session for a user
-     * @description: Use this API to retrieve a list of session of customers who have registered in the application.
+     * @param {string} arg.reason - Reason to delete sessions.
+     * @returns {Promise<SessionDeleteResponseSchema>} - Success response
+     * @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.
      */
-    getActiveSessions({ id }?: {
+    deleteActiveSessions({ id, reason }?: {
         id: string;
-    }): Promise<any>;
+        reason: string;
+    }): Promise<SessionDeleteResponseSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - ID of a customer.
-     * @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.
+     * @param {string} arg.sessionId - Session ID of a customer.
+     * @param {string} arg.reason - Reason for deleting session.
+     * @returns {Promise<SessionDeleteResponseSchema>} - Success response
+     * @summary: Delete a session for a user
+     * @description: Use this API to Delete a session of customers who have registered in the application.
      */
-    deleteActiveSessions({ id }?: {
+    deleteSession({ id, sessionId, reason }?: {
         id: string;
-    }): Promise<any>;
+        sessionId: string;
+        reason: string;
+    }): Promise<SessionDeleteResponseSchema>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - ID of a customer.
+     * @returns {Promise<SessionListResponseSchema>} - Success response
+     * @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
+     * @summary: Get a list of customers
+     * @description: Use this API to retrieve a list of customers who have registered in the application.
+     */
+    getCustomers({ q, pageSize, pageNo }?: {
+        q?: any;
+        pageSize?: number;
+        pageNo?: number;
+    }): Promise<CustomerListResponseSchema>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<PlatformSchema>} - Success response
      * @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.
      */
-    getPlatformConfig({}?: any): Promise<any>;
+    getPlatformConfig({}?: any): Promise<PlatformSchema>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.groupId - Numeric ID allotted to a User Group
+     * @returns {Promise<UserGroupResponseSchema>} - Success response
+     * @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
+     * @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
+     * @summary: Search an existing user.
+     * @description: Use this API to retrieve an existing user from a list.
+     */
+    searchUsers({ q }?: {
+        q?: string;
+    }): Promise<UserSearchResponseSchema>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {UnDeleteUserRequestSchema} arg.body
+     * @returns {Promise<UnDeleteUserSuccess>} - Success response
+     * @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
+     */
+    unDeleteUser({ body }?: {
+        body: UnDeleteUserRequestSchema;
+    }): Promise<UnDeleteUserSuccess>;
     /**
      * @param {Object} arg - Arg object.
      * @param {PlatformSchema} arg.body
+     * @returns {Promise<PlatformSchema>} - Success response
      * @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.
      */
     updatePlatformConfig({ body }?: {
         body: PlatformSchema;
-    }): Promise<any>;
+    }): Promise<PlatformSchema>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.userId - User ID
+     * @param {UpdateUserRequestSchema} arg.body
+     * @returns {Promise<CreateUserResponseSchema>} - Success response
+     * @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.
+     */
+    updateUser({ userId, body }?: {
+        userId: string;
+        body: UpdateUserRequestSchema;
+    }): Promise<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
+     * @summary: Update an User Group
+     * @description: Use this API to update an existing user Group
+     */
+    updateUserGroup({ groupId, body }?: {
+        groupId: string;
+        body: UpdateUserGroupSchema;
+    }): Promise<UserGroupResponseSchema>;
 }