export type Followers = { name: string; ID: string; email: string; }; export type FollowersResponse = { data: { followers: Followers[]; }; }; /** * This API adds specified users as followers to a case. * @function * @static * @example In this example, the API adds a user whose ID is user-1 as follower to the case whose ID is W-102. * PCore.getCaseFollowerApi().addCaseFollower('ORG-APP-WORK W-102', ['user-1'], 'app/primary_1') * .then(() => { * // success * }).catch(err => { * // Error handling * }); * * @param caseID The ID of the case pointing to pzInsKey value to which the user need to be added as follower. * @param userID The ID of the user which needs to be added added as follower to a case passed as an array. Eg: ["user-1","user-2"] * @param context The name of the context from where the API is being called. * @returns A Promise that adds the specified users as followers to a case. */ export declare const addCaseFollower: (caseID: string, userID: string[], context: string) => Promise; /** * This API deletes the follower of a case. * @function * @static * @example In this example, he API deletes the follower whose ID is user-1 for case whose ID is W-02. * PCore.getCaseFollowerApi().deleteCaseFollower('ORG-APP-WORK W-02', 'user-1', 'app/primary_1') * .then(() => { * // success * }).catch(err => { * // errors * }); * * @param caseID An ID of the case pointing to pzInsKey value for which we want to delete the follower * @param followerID An ID of the follower which we want to delete for a case * @param context The name of the context from where the API is being called. */ export declare const deleteCaseFollower: (caseID: string, followerID: string, context: string) => Promise>; /** * Returns a Promise that gets the followers of a case. * @function * @static * @example In this example, the API obtains the followers of a case whose ID is W-102. * PCore.getCaseFollowerApi().getCaseFollowers('ORG-APP-WORK W-102', 'app/primary_1') * .then(followers => { * // followers array * }).catch(err => { * // errors * }); * * @param caseID The ID of the case pointing to pzInsKey value whose followers must be obtained. * @param context The name of the context from where the API is being called. * @returns A Promise that obtains the followers of a case. */ export declare const getCaseFollowers: (caseID: string, context: string) => Promise; declare const _default: { addCaseFollower: (caseID: string, userID: string[], context: string) => Promise; deleteCaseFollower: (caseID: string, followerID: string, context: string) => Promise>; getCaseFollowers: (caseID: string, context: string) => Promise; }; export default _default;