Merge branch 'master' into sircpl/cbp_only

Author: PierreBtz

.github/workflows/ci-master.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           # Disabling shallow clone is recommended for improving relevancy of reporting with SonarCloud
           fetch-depth: 0

.github/workflows/ci-pr.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           # Disabling shallow clone is recommended for improving relevancy of reporting with SonarCloud
           fetch-depth: 0

.github/workflows/codeql-analysis.yml

@@ -39,7 +39,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/release-drafter.yml

@@ -11,6 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # Drafts your next Release notes as Pull Requests are merged into "master"
-      - uses: release-drafter/release-drafter@v5.24.0
+      - uses: release-drafter/release-drafter@v5.25.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -82,7 +82,7 @@ Here is the status of the various API components:
 * [Attachments](https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/) ✓
 * [Automations](https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/) ✓
 * [Job Statuses](https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/) ✓
-* [Locales](https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/)
+* [Locales](https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/) - Partial (List Locales)
 * [Macros](https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/) ✓ *except for restrictions*
 * [Satisfaction Ratings](https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/) ✓
 * [Sharing Agreements](https://developer.zendesk.com/api-reference/ticketing/account-configuration/sharing_agreements/)

pom.xml

@@ -99,14 +99,14 @@
       <dependency>
         <groupId>com.fasterxml.jackson</groupId>
         <artifactId>jackson-bom</artifactId>
-        <version>2.15.2</version>
+        <version>2.15.3</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
       <dependency>
         <groupId>io.netty</groupId>
         <artifactId>netty-bom</artifactId>
-        <version>4.1.95.Final</version>
+        <version>4.1.100.Final</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
@@ -117,7 +117,7 @@
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>
-      <version>2.0.7</version>
+      <version>2.0.9</version>
     </dependency>
     <dependency>
       <groupId>org.asynchttpclient</groupId>
@@ -152,7 +152,7 @@
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-simple</artifactId>
-      <version>2.0.7</version>
+      <version>2.0.9</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -171,7 +171,7 @@
     <dependency>
       <groupId>org.apache.commons</groupId>
       <artifactId>commons-text</artifactId>
-      <version>1.10.0</version>
+      <version>1.11.0</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -187,7 +187,7 @@
       <plugins>
         <plugin>
           <artifactId>maven-enforcer-plugin</artifactId>
-          <version>3.3.0</version>
+          <version>3.4.1</version>
         </plugin>
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
@@ -313,7 +313,7 @@
           <plugin>
             <groupId>org.jacoco</groupId>
             <artifactId>jacoco-maven-plugin</artifactId>
-            <version>0.8.10</version>
+            <version>0.8.11</version>
             <executions>
               <execution>
                 <id>prepare-agent</id>

src/main/java/org/zendesk/client/v2/Zendesk.java

@@ -55,6 +55,7 @@
 import org.zendesk.client.v2.model.GroupMembership;
 import org.zendesk.client.v2.model.Identity;
 import org.zendesk.client.v2.model.JobStatus;
+import org.zendesk.client.v2.model.Locale;
 import org.zendesk.client.v2.model.Macro;
 import org.zendesk.client.v2.model.Metric;
 import org.zendesk.client.v2.model.Organization;
@@ -2638,6 +2639,20 @@ public void deleteDynamicContentItemVariant(Long itemId, DynamicContentItemVaria
             handleStatus()));
   }
 
+  //////////////////////////////////////////////////////////////////////
+  // Action methods for Locales
+  //////////////////////////////////////////////////////////////////////
+
+  /**
+   * https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#list-locales
+   *
+   * @return the translation locales available for the account.
+   * @since FIXME
+   */
+  public Iterable<Locale> getLocales() {
+    return new PagedIterable<>(cnst("/locales.json"), handleList(Locale.class, "locales"));
+  }
+
   // TODO search with query building API
 
   //////////////////////////////////////////////////////////////////////

src/main/java/org/zendesk/client/v2/model/Locale.java

