Zendesk (zendesk-java-client 0.14.0 API)

java.lang.Object
- org.zendesk.client.v2.Zendesk

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class Zendesk
extends Object
implements Closeable
```
Since:

04/04/2013 13:08

Author:

stephenc

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Zendesk.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Zendesk.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`List<String>`	`addTagToOrganisations(long id, String... tags)`
`List<String>`	`addTagToTicket(long id, String... tags)`
`List<String>`	`addTagToTopics(long id, String... tags)`
`void`	`associateAttachmentsToArticle(String idArticle, List<Attachment> attachments)`
`void`	`changeUserPassword(User user, String oldPassword, String newPassword)`
`void`	`close()`
`Article`	`createArticle(Article article)`
`Article`	`createArticle(Article article, boolean notifySubscribers)`
`Translation`	`createArticleTranslation(Long articleId, Translation translation)`
`Automation`	`createAutomation(Automation automation)`
`Category`	`createCategory(Category category)`
`Translation`	`createCategoryTranslation(Long categoryId, Translation translation)`
`Ticket`	`createComment(long ticketId, Comment comment)`
`DynamicContentItem`	`createDynamicContentItem(DynamicContentItem item)`
`DynamicContentItemVariant`	`createDynamicContentItemVariant(Long itemId, DynamicContentItemVariant variant)`
`Forum`	`createForum(Forum forum)`
`Group`	`createGroup(Group group)`
`GroupMembership`	`createGroupMembership(GroupMembership groupMembership)`
`GroupMembership`	`createGroupMembership(long user_id, GroupMembership groupMembership)`
`List<Group>`	`createGroups(Group... groups)` Deprecated.
`List<Group>`	`createGroups(List<Group> groups)` Deprecated.
`Macro`	`createMacro(Macro macro)`
`static com.fasterxml.jackson.databind.ObjectMapper`	`createMapper()`
`Organization`	`createOrganization(Organization organization)`
`OrganizationMembership`	`createOrganizationMembership(long user_id, OrganizationMembership organizationMembership)`
`OrganizationMembership`	`createOrganizationMembership(OrganizationMembership organizationMembership)`
`JobStatus`	`createOrganizationMemberships(List<OrganizationMembership> organizationMemberships)` https://developer.zendesk.com/rest_api/docs/support/organization_memberships#create-many-memberships
`JobStatus`	`createOrganizationMemberships(OrganizationMembership... organizationMemberships)` https://developer.zendesk.com/rest_api/docs/support/organization_memberships#create-many-memberships
`org.asynchttpclient.ListenableFuture<JobStatus>`	`createOrganizationMembershipsAsync(List<OrganizationMembership> organizationMemberships)` https://developer.zendesk.com/rest_api/docs/support/organization_memberships#create-many-memberships
`JobStatus`	`createOrganizations(List<Organization> organizations)`
`JobStatus`	`createOrganizations(Organization... organizations)`
`org.asynchttpclient.ListenableFuture<JobStatus>`	`createOrganizationsAsync(List<Organization> organizations)`
`User`	`createOrUpdateUser(User user)`
`JobStatus`	`createOrUpdateUsers(List<User> users)`
`JobStatus`	`createOrUpdateUsers(User... users)`
`org.asynchttpclient.ListenableFuture<JobStatus>`	`createOrUpdateUsersAsync(List<User> users)`
`PermissionGroup`	`createPermissionGroup(PermissionGroup permissionGroup)` Create permission group
`Request`	`createRequest(Request request)`
`SatisfactionRating`	`createSatisfactionRating(long ticketId, SatisfactionRating satisfactionRating)`
`SatisfactionRating`	`createSatisfactionRating(Ticket ticket, SatisfactionRating satisfactionRating)`
`Section`	`createSection(Section section)`
`Translation`	`createSectionTranslation(Long sectionId, Translation translation)`
`Target`	`createTarget(Target target)`
`Ticket`	`createTicket(Ticket ticket)`
`org.asynchttpclient.ListenableFuture<Ticket>`	`createTicketAsync(Ticket ticket)`
`Field`	`createTicketField(Field field)`
`TicketForm`	`createTicketForm(TicketForm ticketForm)`
`Ticket`	`createTicketFromTweet(long tweetId, long monitorId)`
`JobStatus`	`createTickets(List<Ticket> tickets)`
`JobStatus`	`createTickets(Ticket... tickets)`
`org.asynchttpclient.ListenableFuture<JobStatus>`	`createTicketsAsync(List<Ticket> tickets)`
`Topic`	`createTopic(Topic topic)`
`Trigger`	`createTrigger(Trigger trigger)`
`Attachment.Upload`	`createUpload(String fileName, byte[] content)`
`Attachment.Upload`	`createUpload(String fileName, String contentType, byte[] content)`
`Attachment.Upload`	`createUpload(String token, String fileName, String contentType, byte[] content)`
`ArticleAttachments`	`createUploadArticle(long articleId, File file)` Create upload article with inline false
`ArticleAttachments`	`createUploadArticle(long articleId, File file, boolean inline)`
`User`	`createUser(User user)`
`Identity`	`createUserIdentity(long userId, Identity identity)`
`Identity`	`createUserIdentity(User user, Identity identity)`
`JobStatus`	`createUsers(List<User> users)`
`JobStatus`	`createUsers(User... users)`
`org.asynchttpclient.ListenableFuture<JobStatus>`	`createUsersAsync(List<User> users)`
`UserSegment`	`createUserSegment(UserSegment userSegment)` Create User Segment
`void`	`deleteArticle(Article article)`
`void`	`deleteArticleAttachment(ArticleAttachments attachment)` Delete attachment from article.
`void`	`deleteArticleAttachment(long id)` Delete attachment from article.
`void`	`deleteAttachment(Attachment attachment)`
`void`	`deleteAttachment(long id)`
`void`	`deleteAutomation(long automationId)`
`void`	`deleteCategory(Category category)`
`void`	`deleteDynamicContentItem(DynamicContentItem item)`
`void`	`deleteDynamicContentItemVariant(Long itemId, DynamicContentItemVariant variant)`
`void`	`deleteForum(Forum forum)`
`void`	`deleteGroup(Group group)`
`void`	`deleteGroup(long id)`
`void`	`deleteGroupMembership(GroupMembership groupMembership)`
`void`	`deleteGroupMembership(long id)`
`void`	`deleteGroupMembership(long user_id, GroupMembership groupMembership)`
`void`	`deleteGroupMembership(long user_id, long group_membership_id)`
`void`	`deleteOrganization(long id)`
`void`	`deleteOrganization(Organization organization)`
`void`	`deleteOrganizationMembership(long id)`
`void`	`deleteOrganizationMembership(long user_id, long organization_membership_id)`
`void`	`deleteOrganizationMembership(long user_id, OrganizationMembership organizationMembership)`
`void`	`deleteOrganizationMemberships(long id, long... ids)` https://developer.zendesk.com/rest_api/docs/support/organization_memberships#bulk-delete-memberships
`void`	`deletePermissionGroup(long id)` Delete permission group
`void`	`deletePermissionGroup(PermissionGroup permissionGroup)` Delete permission group
`void`	`deleteSection(Section section)`
`void`	`deleteSuspendedTicket(long id)`
`void`	`deleteSuspendedTicket(SuspendedTicket ticket)`
`void`	`deleteTarget(long targetId)`
`void`	`deleteTicket(long id)`
`void`	`deleteTicket(Ticket ticket)`
`void`	`deleteTicketField(Field field)`
`void`	`deleteTicketField(long id)`
`void`	`deleteTickets(long id, long... ids)`
`void`	`deleteTopic(Topic topic)`
`void`	`deleteTranslation(Long translationId)` Delete translation.
`void`	`deleteTranslation(Translation translation)` Delete translation.
`void`	`deleteTrigger(long triggerId)`
`void`	`deleteUpload(Attachment.Upload upload)`
`void`	`deleteUpload(String token)`
`void`	`deleteUser(long id)`
`void`	`deleteUser(User user)`
`void`	`deleteUserIdentity(long userId, long identityId)`
`void`	`deleteUserIdentity(User user, Identity identity)`
`void`	`deleteUserIdentity(User user, long identityId)`
`void`	`deleteUserSegment(long id)` Delete User Segment
`void`	`deleteUserSegment(UserSegment userSegment)` Delete User Segment
`Article`	`getArticle(long id)`
`Iterable<Article>`	`getArticleFromSearch(String searchTerm)`
`Iterable<Article>`	`getArticleFromSearch(String searchTerm, Long sectionId)`
`Iterable<Article>`	`getArticles()` Get all articles from help center.
`Iterable<Article>`	`getArticles(Category category)`
`Iterable<Article>`	`getArticles(Section section)`
`Iterable<Article>`	`getArticles(String locale)`
`Iterable<Article>`	`getArticlesFromAllLabels(List<String> labels)`
`Iterable<Article>`	`getArticlesFromAnyLabels(List<String> labels)`
`List<Article>`	`getArticlesFromPage(int page)`
`Iterable<Article>`	`getArticlesIncrementally(Date startTime)`
`Iterable<Subscription>`	`getArticleSubscriptions(Long articleId)`
`Iterable<Subscription>`	`getArticleSubscriptions(Long articleId, String locale)`
`Iterable<Translation>`	`getArticleTranslations(Long articleId)`
`Iterable<GroupMembership>`	`getAssignableGroupMemberships()`
`List<GroupMembership>`	`getAssignableGroupMemberships(long group_id)`
`Iterable<Group>`	`getAssignableGroups()`
`Attachment`	`getAttachment(Attachment attachment)`
`Attachment`	`getAttachment(long id)`
`List<ArticleAttachments>`	`getAttachmentsFromArticle(Long articleID)`
`User`	`getAuthenticatedUser()`
`Iterable<Organization>`	`getAutoCompleteOrganizations(String name)`
`Automation`	`getAutomation(long id)`
`Iterable<Automation>`	`getAutomations()`
`List<Brand>`	`getBrands()`
`Iterable<Category>`	`getCategories()`
`Category`	`getCategory(long id)`
`Iterable<Translation>`	`getCategoryTranslations(Long categoryId)`
`Iterable<Request>`	`getCCRequests()`
`Iterable<ComplianceDeletionStatus>`	`getComplianceDeletionStatuses(long userId)`
`User`	`getCurrentUser()`
`Iterable<AgentRole>`	`getCustomAgentRoles()`
`Iterable<DeletedTicket>`	`getDeletedTickets()` https://developer.zendesk.com/rest_api/docs/support/tickets#list-deleted-tickets
`Iterable<DeletedTicket>`	`getDeletedTickets(String sortBy, SortOrder sortOrder)` https://developer.zendesk.com/rest_api/docs/support/tickets#list-deleted-tickets
`DynamicContentItem`	`getDynamicContentItem(long id)`
`Iterable<DynamicContentItem>`	`getDynamicContentItems()`
`DynamicContentItemVariant`	`getDynamicContentItemVariant(Long itemId, long id)`
`Iterable<DynamicContentItemVariant>`	`getDynamicContentItemVariants(DynamicContentItem item)` VARIANTS
`Forum`	`getForum(long id)`
`Iterable<Forum>`	`getForums()`
`List<Forum>`	`getForums(long category_id)`
`Group`	`getGroup(long id)`
`GroupMembership`	`getGroupMembership(long id)`
`GroupMembership`	`getGroupMembership(long user_id, long group_membership_id)`
`List<GroupMembership>`	`getGroupMembershipByUser(long user_id)`
`Iterable<GroupMembership>`	`getGroupMemberships()`
`List<GroupMembership>`	`getGroupMemberships(long group_id)`
`OrganizationMembership`	`getGroupOrganization(long user_id, long organization_membership_id)`
`Iterable<Group>`	`getGroups()`
`Iterable<User>`	`getGroupUsers(long id)`
`List<String>`	`getHelpCenterLocales()`
`Iterable<Holiday>`	`getHolidaysForSchedule(Long scheduleId)`
`Iterable<Holiday>`	`getHolidaysForSchedule(Schedule schedule)`
`Map`	`getIncrementalTicketsResult(long unixEpochTime)`
`JobStatus`	`getJobStatus(JobStatus status)`
`org.asynchttpclient.ListenableFuture<JobStatus>`	`getJobStatusAsync(JobStatus status)`
`List<JobStatus>`	`getJobStatuses(List<JobStatus> statuses)`
`org.asynchttpclient.ListenableFuture<List<JobStatus>>`	`getJobStatusesAsync(List<JobStatus> statuses)`
`Macro`	`getMacro(long macroId)`
`Iterable<Macro>`	`getMacros()`
`Iterable<Request>`	`getOpenRequests()`
`Organization`	`getOrganization(long id)`
`Iterable<OrganizationField>`	`getOrganizationFields()`
`OrganizationMembership`	`getOrganizationMembership(long id)`
`List<OrganizationMembership>`	`getOrganizationMembershipByUser(long user_id)`
`OrganizationMembership`	`getOrganizationMembershipForUser(long user_id, long id)`
`Iterable<OrganizationMembership>`	`getOrganizationMemberships()`
`Iterable<OrganizationMembership>`	`getOrganizationMembershipsForOrg(long organization_id)`
`Iterable<OrganizationMembership>`	`getOrganizationMembershipsForUser(long user_id)`
`Iterable<Organization>`	`getOrganizations()`
`Iterable<Organization>`	`getOrganizationsIncrementally(Date startTime)`
`Iterable<Ticket>`	`getOrganizationTickets(long organizationId)`
`Iterable<User>`	`getOrganizationUsers(long id)`
`PermissionGroup`	`getPermissionGroup(long id)` Get permission group by id
`Iterable<PermissionGroup>`	`getPermissionGroups()` Get all permission groups
`Iterable<Ticket>`	`getRecentTickets()`
`Request`	`getRequest(long id)`
`Comment`	`getRequestComment(long requestId, long commentId)`
`Comment`	`getRequestComment(Request request, Comment comment)`
`Comment`	`getRequestComment(Request request, long commentId)`
`Iterable<Comment>`	`getRequestComments(long id)`
`Iterable<Comment>`	`getRequestComments(Request request)`
`Iterable<Request>`	`getRequests()`
`SatisfactionRating`	`getSatisfactionRating(long id)`
`Iterable<SatisfactionRating>`	`getSatisfactionRatings()`
`Schedule`	`getSchedule(Long scheduleId)`
`Schedule`	`getSchedule(Schedule schedule)`
`Iterable<Schedule>`	`getSchedules()` Get a list of the current business hours schedules
`<T extends SearchResultEntity> Iterable<T>`	`getSearchResults(Class<T> type, String query)`
`<T extends SearchResultEntity> Iterable<T>`	`getSearchResults(Class<T> type, String query, Map<String,Object> params)`
`<T extends SearchResultEntity> Iterable<T>`	`getSearchResults(Class<T> type, String query, String params)` Deprecated. Use `getSearchResults(Class, String, Map)` instead.
`<T extends SearchResultEntity> Iterable<T>`	`getSearchResults(Class<T> type, String query, String sortBy, SortOrder sortOrder)`
`Iterable<SearchResultEntity>`	`getSearchResults(String query)`
`Section`	`getSection(long id)`
`Iterable<Section>`	`getSections()`
`Iterable<Section>`	`getSections(Category category)`
`Iterable<Section>`	`getSections(UserSegment userSegment)` List Sections using a User Segment
`Iterable<Subscription>`	`getSectionSubscriptions(Long sectionId)`
`Iterable<Subscription>`	`getSectionSubscriptions(Long sectionId, String locale)`
`Iterable<Translation>`	`getSectionTranslations(Long sectionId)`
`Iterable<Request>`	`getSolvedRequests()`
`Iterable<SuspendedTicket>`	`getSuspendedTickets()`
`Target`	`getTarget(long id)`
`Iterable<Target>`	`getTargets()`
`Ticket`	`getTicket(long id)`
`Audit`	`getTicketAudit(long ticketId, long auditId)`
`Audit`	`getTicketAudit(Ticket ticket, Audit audit)`
`Audit`	`getTicketAudit(Ticket ticket, long id)`
`Iterable<Audit>`	`getTicketAudits(Long id)`
`Iterable<Audit>`	`getTicketAudits(Ticket ticket)`
`List<User>`	`getTicketCollaborators(long id)`
`Iterable<Comment>`	`getTicketComments(long id)`
`Iterable<Comment>`	`getTicketComments(long id, SortOrder order)`
`Field`	`getTicketField(long id)`
`List<Field>`	`getTicketFields()`
`TicketForm`	`getTicketForm(long id)`
`List<TicketForm>`	`getTicketForms()`
`List<Ticket>`	`getTicketIncidents(long id)`
`Metric`	`getTicketMetric(long id)`
`Metric`	`getTicketMetricByTicket(long id)`
`Iterable<Metric>`	`getTicketMetrics()`
`Iterable<Ticket>`	`getTickets()`
`List<Ticket>`	`getTickets(long id, long... ids)`
`Iterable<Ticket>`	`getTicketsByExternalId(String externalId)`
`Iterable<Ticket>`	`getTicketsByExternalId(String externalId, boolean includeArchived)`
`Iterable<Ticket>`	`getTicketsByStatus(Status... ticketStatus)` Deprecated. This API is no longer available from the vendor. Use the `getTicketsFromSearch(String)` method instead
`Iterable<Ticket>`	`getTicketsFromSearch(String searchTerm)`
`Iterable<Ticket>`	`getTicketsIncrementally(Date startTime)` https://developer.zendesk.com/rest_api/docs/support/incremental_export
`Iterable<Ticket>`	`getTicketsIncrementally(Date startTime, Date endTime)` Deprecated. incremental export does not support an end_time parameter
`Topic`	`getTopic(long id)`
`Iterable<Topic>`	`getTopics()`
`List<Topic>`	`getTopics(long forum_id)`
`List<Topic>`	`getTopics(long id, long... ids)`
`Iterable<Topic>`	`getTopics(UserSegment userSegment)` List Topics using a User Segment
`List<Topic>`	`getTopicsByUser(long user_id)`
`Trigger`	`getTrigger(long id)`
`Iterable<Trigger>`	`getTriggers()`
`Iterable<TwitterMonitor>`	`getTwitterMonitors()`
`User`	`getUser(long id)`
`Iterable<Ticket>`	`getUserCCDTickets(long userId)`
`Iterable<UserField>`	`getUserFields()`
`List<Identity>`	`getUserIdentities(long userId)`
`List<Identity>`	`getUserIdentities(User user)`
`Identity`	`getUserIdentity(long userId, long identityId)`
`Identity`	`getUserIdentity(User user, Identity identity)`
`Identity`	`getUserIdentity(User user, long identityId)`
`UserRelatedInfo`	`getUserRelatedInfo(long userId)`
`Iterable<Ticket>`	`getUserRequestedTickets(long userId)`
`Iterable<Request>`	`getUserRequests(long id)`
`Iterable<Request>`	`getUserRequests(User user)`
`Iterable<User>`	`getUsers()`
`Iterable<User>`	`getUsersByRole(String role, String... roles)`
`UserSegment`	`getUserSegment(long id)` Get user segment by id
`Iterable<UserSegment>`	`getUserSegments()` Get user segments
`Iterable<UserSegment>`	`getUserSegments(long id)` Returns the list of user segments that a particular user belongs to
`Iterable<UserSegment>`	`getUserSegmentsApplicable()` Request only user segments applicable on the account's current Guide plan
`Iterable<User>`	`getUsersIncrementally(Date startTime)`
`Iterable<Subscription>`	`getUserSubscriptions(Long userId)`
`Iterable<Subscription>`	`getUserSubscriptions(User user)`
`protected <T> org.zendesk.client.v2.Zendesk.ZendeskAsyncCompletionHandler<T>`	`handle(Class<T> clazz)`
`protected <T> org.zendesk.client.v2.Zendesk.ZendeskAsyncCompletionHandler<T>`	`handle(Class<T> clazz, String name, Class... typeParams)`
`protected org.zendesk.client.v2.Zendesk.PagedAsyncCompletionHandler<List<ArticleAttachments>>`	`handleArticleAttachmentsList(String name)`
`protected <T> org.zendesk.client.v2.Zendesk.PagedAsyncCompletionHandler<List<T>>`	`handleIncrementalList(Class<T> clazz, String name)`
`protected org.zendesk.client.v2.Zendesk.ZendeskAsyncCompletionHandler<JobStatus>`	`handleJobStatus()`
`protected <T> org.zendesk.client.v2.Zendesk.PagedAsyncCompletionHandler<List<T>>`	`handleList(Class<T> clazz, String name)`
`protected org.zendesk.client.v2.Zendesk.PagedAsyncCompletionHandler<List<SearchResultEntity>>`	`handleSearchList(String name)`
`protected org.zendesk.client.v2.Zendesk.ZendeskAsyncCompletionHandler<Void>`	`handleStatus()`
`protected org.zendesk.client.v2.Zendesk.PagedAsyncCompletionHandler<List<Target>>`	`handleTargetList(String name)`
`Ticket`	`importTicket(TicketImport ticketImport)`
`JobStatus`	`importTickets(List<TicketImport> ticketImports)`
`JobStatus`	`importTickets(TicketImport... ticketImports)`
`org.asynchttpclient.ListenableFuture<JobStatus>`	`importTicketsAsync(List<TicketImport> ticketImports)`
`Topic`	`importTopic(Topic topic)`
`boolean`	`isClosed()`
`Iterable<Organization>`	`lookupOrganizationsByExternalId(String externalId)`
`Iterable<User>`	`lookupUserByEmail(String email)`
`Iterable<User>`	`lookupUserByExternalId(String externalId)`
`Ticket`	`macrosShowChangesToTicket(long macroId)`
`Ticket`	`macrosShowTicketAfterChanges(long ticketId, long macroId)`
`void`	`makePrivateTicketAudit(long ticketId, long auditId)`
`void`	`makePrivateTicketAudit(Ticket ticket, Audit audit)`
`void`	`makePrivateTicketAudit(Ticket ticket, long id)`
`void`	`markTicketAsSpam(long id)`
`void`	`markTicketAsSpam(Ticket ticket)`
`User`	`mergeUsers(long userIdThatWillRemain, long userIdThatWillBeMerged)`
`void`	`notifyApp(String json)`
`JobStatus`	`permanentlyDeleteTicket(long id)`
`JobStatus`	`permanentlyDeleteTicket(Ticket ticket)`
`JobStatus`	`permanentlyDeleteTickets(long id, long... ids)`
`User`	`permanentlyDeleteUser(long id)`
`User`	`permanentlyDeleteUser(User user)`
`org.asynchttpclient.ListenableFuture<JobStatus>`	`queueCreateTicketAsync(Ticket ticket)`
`List<String>`	`removeTagFromOrganisations(long id, String... tags)`
`List<String>`	`removeTagFromTicket(long id, String... tags)`
`List<String>`	`removeTagFromTopics(long id, String... tags)`
`Identity`	`requestVerifyUserIdentity(long userId, long identityId)`
`Identity`	`requestVerifyUserIdentity(User user, Identity identity)`
`Identity`	`requestVerifyUserIdentity(User user, long identityId)`
`void`	`resetUserPassword(long id, String password)`
`void`	`resetUserPassword(User user, String password)`
`List<GroupMembership>`	`setGroupMembershipAsDefault(long user_id, GroupMembership groupMembership)`
`List<OrganizationMembership>`	`setOrganizationMembershipAsDefault(long user_id, OrganizationMembership organizationMembership)`
`List<String>`	`setTagOnOrganisations(long id, String... tags)`
`List<String>`	`setTagOnTicket(long id, String... tags)`
`List<String>`	`setTagOnTopics(long id, String... tags)`
`List<Identity>`	`setUserPrimaryIdentity(long userId, long identityId)`
`List<Identity>`	`setUserPrimaryIdentity(User user, Identity identity)`
`List<Identity>`	`setUserPrimaryIdentity(User user, long identityId)`
`User`	`suspendUser(long id)`
`void`	`trustTicketAudit(long ticketId, long auditId)`
`void`	`trustTicketAudit(Ticket ticket, Audit audit)`
`void`	`trustTicketAudit(Ticket ticket, long id)`
`User`	`unsuspendUser(long id)`
`Article`	`updateArticle(Article article)`
`Translation`	`updateArticleTranslation(Long articleId, String locale, Translation translation)`
`Automation`	`updateAutomation(Long automationId, Automation automation)`
`Category`	`updateCategory(Category category)`
`Translation`	`updateCategoryTranslation(Long categoryId, String locale, Translation translation)`
`DynamicContentItem`	`updateDynamicContentItem(DynamicContentItem item)`
`DynamicContentItemVariant`	`updateDynamicContentItemVariant(Long itemId, DynamicContentItemVariant variant)`
`Forum`	`updateForum(Forum forum)`
`Group`	`updateGroup(Group group)`
`void`	`updateInstallation(int id, String json)`
`Macro`	`updateMacro(Long macroId, Macro macro)`
`Organization`	`updateOrganization(Organization organization)`
`JobStatus`	`updateOrganizations(List<Organization> organizations)`
`JobStatus`	`updateOrganizations(Organization... organizations)`
`org.asynchttpclient.ListenableFuture<JobStatus>`	`updateOrganizationsAsync(List<Organization> organizations)`
`PermissionGroup`	`updatePermissionGroup(PermissionGroup permissionGroup)` Update permission group
`Request`	`updateRequest(Request request)`
`Section`	`updateSection(Section section)`
`Translation`	`updateSectionTranslation(Long sectionId, String locale, Translation translation)`
`Ticket`	`updateTicket(Ticket ticket)`
`Field`	`updateTicketField(Field field)`
`JobStatus`	`updateTickets(List<Ticket> tickets)`
`JobStatus`	`updateTickets(Ticket... tickets)`
`org.asynchttpclient.ListenableFuture<JobStatus>`	`updateTicketsAsync(List<Ticket> tickets)`
`Topic`	`updateTopic(Topic topic)`
`Trigger`	`updateTrigger(Long triggerId, Trigger trigger)`
`User`	`updateUser(User user)`
`Identity`	`updateUserIdentity(long userId, Identity identity)`
`Identity`	`updateUserIdentity(User user, Identity identity)`
`JobStatus`	`updateUsers(List<User> users)`
`JobStatus`	`updateUsers(User... users)`
`org.asynchttpclient.ListenableFuture<JobStatus>`	`updateUsersAsync(List<User> users)`
`UserSegment`	`updateUserSegment(UserSegment userSegment)` Update User Segment
`Identity`	`verifyUserIdentity(long userId, long identityId)`
`Identity`	`verifyUserIdentity(User user, Identity identity)`
`Identity`	`verifyUserIdentity(User user, long identityId)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isClosed
```
public boolean isClosed()
```

