@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

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

@@ -11,6 +11,7 @@ declare class User {
      *   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.
      */
@@ -18,104 +19,115 @@ declare class User {
         q?: any;
         pageSize?: number;
         pageNo?: number;
-    }): Promise<any>;
+    }): Promise<CustomerListResponseSchema>;
     /**
      * @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<any>;
+    }): Promise<UserSearchResponseSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {CreateUserRequestSchema} arg.body
+     * @returns {Promise<CreateUserResponseSchema>} - Success response
      * @summary: Create user
      * @description: Create user
      */
     createUser({ body }?: {
         body: CreateUserRequestSchema;
-    }): Promise<any>;
+    }): Promise<CreateUserResponseSchema>;
     /**
      * @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
+     * @returns {Promise<ArchiveUserSuccess>} - Success response
      * @summary: archive user
      * @description: archive user
      */
     archiveUser({ body }?: {
         body: ArchiveUserRequestSchema;
-    }): Promise<any>;
+    }): Promise<ArchiveUserSuccess>;
     /**
      * @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<any>;
+    }): Promise<UnDeleteUserSuccess>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.userId - User ID
      * @param {UpdateUserRequestSchema} arg.body
+     * @returns {Promise<CreateUserResponseSchema>} - Success response
      * @summary: Update user
      * @description: Update user
      */
     updateUser({ userId, body }?: {
         userId: string;
         body: UpdateUserRequestSchema;
-    }): Promise<any>;
+    }): Promise<CreateUserResponseSchema>;
     /**
      * @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.
+     * @returns {Promise<SessionListResponseSchema>} - Success response
      * @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.
      */
     getActiveSessions({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<SessionListResponseSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - ID of a customer.
+     * @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.
      */
     deleteActiveSessions({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<SessionDeleteResponseSchema>;
     /**
      * @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 {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>;
 }