@@ -0,0 +1,95 @@
+package org.zendesk.client.v2.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.io.Serializable;
+import java.util.Date;
+
+/**
+ * See <a
+ * href="https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/">
+ * Locales in Zendesk API </a>
+ *
+ * @since FIXME
+ */
+public class Locale implements Serializable {
+
+  private static final long serialVersionUID = 1L;
+
+  private Date createdAt;
+  private Long id;
+  private String locale;
+  private String name;
+  private Date updatedAt;
+  private String url;
+
+  @JsonProperty("created_at")
+  public Date getCreatedAt() {
+    return createdAt;
+  }
+
+  public void setCreatedAt(Date createdAt) {
+    this.createdAt = createdAt;
+  }
+
+  public Long getId() {
+    return id;
+  }
+
+  public void setId(Long id) {
+    this.id = id;
+  }
+
+  public String getLocale() {
+    return locale;
+  }
+
+  public void setLocale(String locale) {
+    this.locale = locale;
+  }
+
+  public String getName() {
+    return name;
+  }
+
+  public void setName(String name) {
+    this.name = name;
+  }
+
+  @JsonProperty("updated_at")
+  public Date getUpdatedAt() {
+    return updatedAt;
+  }
+
+  public void setUpdatedAt(Date updatedAt) {
+    this.updatedAt = updatedAt;
+  }
+
+  public String getUrl() {
+    return url;
+  }
+
+  public void setUrl(String url) {
+    this.url = url;
+  }
+
+  @Override
+  public String toString() {
+    return "Locale{"
+        + "createdAt="
+        + createdAt
+        + ", id="
+        + id
+        + ", locale='"
+        + locale
+        + '\''
+        + ", name='"
+        + name
+        + '\''
+        + ", updatedAt="
+        + updatedAt
+        + ", url='"
+        + url
+        + '\''
+        + '}';
+  }
+}

src/test/java/org/zendesk/client/v2/RealSmokeTest.java

@@ -72,6 +72,7 @@
 import org.zendesk.client.v2.model.Identity;
 import org.zendesk.client.v2.model.JobResult;
 import org.zendesk.client.v2.model.JobStatus;
+import org.zendesk.client.v2.model.Locale;
 import org.zendesk.client.v2.model.Macro;
 import org.zendesk.client.v2.model.Metric;
 import org.zendesk.client.v2.model.Organization;
@@ -2801,6 +2802,18 @@ public void getViews() throws Exception {
         break;
       }
     }
+
+  @Test
+  public void getLocalesReturnsLocales() throws Exception {
+    createClientWithTokenOrPassword();
+    Iterable<Locale> locales = instance.getLocales();
+    assertThat(locales, notNullValue());
+
+    int numLocales = 0;
+    for (Locale ignored : locales) {
+      ++numLocales;
+    }
+    assertThat(numLocales, greaterThan(0));
   }
 
   // UTILITIES

src/test/java/org/zendesk/client/v2/model/LocaleTest.java

@@ -0,0 +1,31 @@
+package org.zendesk.client.v2.model;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.MatcherAssert.assertThat;
+
+import org.junit.Test;
+import org.zendesk.client.v2.Zendesk;
+
+public class LocaleTest {
+  @Test
+  public void testLocaleDeserialization() throws Exception {
+    String json =
+        "{"
+            + "\"url\": \"https://acme.zendesk.com/api/v2/locales/en-US.json\","
+            + "\"id\": 1,"
+            + "\"locale\": \"en-US\","
+            + "\"name\": \"English\","
+            + "\"created_at\": \"2023-08-13T19:23:16Z\","
+            + "\"updated_at\": \"2023-09-21T19:23:16Z\""
+            + "}";
+
+    Locale locale = Zendesk.createMapper().readValue(json, Locale.class);
+
+    assertThat(locale.getUrl(), is("https://acme.zendesk.com/api/v2/locales/en-US.json"));
+    assertThat(locale.getId(), is(1L));
+    assertThat(locale.getLocale(), is("en-US"));
+    assertThat(locale.getName(), is("English"));
+    assertThat(locale.getCreatedAt().getTime(), is(1691954596000L));
+    assertThat(locale.getUpdatedAt().getTime(), is(1695324196000L));
+  }
+}