close
```
public void close()
```
Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getJobStatus

public JobStatus getJobStatus(JobStatus status)

getJobStatusAsync

public org.asynchttpclient.ListenableFuture<JobStatus> getJobStatusAsync(JobStatus status)

getJobStatuses

public List<JobStatus> getJobStatuses(List<JobStatus> statuses)

getJobStatusesAsync

public org.asynchttpclient.ListenableFuture<List<JobStatus>> getJobStatusesAsync(List<JobStatus> statuses)

getBrands
```
public List<Brand> getBrands()
```

getTicketForm

public TicketForm getTicketForm(long id)

getTicketForms

public List<TicketForm> getTicketForms()

createTicketForm

public TicketForm createTicketForm(TicketForm ticketForm)

importTicket

public Ticket importTicket(TicketImport ticketImport)

importTickets

public JobStatus importTickets(TicketImport... ticketImports)

importTickets

public JobStatus importTickets(List<TicketImport> ticketImports)

importTicketsAsync

public org.asynchttpclient.ListenableFuture<JobStatus> importTicketsAsync(List<TicketImport> ticketImports)

getTicket
```
public Ticket getTicket(long id)
```

getTicketIncidents

public List<Ticket> getTicketIncidents(long id)

getTicketCollaborators

public List<User> getTicketCollaborators(long id)

