Releases: cloudbees-oss/zendesk-java-client
0.18.0
🚀 New features and improvements
📦 Dependency updates
- Bump netty-bom from 4.1.77.Final to 4.1.78.Final (#490) @dependabot
- Bump maven-enforcer-plugin from 3.0.0 to 3.1.0 (#488) @dependabot
0.17.0
Here is a new release with few new end-points and a batch of dependencies updates.
Thanks a lot to all contributors: @codeconsole , @lacinoire
🚀 New features and improvements
- Make Metric/ZendeskComboMinutes serializable (useful for caching) (#458) @codeconsole
- New method getUsersByExternalIds(id,ids) (#486) @aheritier
- New method getOrganizations(id,ids) (#482) @aheritier
- New methods getTicketsCount() (#485) @aheritier
- New method getUsers(id,ids) (#484) @aheritier
- New method getOrganizationRequests(id) (#483) @aheritier
- Triggers management improvements (#466) @aheritier
📦 Dependency updates
- Bump assertj-core from 3.22.0 to 3.23.1 (#479) @dependabot
- Bump jackson-bom from 2.13.2.20220328 to 2.13.3 (#477) @dependabot
- Bump release-drafter/release-drafter from 5.19.0 to 5.20.0 (#476) @dependabot
- Bump netty-bom from 4.1.75.Final to 4.1.77.Final (#474) @dependabot
- Bump github/codeql-action from 1 to 2 (#473) @dependabot
- Bump jacoco-maven-plugin from 0.8.7 to 0.8.8 (#468) @dependabot
- Bump jackson-bom from 2.13.1 to 2.13.2.20220328 (#464) @dependabot
- Bump release-drafter/release-drafter from 5.18.1 to 5.19.0 (#460) @dependabot
- Bump netty-bom from 4.1.74.Final to 4.1.75.Final (#461) @dependabot
- Bump awaitility from 4.1.1 to 4.2.0 (#456) @dependabot
- Bump slf4j-simple from 1.7.35 to 1.7.36 (#448) @dependabot
- Bump slf4j-api from 1.7.35 to 1.7.36 (#446) @dependabot
- Bump netty-bom from 4.1.73.Final to 4.1.74.Final (#447) @dependabot
- Bump actions/checkout from 2 to 3 (#455) @dependabot
- Bump actions/stale from 4.1.0 to 5 (#454) @dependabot
- Bump actions/setup-java from 2.5.0 to 3 (#450) @dependabot
- Bump release-drafter/release-drafter from 5.18.0 to 5.18.1 (#444) @dependabot
- Bump assertj-core from 3.21.0 to 3.22.0 (#428) @dependabot
- Bump Netty from 4.1.60.Final to 4.1.73.Final (#437) @aheritier
- Bump slf4j-simple from 1.7.32 to 1.7.35 (#440) @dependabot
- Bump slf4j-api from 1.7.32 to 1.7.35 (#441) @dependabot
- Bump animal-sniffer-enforcer-rule from 1.20 to 1.21 (#442) @dependabot
- Bump release-drafter/release-drafter from 5.15.0 to 5.18.0 (#443) @dependabot
👻 Maintenance
- Add test for Action.toString (#480) @lacinoire
0.16.0
UPGRADE NOTE
A hack that was transforming all the %2B (+ URL encoded) back into + prior to sending the http requests was removed.
This hack was preventing to write some search queries using +, eg using an email alias like user+alias@gmail.com and was done because of a wrong encoding of space (URL encoded as +) in some places in the code.
If you work around this problem somehow, you want to remove this workaround, now the client will behave as one would expect, ie whatever you pass in search is properly URL encoded: + -> %2B and -> +.
🚀 New features and improvements
- Add update Ticket Form endpoint (#426) @nkharabaruk
- Allow to delete TicketForm (#417) @aheritier
- Add type attribute to Comment model (#415) @besbes
🐛 Bug Fixes
- [bug] fix an issue preventing searching tickets with email aliases (+) (#429) @PierreBtz
- Configure the DefaultAsyncHttpClient to follow redirects (#418) @aheritier
📦 Dependency updates
- Bump jackson-bom from 2.13.0 to 2.13.1 (#424) @dependabot
- Bump extra-enforcer-rules from 1.4 to 1.5.1 (#423) @dependabot
- Bump actions/setup-java from 2.3.1 to 2.5.0 (#425) @dependabot
- Bump actions/stale from 4.0.0 to 4.1.0 (#421) @dependabot
- Bump awaitility from 4.1.0 to 4.1.1 (#414) @dependabot
📝 Documentation updates
- Few docs about ITs (#419) @aheritier
👻 Maintenance
- Increate ITs timeout to 60s (#427) @aheritier
- Configure the polling interval/delay to be less aggressive in ITs (#416) @aheritier
0.15.0
🚀 New features and improvements
- Add end_user_conditions to ticket form (#392) @internetstaff
- Add support for recovering suspended tickets (#384) @yusuke
- feat(searchPagination): add pagination search api for tickets (#394) @naveenreddyalka
🐛 Bug Fixes
- Fix dates format on PermissionGroup object (#396) @bratwurzt
📦 Dependency updates
- Bump maven-enforcer-plugin from 3.0.0-M3 to 3.0.0 (#408) @aheritier
- Bump slf4j-simple from 1.7.30 to 1.7.32 (#406) @dependabot
- Bump slf4j-api from 1.7.30 to 1.7.32 (#404) @dependabot
- Bump jackson-bom from 2.12.2 to 2.13.0 (#397) @dependabot
- Bump assertj-core from 3.19.0 to 3.21.0 (#395) @dependabot
- Bump jacoco-maven-plugin from 0.8.6 to 0.8.7 (#386) @dependabot
- Bump actions/setup-java from 1 to 2.3.1 (#403) @dependabot
- Bump awaitility from 4.0.3 to 4.1.0 (#385) @dependabot
- Bump async-http-client from 2.12.2 to 2.12.3 (#382) @dependabot
- Bump release-drafter/release-drafter from 5.11.0 to 5.15.0 (#402) @dependabot
📝 Documentation updates
- Add GitHub discussions link on README (#410) @aheritier
👻 Maintenance
- Build and release cleanup (#412) @aheritier
- Add the Close Stale issue action (#411) @PierreBtz
- Update dependabot settings (#401) @aheritier
- Split PRs and Masters CI builds (#400) @aheritier
- Do not execute integration tests when not setup (#399) @aheritier
- RealSmokeTest#createOrganization test was failing (#398) @aheritier
0.14.1
🐛 Bug Fixes
- Fixes #368 (#369) @jellevangompel
📦 Dependency updates
- Bump jackson-bom from 2.11.3 to 2.12.2 (#379) @dependabot
- Bump animal-sniffer-enforcer-rule from 1.19 to 1.20 (#378) @dependabot
- Bump junit from 4.13.1 to 4.13.2 (#377) @dependabot
- Bump assertj-core from 3.17.2 to 3.19.0 (#375) @dependabot
- Bump async-http-client from 2.12.1 to 2.12.2 (#373) @dependabot
- Bump junit from 4.13 to 4.13.1 (#363) @dependabot
- Bump jackson-bom from 2.11.2 to 2.11.3 (#362) @dependabot
- Bump jacoco-maven-plugin from 0.8.5 to 0.8.6 (#361) @dependabot
- Bump wiremock from 2.27.1 to 2.27.2 (#360) @dependabot
- Bump assertj-core from 3.17.0 to 3.17.2 (#359) @dependabot
- Bump commons-text from 1.8 to 1.9 (#357) @dependabot
👻 Maintenance
- The build is failing because SonarQube requires Java 11 (#381) @aheritier
0.14.0
We moved the repository from cloudbees github organization to cloudbees-oss
This version is breaking the compatibility of various various "Many" create/update/delete to fix them (the current implementation was broken).
A lot of integration tests were added to validate them and now these "Many" create/update/delete methods should work correctly and we extending them to various objects where they were missing.
💥 Breaking changes
- Fix the existing "Many" create/update/delete methods (#346) @aheritier
JobStatus is not anymore a generic class. Are impacted by this change:
public JobStatus createOrganizations(Organization... organizations)public JobStatus createTickets(List<Ticket> tickets)public JobStatus createTickets(Ticket... tickets)public JobStatus createUsers(List<User> users)public JobStatus createUsers(User... users)public JobStatus getJobStatus(JobStatus status)public JobStatus importTickets(List<TicketImport> ticketImports)public JobStatus importTickets(TicketImport... ticketImports)public JobStatus onCompleted(Response response)public JobStatus permanentlyDeleteTicket(Ticket ticket)public List<JobStatus> getJobStatuses(List<JobStatus> statuses)public ListenableFuture<JobStatus> createOrganizationsAsync(List<Organization> organizations)public ListenableFuture<JobStatus> createTicketsAsync(List<Ticket> tickets)public ListenableFuture<JobStatus> getJobStatusAsync(JobStatus status)public ListenableFuture<JobStatus> importTicketsAsync(List<TicketImport> ticketImports)public ListenableFuture<JobStatus> queueCreateTicketAsync(Ticket ticket)public ListenableFuture<JobStatus> updateTicketsAsync(List<Ticket> tickets)public ListenableFuture<JobStatus> createUsersAsync(List<User> users)public ListenableFuture<List<JobStatus>> getJobStatusesAsync(List<JobStatus> statuses)
You now have to iterate/loop/wait until getJobStatus(aJobStatus).getStatus() == JobStatus.JobStatusEnum.completed to confirm that the mass update was processed.
Various integration tests were added in RealSmokeTest.java to show how to use these APIs.
🚀 New features and improvements
- Add support for merging users (#350) @Helmsdown
public User mergeUsers(long userIdThatWillRemain, long userIdThatWillBeMerged)
- Validate dates management (#348) @aheritier
- Add various "Many" create/update/delete methods (#346) @aheritier
public Iterable<DeletedTicket> getDeletedTickets()public Iterable<DeletedTicket> getDeletedTickets(String sortBy, SortOrder sortOrder)public JobStatus createOrUpdateUsers(List<User> users)public JobStatus createOrUpdateUsers(User... users)public JobStatus createOrganizationMemberships(List<OrganizationMembership> organizationMemberships)public JobStatus createOrganizationMemberships(OrganizationMembership... organizationMemberships)public JobStatus updateOrganizations(List<Organization> organizations)public JobStatus updateOrganizations(Organization... organizations)public JobStatus updateTickets(List<Ticket> tickets)public JobStatus updateTickets(Ticket... tickets)public JobStatus updateUsers(List<User> users)public JobStatus updateUsers(User... users)public ListenableFuture<JobStatus> createOrUpdateUsersAsync(List<User> users)public ListenableFuture<JobStatus> createOrganizationMembershipsAsync(List<OrganizationMembership> organizationMemberships)public ListenableFuture<JobStatus> updateOrganizationsAsync(List<Organization> organizations)public ListenableFuture<JobStatus> updateUsersAsync(List<User> users)public void deleteOrganizationMemberships(long id, long... ids)
🐛 Bug Fixes
- Deprecates
getTicketsIncrementally(Date startTime, Date endTime)(#347) @aheritier
📦 Dependency updates
- Bump jackson-bom from 2.11.0 to 2.11.2 (#351) @dependabot
- Bump animal-sniffer-enforcer-rule from 1.18 to 1.19 (#352) @dependabot
- Bump wiremock from 2.26.3 to 2.27.1 (#353) @dependabot
- Bump assertj-core from 3.16.1 to 3.17.0 (#354) @dependabot
- Bump extra-enforcer-rules from 1.2 to 1.3 (#355) @dependabot
0.13.0
Improvements and new features
- Help Center: new method
Iterable<Article> getArticles(String locale)allows to find articles for a given locale. ( PR #343 - Thanks @randysecrist) - Help Center: new method
Iterable<Article> getArticles(Section section)allows to find articles for a given section. ( Fixes ##254 - PR #323 - Thanks @mvkvl) - Help Center: new methods
void deleteTranslation(Translation translation)andvoid deleteTranslation(Long translationId)to delete translations ( PR #322 - Thanks @maxixcom) - Runtime Dependencies updates
- Bump
jackson-bomfrom 2.10.2 to 2.11.0 ( PR #340 - Thanks @dependabot) - Bump
async-http-clientfrom 2.10.4 to 2.12.1 ( PR #339- Thanks @dependabot)
- Bump
- Build/Test Dependencies updates
- Bump
assertj-corefrom 3.14.0 to 3.16.1 ( PRs #327 #342 - Thanks @dependabot) - Bump
wiremockfrom 2.25.1 to 2.26.3 ( PRs #329 #337- Thanks @dependabot)
- Bump
0.12.0
Improvements and new features
- Help Center: Management Permission Groups ( https://developer.zendesk.com/rest_api/docs/help_center/permission_groups ): A management permission group defines which agents can create, update, archive, and publish articles. It consists of a set of privileges, each of which is mapped to a user segment. Agents receive whichever privileges are associated with the user segments they belong to. ( PR #315 - Thanks @maxixcom)
- Help Center: User Segments ( https://developer.zendesk.com/rest_api/docs/help_center/user_segments ): A user segment defines who can view the content of a section or topic. ( PR #316 - Fixes #292 - Thanks @maxixcom)
- Supplying a
notify_subscribersproperty along POST:/articles.json ( https://developer.zendesk.com/rest_api/docs/help_center/articles#create-article ): Supplying anotify_subscribersproperty with a value of false will prevent subscribers to the article from receiving an article creation email notification. This can be helpful when creating many articles at a time. Specify the property in the root of the JSON object, not in the "article" object. ( PR #314 - Thanks @maxixcom) - Dependencies updates
- Bump
slf4j-apiandslf4j-simplefrom 1.7.29 to 1.7.30 ( PR #317 #318 - Thanks @dependabot) - Bump
jackson-bomfrom 2.10.1 to 2.10.2 ( PR #320 - Thanks @dependabot) - Bump
junitfrom 4.12 to 4.13 ( PR #321 - Thanks @dependabot)
- Bump
0.11.0
Backward incompatible changes
- The class
org.zendesk.client.v2.SortOrderis moved toorg.zendesk.client.v2.model.SortOrder org.zendesk.client.v2.model.Action#valueis an array ofObjectinstead ofString
Improvements and new features
- Allow to configure custom headers ( Issue #252 - PR #258 - Thanks @duemir )
- Fix Action model value type ( Issue #262 - PR #263 - Thanks @Dohbedoh ) /!\ BACKWARD INCOMPATIBLE
- New fields
solved,priority,customFields,typefororg.zendesk.client.v2.model.Request( PR #276 - Thanks @marydcouto ) - Add articles search by labels:
Zendesk#getArticlesFromAnyLabels(List<String> labels),Zendesk#getArticlesFromAllLabels(List<String> labels)( PR #284 - Thanks @dastultz ) - New search with order
Zendesk#getSearchResults(Class<T> type, String query, String sortBy, SortOrder sortOrder)and deprecatesZendesk#getSearchResults(Class<T> type, String query, String params)( PR #284 - Thanks @dastultz ) /!\ BACKWARD INCOMPATIBLE - Minor code cleanup (+remove some deprecated code used from external libs...)
- Test Dependencies updates
- Bump
wiremockfrom2.14.0to2.25.1( PR #313 - Thanks @dependabot) - Bump
assertj-corefrom3.9.0to3.14.0( PR #312 - Thanks @dependabot)
- Bump
- Build updates
- Bump
maven-enforcer-pluginfrom3.0.0-M2to3.0.0-M3( PR #311 - Thanks @dependabot)
- Bump
0.10.0
Improvements and new features
- Support for Dynamic Content ( PR #293 - Thanks @hscabral )
- Add a sorting order for the comment retrieval ( Issue #307 - PR #308 - Thanks @PierreBtz )
- Configure @dependabot ( PR #296 )
- Dependencies updates
** Bumpslf4j-simplefrom1.7.25to1.7.29( PR #300 - Thanks @dependabot )
** Bumpslf4j-apifrom1.7.25to1.7.29( PR #301 - Thanks @dependabot )
** Bumpasync-http-clientfrom2.3.0to2.10.4( PR #304 - Thanks @dependabot )
** Bumpjackson-bomfrom2.9.3to2.10.1( PR #305 - Thanks @dependabot )
** Bumphandy-uri-templatesfrom2.1.6to2.1.8( PR #299 - Thanks @dependabot ) - Build updates
** Bumpcloudbees-oss-parentfrom8to9( PR #298 - Thanks @dependabot )
** Bumpmaven-enforcer-pluginfrom3.0.0-M1to3.0.0-M2( PR #297 - Thanks @dependabot )
** Bumpextra-enforcer-rulesfrom1.0-beta-6to1.2( PR #302 - Thanks @dependabot )
** Bumpanimal-sniffer-enforcer-rulefrom1.14to1.18( PR #303 - Thanks @dependabot ) - Fix tests failures
**org.zendesk.client.v2.RealSmokeTest.getArticleTranslations( PR #309 )
**org.zendesk.client.v2.RealSmokeTest.showUserComplianceDeletionStatusExpectValidCompletionStatus
( PR #310 )