/** * Use the API in the StakeholderUtils module to handle the participants of a case. * @module StakeholderUtils */ import { C11nEnv } from '../interpreter/c11n-env'; import type { ParticipantData } from './types'; /** * Obtains the list of participants for a specific case. * @function * @static * @example In this example, the API obtains the list of participants of a case whose ID is W-102. * PCore.getStakeholderUtils().getParticipants('ORG-APP-WORK W-102', getPConnect()) * .then(participants => { * // participants array * }).catch(err => { * // errors * }); * * @param caseID The ID of the case pointing to pzInsKey value whose list of participants must be obtained. * @param pConnectObj The pConnect object of the component from where the API is being called. * @returns A Promise that returns the list of participants linked to the specified case. */ export declare const getParticipants: (caseID: string, pConnectObj: C11nEnv) => Promise; /** * Obtains the list of participant roles for a specific case. * @function * @static * @example In this example, the API obtains the list of participants of a case whose ID is W-102. * PCore.getStakeholderUtils().getParticipantRoles('ORG-APP-WORK W-102', getPConnect()) * .then(roles => { * // roles array * }).catch(err => { * // errors * }); * @param caseID The ID of the case poiting to pzInsKey value whose list of participants must be obtained. * @param pConnectObj The pConnect object of the component from where the API is being called. * @returns A Promise that returns the list of participant roles for the specified case. */ export declare const getParticipantRoles: (caseID: string, pConnectObj: C11nEnv) => Promise; /** * Gets participant data by ID. * @function * @static * @example In this example, the API gets the data of participant with participant ID 'Interested_02', linked to a case whose ID is W-102. * PCore.getStakeholderUtils().getParticipant('ORG-APP-WORK W-102','Interested_02', getPConnect()) * .then(participantData => { * // participantData * }).catch(err => { * // errors * }); * @param caseID The ID of the case pointing to pzInsKey value whose list of participants must be obtained. * @param participantID The string containing the participant ID. * @param pConnectObj The pConnect object of the component from where the API is being called. * @returns A Promise that returns the participant details for the specified ID. */ export declare const getParticipant: (caseID: string, participantID: string, pConnectObj: C11nEnv) => Promise; /** * Creates a new participant. * @function * @static * @example In this example, the API creates a new participant "Sam Smith" of role "Interested" for a case whose ID is W-102. * * const participantData = { * "content":{ * "pyFirstName":"Sam", * "pyLastName":"Smith", * "pyEmail1":"samsmith@test.com", * "pyPhoneNumber":"+11234567899", * "pyTitle":"Developer" * } * }; * PCore.getStakeholderUtils().createParticipant('ORG-APP-WORK W-102','Interested', participantData, getPConnect()) * .then(newParticipantData => { * // newParticipantData * }).catch(err => { * // errors * }); * @param caseID The ID of the case pointing to pzInsKey value whose list of participants must be obtained. * @param participantRoleID The string containing the new participant role Id. * @param participantData Data object containing participant details. * @param pConnectObj The pConnect object of the component from where the API is being called. * @returns A Promise that returns data of participant created for the case. */ export declare const createParticipant: (caseID: string, participantRoleID: string, participantData: ParticipantData, pConnectObj: C11nEnv, transientContext?: string) => Promise; /** * Updates the details of a participant for a case. * @function * @static * @example In this example, the API updates an existing participant with ID "Interested_02" of a case whose ID is W-102. * const updatedParticipantData = { * "content": { * "pyFirstName":"Sam", * "pyLastName":"Smith" * } * }; * PCore.getStakeholderUtils().updateParticipant('ORG-APP-WORK W-102','Interested_02', updatedParticipantData, getPConnect()) * .then(updatedParticipantData => { * // updatedParticipantData * }).catch(err => { * // errors * }); * @param caseID The ID of the case pointing to pzInsKey value whose list of participants must be obtained. * @param participantID The ID of the participant to edit. * @param participantData The object containing the params for updated participant data. * @param pConnectObj The pConnect object of the component from where the API is being called. * @returns A Promise that returns data of participant updated for the case. */ export declare const updateParticipant: (caseID: string, participantID: string, participantData: ParticipantData, pConnectObj: C11nEnv, transientContext?: string) => Promise; /** * Deletes an existing participant linked to a case * @function * @static * @example In this example, the API deletes an existing participant with ID "Interested_02" of a case whose ID is W-102. * PCore.getStakeholderUtils().deleteParticipant('ORG-APP-WORK W-102', 'Interested_02', getPConnect()) * .then(updatedParticipantData => { * // updatedParticipantData * }).catch(err => { * // errors * }); * @param caseID The ID of the case pointing to pzInsKey value whose list of participants must be obtained. * @param participantID The ID of the participant to delete. Eg: Owner_01, Interested_01, Customer * @param pConnectObj The pConnect object of the component from where the API is being called. */ export declare const deleteParticipant: (caseID: string, participantID: string, pConnectObj: C11nEnv) => Promise; /** * Obtains the view for a participant role for a case. * @function * @static * @example In this example, the API obtains the list of participants of a case whose ID is W-102 and role 'Owner'. * PCore.getStakeholderUtils().getRoleView('ORG-APP-WORK W-102', 'Owner', getPConnect()) * .then(view => { * // role view * }).catch(err => { * // errors * }); * @param caseID The ID of the case pointing to pzInsKey value whose list of participants must be obtained. * @param participantRoleID The ID of participant role whose view must be obtained. * @param pConnectObj The pConnect object of the component from where the API is being called. * @returns A Promise that returns the details of the specified participant role. */ export declare const getRoleView: (caseID: string, participantRoleID: string, pConnectObj: C11nEnv) => Promise; declare const _default: { getParticipants: (caseID: string, pConnectObj: C11nEnv) => Promise; getRoleView: (caseID: string, participantRoleID: string, pConnectObj: C11nEnv) => Promise; getParticipantRoles: (caseID: string, pConnectObj: C11nEnv) => Promise; getParticipant: (caseID: string, participantID: string, pConnectObj: C11nEnv) => Promise; createParticipant: (caseID: string, participantRoleID: string, participantData: ParticipantData, pConnectObj: C11nEnv, transientContext?: string) => Promise; updateParticipant: (caseID: string, participantID: string, participantData: ParticipantData, pConnectObj: C11nEnv, transientContext?: string) => Promise; deleteParticipant: (caseID: string, participantID: string, pConnectObj: C11nEnv) => Promise; }; export default _default;