getDeletedTickets
```
public Iterable<DeletedTicket> getDeletedTickets()
```
https://developer.zendesk.com/rest_api/docs/support/tickets#list-deleted-tickets

getDeletedTickets

public Iterable<DeletedTicket> getDeletedTickets(String sortBy,
                                                 SortOrder sortOrder)

https://developer.zendesk.com/rest_api/docs/support/tickets#list-deleted-tickets

deleteTicket

public void deleteTicket(Ticket ticket)

deleteTicket
```
public void deleteTicket(long id)
```

permanentlyDeleteTicket

public JobStatus permanentlyDeleteTicket(Ticket ticket)

permanentlyDeleteTicket

public JobStatus permanentlyDeleteTicket(long id)

queueCreateTicketAsync

public org.asynchttpclient.ListenableFuture<JobStatus> queueCreateTicketAsync(Ticket ticket)

createTicketAsync

public org.asynchttpclient.ListenableFuture<Ticket> createTicketAsync(Ticket ticket)

createTicket

public Ticket createTicket(Ticket ticket)

createTickets

public JobStatus createTickets(Ticket... tickets)

createTickets

public JobStatus createTickets(List<Ticket> tickets)

createTicketsAsync

public org.asynchttpclient.ListenableFuture<JobStatus> createTicketsAsync(List<Ticket> tickets)

