Interface CustomerService
@PublicApi
@ParametersAreNonnullByDefault
public interface CustomerService
-
Method Summary
Modifier and TypeMethodDescriptionaddCustomersToServiceDesk
(com.atlassian.jira.user.ApplicationUser user, ServiceDesk serviceDesk, Set<String> usernameOrEmails) Adds existing Jira Service Management customers to a service project.createCustomer
(com.atlassian.jira.user.ApplicationUser user, CustomerCreateParameters customerCreateParameters) Creates a Jira Service Management customer.Returns a newCustomerCreateParameters.Builder
to buildCustomerCreateParameters
-
Method Details
-
createCustomer
CheckedUser createCustomer(com.atlassian.jira.user.ApplicationUser user, CustomerCreateParameters customerCreateParameters) Creates a Jira Service Management customer. The newly created customer is not added to any service project, however they can raise requests in unrestricted service projects.- Parameters:
user
- the user executing the request. This user needs to have the Jira global administrator permission.customerCreateParameters
- the parameters of the customer to be created- Returns:
- the newly created customer
- Throws:
ServiceDeskServiceException
- if creating user fails for a given user, or if validation fails
-
addCustomersToServiceDesk
List<CheckedUser> addCustomersToServiceDesk(com.atlassian.jira.user.ApplicationUser user, ServiceDesk serviceDesk, Set<String> usernameOrEmails) Adds existing Jira Service Management customers to a service project.- Parameters:
user
- the user that is adding the customersserviceDesk
- the service project to add customers tousernameOrEmails
- a set of usernames or emails corresponding to existing users- Returns:
- List of users that were successfully added to the service project.
- Throws:
ServiceDeskServiceException
- if adding fails for any of the given users, or if validation fails
-
newCreateBuilder
CustomerCreateParameters.Builder newCreateBuilder()Returns a newCustomerCreateParameters.Builder
to buildCustomerCreateParameters
-