com.atlassian.servicedesk.api.organization

Interface OrganizationService

@PublicApi
public interface OrganizationService

Method Summary

Modifier and Type	Method and Description
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,com.atlassian.fugue.Unit>	addOrganizationToServiceDesk(com.atlassian.jira.user.ApplicationUser user, OrganizationServiceDeskUpdateParameters organizationServiceDeskUpdateParameters) Adds an organization to a servicedesk if the user is an agent of that servicedesk
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,com.atlassian.fugue.Unit>	addUsersToOrganization(com.atlassian.jira.user.ApplicationUser executingUser, UsersOrganizationUpdateParameters parameters) Add users to a specified organization
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerOrganization>	createOrganization(com.atlassian.jira.user.ApplicationUser user, CreateOrganizationParameters parameters) Creates a new customer organization.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,com.atlassian.fugue.Unit>	delete(com.atlassian.jira.user.ApplicationUser user, Integer organizationId) Checks whether the user is JIRA admin and an agent.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerOrganization>	getById(com.atlassian.jira.user.ApplicationUser user, Integer organizationId) Checks whether the user is an agent or a member of the organization.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<CustomerOrganization>>	getOrganizations(com.atlassian.jira.user.ApplicationUser user, OrganizationsQuery requestQuery) Returns a list of organizations in the JIRA instance based on query parameters.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<com.atlassian.jira.user.ApplicationUser>>	getUsersInOrganization(com.atlassian.jira.user.ApplicationUser user, UsersInOrganizationQuery query) get all the applicationUsers in a given organization
CreateOrganizationParameters.Builder	newCreateBuilder() Returns a new CreateOrganizationParameters.Builder to build CreateOrganizationParameters
OrganizationServiceDeskUpdateParameters.Builder	newOrganizationServiceDeskUpdateParametersBuilder()
OrganizationsQuery.Builder	newOrganizationsQueryBuilder()
UsersInOrganizationQuery.Builder	newUsersInOrganizationQuery()
UsersOrganizationUpdateParameters.Builder	newUsersOrganizationUpdateParametersBuilder()
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,com.atlassian.fugue.Unit>	removeOrganizationFromServiceDesk(com.atlassian.jira.user.ApplicationUser user, OrganizationServiceDeskUpdateParameters organizationServiceDeskUpdateParameters) Removes an organization from a servicedesk if the user is an agent of that servicedesk
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,com.atlassian.fugue.Unit>	removeUsersFromOrganization(com.atlassian.jira.user.ApplicationUser user, UsersOrganizationUpdateParameters parameters) Removes users from a specified organization

Method Detail

getById

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerOrganization> getById(@Nonnull
                                                                                                             com.atlassian.jira.user.ApplicationUser user,
                                                                                                             @Nonnull
                                                                                                             Integer organizationId)

Checks whether the user is an agent or a member of the organization. True if - valid licensed, - is a member if the organization

Parameters:

user - the user who you want to check

organizationId - the ID of the organization you want retrieve.

Returns:

the organization.

createOrganization

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerOrganization> createOrganization(@Nonnull
                                                                                                                        com.atlassian.jira.user.ApplicationUser user,
                                                                                                                        @Nonnull
                                                                                                                        CreateOrganizationParameters parameters)

Creates a new customer organization. This method will check the JIRA settings first if the user needs to be an agent or a JIRA Administrator to create organizations

Parameters:

user - the user who you want to check

parameters - parameters to create a new organization

Returns:

the organization.

newCreateBuilder

CreateOrganizationParameters.Builder newCreateBuilder()

Returns a new CreateOrganizationParameters.Builder to build CreateOrganizationParameters

delete

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,com.atlassian.fugue.Unit> delete(@Nonnull
                                                                                                                com.atlassian.jira.user.ApplicationUser user,
                                                                                                                @Nonnull
                                                                                                                Integer organizationId)

Checks whether the user is JIRA admin and an agent. True if - is JIRA Admin with valid servicedesk agent license,

Parameters:

user - the user who you want to check

organizationId - the ID of the organization you want delete.

getUsersInOrganization

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<com.atlassian.jira.user.ApplicationUser>> getUsersInOrganization(@Nonnull
                                                                                                                                                              com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                                              UsersInOrganizationQuery query)

get all the applicationUsers in a given organization

Parameters:

user - the user who you want to check

query - the query containing the organization and the pageRequest

Returns:

a pagedResponse containing applicationUsers

newUsersInOrganizationQuery

UsersInOrganizationQuery.Builder newUsersInOrganizationQuery()

Returns:

a new UsersInOrganizationQuery.Builder to Build UsersInOrganizationQuery

getOrganizations

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<CustomerOrganization>> getOrganizations(@Nonnull
                                                                                                                                     com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                     @Nonnull
                                                                                                                                     OrganizationsQuery requestQuery)

Returns a list of organizations in the JIRA instance based on query parameters. If the user is not an agent, the resource returns a list of organizations the user is a member of.

Parameters:

user - the user who performs a query

requestQuery - the query containing the pageRequest

Returns:

Paginated list of organizations or an error.

newOrganizationsQueryBuilder

OrganizationsQuery.Builder newOrganizationsQueryBuilder()

Returns:

New OrganizationsQuery.Builder to build OrganizationsQuery

addOrganizationToServiceDesk

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,com.atlassian.fugue.Unit> addOrganizationToServiceDesk(@Nonnull
                                                                                                                                      com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                      @Nonnull
                                                                                                                                      OrganizationServiceDeskUpdateParameters organizationServiceDeskUpdateParameters)

Adds an organization to a servicedesk if the user is an agent of that servicedesk

Parameters:

user - the user adding the organization

organizationServiceDeskUpdateParameters - contains the servicedesk id and the organization

Returns:

a unit if successful otherwise an error

removeOrganizationFromServiceDesk

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,com.atlassian.fugue.Unit> removeOrganizationFromServiceDesk(@Nonnull
                                                                                                                                           com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                           @Nonnull
                                                                                                                                           OrganizationServiceDeskUpdateParameters organizationServiceDeskUpdateParameters)

Removes an organization from a servicedesk if the user is an agent of that servicedesk

Parameters:

user - the user removing the organization

organizationServiceDeskUpdateParameters - contains the servicedesk id and the organization

Returns:

a unit if successful otherwise an error

newOrganizationServiceDeskUpdateParametersBuilder

OrganizationServiceDeskUpdateParameters.Builder newOrganizationServiceDeskUpdateParametersBuilder()

Returns:

a new OrganizationServiceDeskUpdateParameters.Builder to build OrganizationServiceDeskUpdateParameters parameters

addUsersToOrganization

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,com.atlassian.fugue.Unit> addUsersToOrganization(@Nonnull
                                                                                                                                com.atlassian.jira.user.ApplicationUser executingUser,
                                                                                                                                @Nonnull
                                                                                                                                UsersOrganizationUpdateParameters parameters)

Add users to a specified organization

Parameters:

executingUser - the user who you want to check

parameters - the parameters containing the organization and users to add

removeUsersFromOrganization

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,com.atlassian.fugue.Unit> removeUsersFromOrganization(@Nonnull
                                                                                                                                     com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                     @Nonnull
                                                                                                                                     UsersOrganizationUpdateParameters parameters)

Removes users from a specified organization

Parameters:

user - the user who you want to check

parameters - parameters containing the users to remove from the given organization

newUsersOrganizationUpdateParametersBuilder

UsersOrganizationUpdateParameters.Builder newUsersOrganizationUpdateParametersBuilder()

Returns:

a new UsersOrganizationUpdateParameters.Builder to Build UsersOrganizationUpdateParameters