updateTicket

public Ticket updateTicket(Ticket ticket)

updateTickets

public JobStatus updateTickets(Ticket... tickets)

updateTickets

public JobStatus updateTickets(List<Ticket> tickets)

updateTicketsAsync

public org.asynchttpclient.ListenableFuture<JobStatus> updateTicketsAsync(List<Ticket> tickets)

markTicketAsSpam

public void markTicketAsSpam(Ticket ticket)

markTicketAsSpam

public void markTicketAsSpam(long id)

deleteTickets

public void deleteTickets(long id,
                          long... ids)

permanentlyDeleteTickets

public JobStatus permanentlyDeleteTickets(long id,
                                          long... ids)

getTickets
```
public Iterable<Ticket> getTickets()
```

getTicketsByStatus
```
@Deprecated
public Iterable<Ticket> getTicketsByStatus(Status... ticketStatus)
```
Deprecated. This API is no longer available from the vendor. Use the getTicketsFromSearch(String) method instead

Parameters:

ticketStatus -

Returns:

getTicketsByExternalId

public Iterable<Ticket> getTicketsByExternalId(String externalId,
                                               boolean includeArchived)

getTicketsByExternalId

public Iterable<Ticket> getTicketsByExternalId(String externalId)

getTicketsFromSearch

public Iterable<Ticket> getTicketsFromSearch(String searchTerm)

getArticleFromSearch

public Iterable<Article> getArticleFromSearch(String searchTerm)

getArticleFromSearch

public Iterable<Article> getArticleFromSearch(String searchTerm,
                                              Long sectionId)

getArticlesFromAnyLabels

