com.atlassian.servicedesk.api.customer

Interface CustomerService

@ExperimentalApi
 @ParametersAreNonnullByDefault
public interface CustomerService

Method Summary

Modifier and Type	Method and Description
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<CheckedUser>>	addCustomersToServiceDesk(com.atlassian.jira.user.ApplicationUser user, ServiceDesk serviceDesk, Set<String> usernameOrEmails) Adds existing JSD customers to a Service Desk project.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CheckedUser>	createCustomer(com.atlassian.jira.user.ApplicationUser user, CustomerCreateParameters customerCreateParameters) Creates a JSD customer.
CustomerCreateParameters.Builder	newCreateBuilder() Returns a new CustomerCreateParameters.Builder to build CustomerCreateParameters

Method Detail

createCustomer

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CheckedUser> createCustomer(com.atlassian.jira.user.ApplicationUser user,
                                                                                                           CustomerCreateParameters customerCreateParameters)

Creates a JSD customer. The newly created customer is not added to any JSD project, however he/she can raise request against unrestricted JSD projects.

Parameters:

user - the user executing the request. This user need to have JIRA global admininstrator permission.

customerCreateParameters - the parameters of the customer to be created

Returns:

the newly created customer

addCustomersToServiceDesk

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<CheckedUser>> addCustomersToServiceDesk(com.atlassian.jira.user.ApplicationUser user,
                                                                                                                            ServiceDesk serviceDesk,
                                                                                                                            Set<String> usernameOrEmails)

Adds existing JSD customers to a Service Desk project.

Parameters:

user - the user that is adding the customers

serviceDesk - the service desk to add customers to

usernameOrEmails - a set of usernames or emails corresponding to existing users

Returns:

AnError: if adding fails for any of the given users, or if validation fails List of users that were successfully added to the service desk.

newCreateBuilder

CustomerCreateParameters.Builder newCreateBuilder()

Returns a new CustomerCreateParameters.Builder to build CustomerCreateParameters