public Iterable<Article> getArticlesFromAnyLabels(List<String> labels)

getArticlesFromAllLabels

public Iterable<Article> getArticlesFromAllLabels(List<String> labels)

getAttachmentsFromArticle

public List<ArticleAttachments> getAttachmentsFromArticle(Long articleID)

getTickets

public List<Ticket> getTickets(long id,
                               long... ids)

getRecentTickets

public Iterable<Ticket> getRecentTickets()

getTicketsIncrementally
```
public Iterable<Ticket> getTicketsIncrementally(Date startTime)
```
https://developer.zendesk.com/rest_api/docs/support/incremental_export

getTicketsIncrementally

@Deprecated
public Iterable<Ticket> getTicketsIncrementally(Date startTime,
                                                            Date endTime)

Deprecated. incremental export does not support an end_time parameter

https://developer.zendesk.com/rest_api/docs/support/incremental_export

getOrganizationTickets

public Iterable<Ticket> getOrganizationTickets(long organizationId)

getUserRequestedTickets

public Iterable<Ticket> getUserRequestedTickets(long userId)

getComplianceDeletionStatuses

public Iterable<ComplianceDeletionStatus> getComplianceDeletionStatuses(long userId)

getUserCCDTickets

public Iterable<Ticket> getUserCCDTickets(long userId)

getUserRelatedInfo

public UserRelatedInfo getUserRelatedInfo(long userId)

getTicketMetrics

public Iterable<Metric> getTicketMetrics()

getTicketMetricByTicket

public Metric getTicketMetricByTicket(long id)

getTicketMetric

public Metric getTicketMetric(long id)

getTicketAudits

public Iterable<Audit> getTicketAudits(Ticket ticket)

getTicketAudits

public Iterable<Audit> getTicketAudits(Long id)

getTicketAudit

public Audit getTicketAudit(Ticket ticket,
                            Audit audit)

getTicketAudit

public Audit getTicketAudit(Ticket ticket,
                            long id)

getTicketAudit

public Audit getTicketAudit(long ticketId,
                            long auditId)

trustTicketAudit

public void trustTicketAudit(Ticket ticket,
                             Audit audit)

trustTicketAudit

public void trustTicketAudit(Ticket ticket,
                             long id)

trustTicketAudit

public void trustTicketAudit(long ticketId,
                             long auditId)

makePrivateTicketAudit

public void makePrivateTicketAudit(Ticket ticket,
                                   Audit audit)

makePrivateTicketAudit

public void makePrivateTicketAudit(Ticket ticket,
                                   long id)

makePrivateTicketAudit

public void makePrivateTicketAudit(long ticketId,
                                   long auditId)

getTicketFields
```
public List<Field> getTicketFields()
```

getTicketField
```
public Field getTicketField(long id)
```

createTicketField

public Field createTicketField(Field field)

updateTicketField

public Field updateTicketField(Field field)

deleteTicketField

public void deleteTicketField(Field field)

deleteTicketField

public void deleteTicketField(long id)

getSuspendedTickets

public Iterable<SuspendedTicket> getSuspendedTickets()

deleteSuspendedTicket

public void deleteSuspendedTicket(SuspendedTicket ticket)

deleteSuspendedTicket

public void deleteSuspendedTicket(long id)

createUpload

public Attachment.Upload createUpload(String fileName,
                                      byte[] content)

createUpload

public Attachment.Upload createUpload(String fileName,
                                      String contentType,
                                      byte[] content)

createUpload

public Attachment.Upload createUpload(String token,
                                      String fileName,
                                      String contentType,
                                      byte[] content)

associateAttachmentsToArticle

public void associateAttachmentsToArticle(String idArticle,
                                          List<Attachment> attachments)

createUploadArticle

public ArticleAttachments createUploadArticle(long articleId,
                                              File file)
                                       throws IOException

Create upload article with inline false

Throws:: IOException

createUploadArticle

public ArticleAttachments createUploadArticle(long articleId,
                                              File file,
                                              boolean inline)
                                       throws IOException

Throws:: IOException

deleteUpload

public void deleteUpload(Attachment.Upload upload)

deleteUpload

public void deleteUpload(String token)

getAttachment

public Attachment getAttachment(Attachment attachment)

getAttachment

public Attachment getAttachment(long id)

deleteAttachment

public void deleteAttachment(Attachment attachment)

deleteAttachment

public void deleteAttachment(long id)

getTargets
```
public Iterable<Target> getTargets()
```

getTarget
```
public Target getTarget(long id)
```

createTarget

public Target createTarget(Target target)

deleteTarget

public void deleteTarget(long targetId)

getTriggers

public Iterable<Trigger> getTriggers()

getTrigger
```
public Trigger getTrigger(long id)
```

createTrigger

public Trigger createTrigger(Trigger trigger)

updateTrigger

public Trigger updateTrigger(Long triggerId,
                             Trigger trigger)

deleteTrigger

public void deleteTrigger(long triggerId)

getAutomations

public Iterable<Automation> getAutomations()

getAutomation

public Automation getAutomation(long id)

createAutomation

public Automation createAutomation(Automation automation)

updateAutomation

public Automation updateAutomation(Long automationId,
                                   Automation automation)

deleteAutomation

public void deleteAutomation(long automationId)

getTwitterMonitors

public Iterable<TwitterMonitor> getTwitterMonitors()

getUsers
```
public Iterable<User> getUsers()
```

getUsersByRole

public Iterable<User> getUsersByRole(String role,
                                     String... roles)

getUsersIncrementally

public Iterable<User> getUsersIncrementally(Date startTime)

getGroupUsers

public Iterable<User> getGroupUsers(long id)

getOrganizationUsers

public Iterable<User> getOrganizationUsers(long id)

getUser
```
public User getUser(long id)
```

getAuthenticatedUser
```
public User getAuthenticatedUser()
```

getUserFields

public Iterable<UserField> getUserFields()

createUser
```
public User createUser(User user)
```

mergeUsers

public User mergeUsers(long userIdThatWillRemain,
                       long userIdThatWillBeMerged)

createUsers

public JobStatus createUsers(User... users)

createUsers

public JobStatus createUsers(List<User> users)

createUsersAsync

public org.asynchttpclient.ListenableFuture<JobStatus> createUsersAsync(List<User> users)

createOrUpdateUser

public User createOrUpdateUser(User user)

createOrUpdateUsers

public JobStatus createOrUpdateUsers(User... users)

createOrUpdateUsers

public JobStatus createOrUpdateUsers(List<User> users)

createOrUpdateUsersAsync

public org.asynchttpclient.ListenableFuture<JobStatus> createOrUpdateUsersAsync(List<User> users)

updateUser
```
public User updateUser(User user)
```

updateUsers

public JobStatus updateUsers(User... users)

updateUsers

public JobStatus updateUsers(List<User> users)

updateUsersAsync

public org.asynchttpclient.ListenableFuture<JobStatus> updateUsersAsync(List<User> users)

deleteUser
```
public void deleteUser(User user)
```

deleteUser
```
public void deleteUser(long id)
```

permanentlyDeleteUser

public User permanentlyDeleteUser(User user)

permanentlyDeleteUser

public User permanentlyDeleteUser(long id)

suspendUser
```
public User suspendUser(long id)
```

unsuspendUser
```
public User unsuspendUser(long id)
```

lookupUserByEmail

public Iterable<User> lookupUserByEmail(String email)

lookupUserByExternalId

public Iterable<User> lookupUserByExternalId(String externalId)

getCurrentUser
```
public User getCurrentUser()
```

resetUserPassword

public void resetUserPassword(User user,
                              String password)

resetUserPassword

public void resetUserPassword(long id,
                              String password)

changeUserPassword

public void changeUserPassword(User user,
                               String oldPassword,
                               String newPassword)

getUserIdentities

public List<Identity> getUserIdentities(User user)

getUserIdentities

public List<Identity> getUserIdentities(long userId)

getUserIdentity

public Identity getUserIdentity(User user,
                                Identity identity)

getUserIdentity

public Identity getUserIdentity(User user,
                                long identityId)

getUserIdentity

public Identity getUserIdentity(long userId,
                                long identityId)

setUserPrimaryIdentity

public List<Identity> setUserPrimaryIdentity(User user,
                                             Identity identity)

setUserPrimaryIdentity

public List<Identity> setUserPrimaryIdentity(User user,
                                             long identityId)

setUserPrimaryIdentity

public List<Identity> setUserPrimaryIdentity(long userId,
                                             long identityId)

verifyUserIdentity

public Identity verifyUserIdentity(User user,
                                   Identity identity)

verifyUserIdentity

public Identity verifyUserIdentity(User user,
                                   long identityId)

verifyUserIdentity

public Identity verifyUserIdentity(long userId,
                                   long identityId)

requestVerifyUserIdentity

public Identity requestVerifyUserIdentity(User user,
                                          Identity identity)

requestVerifyUserIdentity

public Identity requestVerifyUserIdentity(User user,
                                          long identityId)

requestVerifyUserIdentity

public Identity requestVerifyUserIdentity(long userId,
                                          long identityId)

updateUserIdentity

public Identity updateUserIdentity(long userId,
                                   Identity identity)

updateUserIdentity

public Identity updateUserIdentity(User user,
                                   Identity identity)

deleteUserIdentity

public void deleteUserIdentity(User user,
                               Identity identity)

deleteUserIdentity

public void deleteUserIdentity(User user,
                               long identityId)

deleteUserIdentity

public void deleteUserIdentity(long userId,
                               long identityId)

createUserIdentity

public Identity createUserIdentity(long userId,
                                   Identity identity)

createUserIdentity

public Identity createUserIdentity(User user,
                                   Identity identity)

getCustomAgentRoles

public Iterable<AgentRole> getCustomAgentRoles()

getRequests

public Iterable<Request> getRequests()

getOpenRequests

public Iterable<Request> getOpenRequests()

getSolvedRequests

public Iterable<Request> getSolvedRequests()

getCCRequests

public Iterable<Request> getCCRequests()

getUserRequests

public Iterable<Request> getUserRequests(User user)

getUserRequests

public Iterable<Request> getUserRequests(long id)

getRequest
```
public Request getRequest(long id)
```

createRequest

public Request createRequest(Request request)

updateRequest

public Request updateRequest(Request request)

getRequestComments

public Iterable<Comment> getRequestComments(Request request)

getRequestComments

public Iterable<Comment> getRequestComments(long id)

getTicketComments

public Iterable<Comment> getTicketComments(long id)

getTicketComments

public Iterable<Comment> getTicketComments(long id,
                                           SortOrder order)

getRequestComment

public Comment getRequestComment(Request request,
                                 Comment comment)

getRequestComment

public Comment getRequestComment(Request request,
                                 long commentId)

getRequestComment

public Comment getRequestComment(long requestId,
                                 long commentId)

createComment

public Ticket createComment(long ticketId,
                            Comment comment)

createTicketFromTweet

public Ticket createTicketFromTweet(long tweetId,
                                    long monitorId)

getOrganizations

public Iterable<Organization> getOrganizations()

getOrganizationsIncrementally

public Iterable<Organization> getOrganizationsIncrementally(Date startTime)

getOrganizationFields

public Iterable<OrganizationField> getOrganizationFields()

getAutoCompleteOrganizations

public Iterable<Organization> getAutoCompleteOrganizations(String name)

getOrganization

public Organization getOrganization(long id)

createOrganization

public Organization createOrganization(Organization organization)

createOrganizations

public JobStatus createOrganizations(Organization... organizations)

createOrganizations

public JobStatus createOrganizations(List<Organization> organizations)

createOrganizationsAsync

public org.asynchttpclient.ListenableFuture<JobStatus> createOrganizationsAsync(List<Organization> organizations)

updateOrganization

public Organization updateOrganization(Organization organization)

updateOrganizations

public JobStatus updateOrganizations(Organization... organizations)

updateOrganizations

public JobStatus updateOrganizations(List<Organization> organizations)

updateOrganizationsAsync

public org.asynchttpclient.ListenableFuture<JobStatus> updateOrganizationsAsync(List<Organization> organizations)

deleteOrganization

public void deleteOrganization(Organization organization)

deleteOrganization

public void deleteOrganization(long id)

lookupOrganizationsByExternalId

public Iterable<Organization> lookupOrganizationsByExternalId(String externalId)

getOrganizationMemberships

public Iterable<OrganizationMembership> getOrganizationMemberships()

getOrganizationMembershipsForOrg

public Iterable<OrganizationMembership> getOrganizationMembershipsForOrg(long organization_id)

getOrganizationMembershipsForUser

public Iterable<OrganizationMembership> getOrganizationMembershipsForUser(long user_id)

getOrganizationMembershipForUser

public OrganizationMembership getOrganizationMembershipForUser(long user_id,
                                                               long id)

getOrganizationMembership

public OrganizationMembership getOrganizationMembership(long id)

createOrganizationMembership

public OrganizationMembership createOrganizationMembership(OrganizationMembership organizationMembership)

createOrganizationMemberships
```
public JobStatus createOrganizationMemberships(OrganizationMembership... organizationMemberships)
```
https://developer.zendesk.com/rest_api/docs/support/organization_memberships#create-many-memberships

createOrganizationMemberships
```
public JobStatus createOrganizationMemberships(List<OrganizationMembership> organizationMemberships)
```
https://developer.zendesk.com/rest_api/docs/support/organization_memberships#create-many-memberships

createOrganizationMembershipsAsync

public org.asynchttpclient.ListenableFuture<JobStatus> createOrganizationMembershipsAsync(List<OrganizationMembership> organizationMemberships)

https://developer.zendesk.com/rest_api/docs/support/organization_memberships#create-many-memberships

deleteOrganizationMembership

public void deleteOrganizationMembership(long id)

deleteOrganizationMemberships
```
public void deleteOrganizationMemberships(long id,
                                          long... ids)
```
https://developer.zendesk.com/rest_api/docs/support/organization_memberships#bulk-delete-memberships

getGroups
```
public Iterable<Group> getGroups()
```

getAssignableGroups

public Iterable<Group> getAssignableGroups()

getGroup
```
public Group getGroup(long id)
```

createGroup

public Group createGroup(Group group)

createGroups
```
@Deprecated
public List<Group> createGroups(Group... groups)
```
Deprecated.

This API will be removed in a future release. The API endpoint does not exist. Instead, the createGroup method should be called for each Group

See Also:

Zendesk Java Client Issue #111

createGroups
```
@Deprecated
public List<Group> createGroups(List<Group> groups)
```
Deprecated.

This API will be removed in a future release. The API endpoint does not exist. Instead, the createGroup method should be called for each Group

See Also:

Zendesk Java Client Issue #111

updateGroup

public Group updateGroup(Group group)

deleteGroup
```
public void deleteGroup(Group group)
```

deleteGroup
```
public void deleteGroup(long id)
```

getMacros
```
public Iterable<Macro> getMacros()
```

getMacro
```
public Macro getMacro(long macroId)
```

createMacro

public Macro createMacro(Macro macro)

updateMacro

public Macro updateMacro(Long macroId,
                         Macro macro)

macrosShowChangesToTicket

public Ticket macrosShowChangesToTicket(long macroId)

macrosShowTicketAfterChanges

public Ticket macrosShowTicketAfterChanges(long ticketId,
                                           long macroId)

addTagToTicket

public List<String> addTagToTicket(long id,
                                   String... tags)

addTagToTopics

public List<String> addTagToTopics(long id,
                                   String... tags)

addTagToOrganisations

public List<String> addTagToOrganisations(long id,
                                          String... tags)

setTagOnTicket

public List<String> setTagOnTicket(long id,
                                   String... tags)

setTagOnTopics

public List<String> setTagOnTopics(long id,
                                   String... tags)

setTagOnOrganisations

public List<String> setTagOnOrganisations(long id,
                                          String... tags)

removeTagFromTicket

public List<String> removeTagFromTicket(long id,
                                        String... tags)

removeTagFromTopics

public List<String> removeTagFromTopics(long id,
                                        String... tags)

removeTagFromOrganisations

public List<String> removeTagFromOrganisations(long id,
                                               String... tags)

getIncrementalTicketsResult

public Map getIncrementalTicketsResult(long unixEpochTime)

getGroupMemberships

public Iterable<GroupMembership> getGroupMemberships()

getGroupMembershipByUser

public List<GroupMembership> getGroupMembershipByUser(long user_id)

getGroupMemberships

public List<GroupMembership> getGroupMemberships(long group_id)

getAssignableGroupMemberships

public Iterable<GroupMembership> getAssignableGroupMemberships()

getAssignableGroupMemberships

public List<GroupMembership> getAssignableGroupMemberships(long group_id)

getGroupMembership

public GroupMembership getGroupMembership(long id)

getGroupMembership

public GroupMembership getGroupMembership(long user_id,
                                          long group_membership_id)

createGroupMembership

public GroupMembership createGroupMembership(GroupMembership groupMembership)

createGroupMembership

public GroupMembership createGroupMembership(long user_id,
                                             GroupMembership groupMembership)

deleteGroupMembership

public void deleteGroupMembership(GroupMembership groupMembership)

deleteGroupMembership

public void deleteGroupMembership(long id)

deleteGroupMembership

public void deleteGroupMembership(long user_id,
                                  GroupMembership groupMembership)

deleteGroupMembership

public void deleteGroupMembership(long user_id,
                                  long group_membership_id)

setGroupMembershipAsDefault

public List<GroupMembership> setGroupMembershipAsDefault(long user_id,
                                                         GroupMembership groupMembership)

getForums
```
public Iterable<Forum> getForums()
```

getForums

public List<Forum> getForums(long category_id)

getForum
```
public Forum getForum(long id)
```

createForum

public Forum createForum(Forum forum)

updateForum

public Forum updateForum(Forum forum)

deleteForum
```
public void deleteForum(Forum forum)
```

getTopics
```
public Iterable<Topic> getTopics()
```

getTopics

public List<Topic> getTopics(long forum_id)

getTopicsByUser

public List<Topic> getTopicsByUser(long user_id)

getTopic
```
public Topic getTopic(long id)
```

createTopic

public Topic createTopic(Topic topic)

importTopic

public Topic importTopic(Topic topic)

getTopics

public List<Topic> getTopics(long id,
                             long... ids)

updateTopic

public Topic updateTopic(Topic topic)

deleteTopic
```
public void deleteTopic(Topic topic)
```

getOrganizationMembershipByUser

public List<OrganizationMembership> getOrganizationMembershipByUser(long user_id)

getGroupOrganization

public OrganizationMembership getGroupOrganization(long user_id,
                                                   long organization_membership_id)

createOrganizationMembership

public OrganizationMembership createOrganizationMembership(long user_id,
                                                           OrganizationMembership organizationMembership)

deleteOrganizationMembership

public void deleteOrganizationMembership(long user_id,
                                         OrganizationMembership organizationMembership)

deleteOrganizationMembership

public void deleteOrganizationMembership(long user_id,
                                         long organization_membership_id)

setOrganizationMembershipAsDefault

public List<OrganizationMembership> setOrganizationMembershipAsDefault(long user_id,
                                                                       OrganizationMembership organizationMembership)

getSearchResults

public Iterable<SearchResultEntity> getSearchResults(String query)

getSearchResults

public <T extends SearchResultEntity> Iterable<T> getSearchResults(Class<T> type,
                                                                   String query)

getSearchResults

@Deprecated
public <T extends SearchResultEntity> Iterable<T> getSearchResults(Class<T> type,
                                                                               String query,
                                                                               String params)

Deprecated. Use getSearchResults(Class, String, Map) instead.

getSearchResults

public <T extends SearchResultEntity> Iterable<T> getSearchResults(Class<T> type,
                                                                   String query,
                                                                   String sortBy,
                                                                   SortOrder sortOrder)

getSearchResults

public <T extends SearchResultEntity> Iterable<T> getSearchResults(Class<T> type,
                                                                   String query,
                                                                   Map<String,Object> params)

notifyApp
```
public void notifyApp(String json)
```

updateInstallation

public void updateInstallation(int id,
                               String json)

getSatisfactionRatings

public Iterable<SatisfactionRating> getSatisfactionRatings()

getSatisfactionRating

public SatisfactionRating getSatisfactionRating(long id)

createSatisfactionRating

public SatisfactionRating createSatisfactionRating(long ticketId,
                                                   SatisfactionRating satisfactionRating)

createSatisfactionRating

public SatisfactionRating createSatisfactionRating(Ticket ticket,
                                                   SatisfactionRating satisfactionRating)

getDynamicContentItems

public Iterable<DynamicContentItem> getDynamicContentItems()

getDynamicContentItem

public DynamicContentItem getDynamicContentItem(long id)

createDynamicContentItem

public DynamicContentItem createDynamicContentItem(DynamicContentItem item)

updateDynamicContentItem

public DynamicContentItem updateDynamicContentItem(DynamicContentItem item)

deleteDynamicContentItem

public void deleteDynamicContentItem(DynamicContentItem item)

getDynamicContentItemVariants

public Iterable<DynamicContentItemVariant> getDynamicContentItemVariants(DynamicContentItem item)

VARIANTS

getDynamicContentItemVariant

public DynamicContentItemVariant getDynamicContentItemVariant(Long itemId,
                                                              long id)

createDynamicContentItemVariant

public DynamicContentItemVariant createDynamicContentItemVariant(Long itemId,
                                                                 DynamicContentItemVariant variant)

updateDynamicContentItemVariant

public DynamicContentItemVariant updateDynamicContentItemVariant(Long itemId,
                                                                 DynamicContentItemVariant variant)

deleteDynamicContentItemVariant

public void deleteDynamicContentItemVariant(Long itemId,
                                            DynamicContentItemVariant variant)

getPermissionGroups
```
public Iterable<PermissionGroup> getPermissionGroups()
```
Get all permission groups

Returns:

List of Permission Groups

getPermissionGroup
```
public PermissionGroup getPermissionGroup(long id)
```
Get permission group by id

Parameters:

id -

createPermissionGroup

public PermissionGroup createPermissionGroup(PermissionGroup permissionGroup)

Create permission group

Parameters:: permissionGroup -

updatePermissionGroup

public PermissionGroup updatePermissionGroup(PermissionGroup permissionGroup)

Update permission group

Parameters:: permissionGroup -

deletePermissionGroup

public void deletePermissionGroup(PermissionGroup permissionGroup)

Delete permission group

Parameters:: permissionGroup -

deletePermissionGroup
```
public void deletePermissionGroup(long id)
```
Delete permission group

Parameters:

id -

getUserSegments
```
public Iterable<UserSegment> getUserSegments()
```
Get user segments

Returns:

List of User Segments

getUserSegments
```
public Iterable<UserSegment> getUserSegments(long id)
```
Returns the list of user segments that a particular user belongs to

Returns:

List of User Segments

getUserSegmentsApplicable
```
public Iterable<UserSegment> getUserSegmentsApplicable()
```
Request only user segments applicable on the account's current Guide plan

Returns:

List of User Segments

getUserSegment
```
public UserSegment getUserSegment(long id)
```
Get user segment by id

Parameters:

id -

getSections
```
public Iterable<Section> getSections(UserSegment userSegment)
```
List Sections using a User Segment

Parameters:

userSegment -

Returns:

List of Sections

getTopics
```
public Iterable<Topic> getTopics(UserSegment userSegment)
```
List Topics using a User Segment

Parameters:

userSegment -

Returns:

List of Topics

createUserSegment

public UserSegment createUserSegment(UserSegment userSegment)

Create User Segment

Parameters:: userSegment -

updateUserSegment

public UserSegment updateUserSegment(UserSegment userSegment)

Update User Segment

Parameters:: userSegment -

deleteUserSegment

public void deleteUserSegment(UserSegment userSegment)

Delete User Segment

Parameters:: userSegment -

deleteUserSegment
```
public void deleteUserSegment(long id)
```
Delete User Segment

Parameters:

id -

getHelpCenterLocales

public List<String> getHelpCenterLocales()

getArticles
```
public Iterable<Article> getArticles()
```
Get all articles from help center.

Returns:

List of Articles.

getArticles

public Iterable<Article> getArticles(String locale)

getArticles

public Iterable<Article> getArticles(Category category)

getArticles

public Iterable<Article> getArticles(Section section)

getArticlesIncrementally

public Iterable<Article> getArticlesIncrementally(Date startTime)

getArticlesFromPage

public List<Article> getArticlesFromPage(int page)

getArticle
```
public Article getArticle(long id)
```

getArticleTranslations

public Iterable<Translation> getArticleTranslations(Long articleId)

createArticle

public Article createArticle(Article article)

createArticle

public Article createArticle(Article article,
                             boolean notifySubscribers)

updateArticle

public Article updateArticle(Article article)

createArticleTranslation

public Translation createArticleTranslation(Long articleId,
                                            Translation translation)

updateArticleTranslation

public Translation updateArticleTranslation(Long articleId,
                                            String locale,
                                            Translation translation)

deleteArticle

public void deleteArticle(Article article)

deleteTranslation

public void deleteTranslation(Translation translation)

Delete translation.

Parameters:: translation -

deleteTranslation
```
public void deleteTranslation(Long translationId)
```
Delete translation.

Parameters:

translationId -

deleteArticleAttachment
```
public void deleteArticleAttachment(ArticleAttachments attachment)
```
Delete attachment from article.

Parameters:

attachment -

deleteArticleAttachment
```
public void deleteArticleAttachment(long id)
```
Delete attachment from article.

Parameters:

id - attachment identifier.

getCategories

public Iterable<Category> getCategories()

getCategory
```
public Category getCategory(long id)
```

getCategoryTranslations

public Iterable<Translation> getCategoryTranslations(Long categoryId)

createCategory

public Category createCategory(Category category)

updateCategory

public Category updateCategory(Category category)

createCategoryTranslation

public Translation createCategoryTranslation(Long categoryId,
                                             Translation translation)

updateCategoryTranslation

public Translation updateCategoryTranslation(Long categoryId,
                                             String locale,
                                             Translation translation)

deleteCategory

public void deleteCategory(Category category)

getSections

public Iterable<Section> getSections()

getSections

public Iterable<Section> getSections(Category category)

getSection
```
public Section getSection(long id)
```

getSectionTranslations

public Iterable<Translation> getSectionTranslations(Long sectionId)

createSection

public Section createSection(Section section)

updateSection

public Section updateSection(Section section)

createSectionTranslation

public Translation createSectionTranslation(Long sectionId,
                                            Translation translation)

updateSectionTranslation

public Translation updateSectionTranslation(Long sectionId,
                                            String locale,
                                            Translation translation)

deleteSection

public void deleteSection(Section section)

getUserSubscriptions

public Iterable<Subscription> getUserSubscriptions(User user)

getUserSubscriptions

public Iterable<Subscription> getUserSubscriptions(Long userId)

getArticleSubscriptions

public Iterable<Subscription> getArticleSubscriptions(Long articleId)

getArticleSubscriptions

public Iterable<Subscription> getArticleSubscriptions(Long articleId,
                                                      String locale)

getSectionSubscriptions

public Iterable<Subscription> getSectionSubscriptions(Long sectionId)

getSectionSubscriptions

public Iterable<Subscription> getSectionSubscriptions(Long sectionId,
                                                      String locale)

getSchedules
```
public Iterable<Schedule> getSchedules()
```
Get a list of the current business hours schedules

Returns:

A List of Schedules

getSchedule

public Schedule getSchedule(Schedule schedule)

getSchedule

public Schedule getSchedule(Long scheduleId)

getHolidaysForSchedule

public Iterable<Holiday> getHolidaysForSchedule(Schedule schedule)

getHolidaysForSchedule

public Iterable<Holiday> getHolidaysForSchedule(Long scheduleId)

handleStatus

protected org.zendesk.client.v2.Zendesk.ZendeskAsyncCompletionHandler<Void> handleStatus()

handle

protected <T> org.zendesk.client.v2.Zendesk.ZendeskAsyncCompletionHandler<T> handle(Class<T> clazz)

handle

protected <T> org.zendesk.client.v2.Zendesk.ZendeskAsyncCompletionHandler<T> handle(Class<T> clazz,
                                                                                    String name,
                                                                                    Class... typeParams)

handleJobStatus

protected org.zendesk.client.v2.Zendesk.ZendeskAsyncCompletionHandler<JobStatus> handleJobStatus()

handleList

protected <T> org.zendesk.client.v2.Zendesk.PagedAsyncCompletionHandler<List<T>> handleList(Class<T> clazz,
                                                                                            String name)

handleIncrementalList

protected <T> org.zendesk.client.v2.Zendesk.PagedAsyncCompletionHandler<List<T>> handleIncrementalList(Class<T> clazz,
                                                                                                       String name)

handleSearchList

protected org.zendesk.client.v2.Zendesk.PagedAsyncCompletionHandler<List<SearchResultEntity>> handleSearchList(String name)

handleTargetList

protected org.zendesk.client.v2.Zendesk.PagedAsyncCompletionHandler<List<Target>> handleTargetList(String name)

handleArticleAttachmentsList

protected org.zendesk.client.v2.Zendesk.PagedAsyncCompletionHandler<List<ArticleAttachments>> handleArticleAttachmentsList(String name)

createMapper

public static com.fasterxml.jackson.databind.ObjectMapper createMapper()

Class Zendesk

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isClosed

close

getJobStatus

getJobStatusAsync

getJobStatuses

getJobStatusesAsync

getBrands

getTicketForm

getTicketForms

createTicketForm

importTicket

importTickets

importTickets

importTicketsAsync

getTicket

getTicketIncidents

getTicketCollaborators

getDeletedTickets

getDeletedTickets

deleteTicket

deleteTicket

permanentlyDeleteTicket

permanentlyDeleteTicket

queueCreateTicketAsync

createTicketAsync

createTicket

createTickets

createTickets

createTicketsAsync

updateTicket

updateTickets

updateTickets

updateTicketsAsync

markTicketAsSpam

markTicketAsSpam

deleteTickets

permanentlyDeleteTickets

getTickets

getTicketsByStatus

getTicketsByExternalId

getTicketsByExternalId

getTicketsFromSearch

getArticleFromSearch

getArticleFromSearch

getArticlesFromAnyLabels

getArticlesFromAllLabels

getAttachmentsFromArticle

getTickets

getRecentTickets

getTicketsIncrementally

getTicketsIncrementally

getOrganizationTickets

getUserRequestedTickets

getComplianceDeletionStatuses

getUserCCDTickets

getUserRelatedInfo

getTicketMetrics

getTicketMetricByTicket

getTicketMetric

getTicketAudits

getTicketAudits

getTicketAudit

getTicketAudit

getTicketAudit

trustTicketAudit

trustTicketAudit

trustTicketAudit

makePrivateTicketAudit

makePrivateTicketAudit

makePrivateTicketAudit

getTicketFields

getTicketField

createTicketField

updateTicketField

deleteTicketField