From e3841d23afc192ae293389fb8cca15eb4856ae4e Mon Sep 17 00:00:00 2001
From: JW Wesson <wesson@textkernel.nl>
Date: Thu, 15 Aug 2024 15:18:48 -0500
Subject: [PATCH] add time scale to salary for vacancy parsing

---
 README.md                                     |  6 +++---
 pom.xml                                       |  2 +-
 .../textkernel/tx/models/job/ParsedJob.java   | 11 +---------
 .../textkernel/tx/models/job/PayRange.java    | 20 +++++++++++++++++++
 4 files changed, 25 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 52bac5b07..17c1d5c85 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ The official Java SDK for the Textkernel Tx v10 API for resume/CV and job parsin
 ### Gradle Users
 Add this dependency to your project's build file:
 ```
-implementation "com.textkernel:tx-java:2.3.0"
+implementation "com.textkernel:tx-java:2.3.1"
 ```
 
 ### Maven Users
@@ -22,13 +22,13 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>com.textkernel</groupId>
   <artifactId>tx-java</artifactId>
-  <version>2.3.0</version>
+  <version>2.3.1</version>
 </dependency>
 ```
 
 ### Others
 You'll need to manually install the following JARs:
-- The Textkernel Tx JAR from https://repo1.maven.org/maven2/com/textkernel/tx-java/2.3.0/tx-java-2.3.0.jar
+- The Textkernel Tx JAR from https://repo1.maven.org/maven2/com/textkernel/tx-java/2.3.1/tx-java-2.3.1.jar
 - [Google Gson][gson_url] from https://repo1.maven.org/maven2/com/google/code/gson/gson/2.9.0/gson-2.9.0.jar
 - [Square OkHttp][okhttp_url] from https://repo1.maven.org/maven2/com/squareup/okhttp3/okhttp/4.9.3/okhttp-4.9.3.jar
 
diff --git a/pom.xml b/pom.xml
index 4f2287911..d334ea1ad 100644
--- a/pom.xml
+++ b/pom.xml
@@ -4,7 +4,7 @@
     <groupId>com.textkernel</groupId>
     <artifactId>tx-java</artifactId>
 
-    <version>2.3.0</version>
+    <version>2.3.1</version>
 
     <packaging>jar</packaging>
     <name>Textkernel Tx Java SDK</name>
diff --git a/src/main/java/com/textkernel/tx/models/job/ParsedJob.java b/src/main/java/com/textkernel/tx/models/job/ParsedJob.java
index bce6e1e0a..bd412a95f 100644
--- a/src/main/java/com/textkernel/tx/models/job/ParsedJob.java
+++ b/src/main/java/com/textkernel/tx/models/job/ParsedJob.java
@@ -95,16 +95,7 @@ public class ParsedJob extends ParsedDocument {
     /** Information about the application process.*/
     public ApplicationDetails ApplicationDetails;
 
-    /**
-     * The salary found for the position
-     * If no lexical cues are available from the vacancy, the time scale is guessed based on predefined salary ranges. Here are some rough salary ranges (note: country-specific conditions may apply):
-     * <ul>
-     *  <li>1 or 2 digits salary (9, 12): hourly</li>
-     *  <li>3 or 4 digits salary (3800, 5000): monthly</li>
-     *  <li>5 digit salary (38000, 50000): yearly</li>
-     * </ul>
-     * If a monthly salary is extracted, to get the annual salary it is multiplied by 14 (if country = AT) or 12 (all other countries).
-     */
+    /** The salary found for the position. */
     public PayRange Salary;
 
     /** The minimum number of working hours per week*/
diff --git a/src/main/java/com/textkernel/tx/models/job/PayRange.java b/src/main/java/com/textkernel/tx/models/job/PayRange.java
index 12abdc031..3d644c608 100644
--- a/src/main/java/com/textkernel/tx/models/job/PayRange.java
+++ b/src/main/java/com/textkernel/tx/models/job/PayRange.java
@@ -26,4 +26,24 @@ public class PayRange {
 
     /** Currency code (ISO 4217) applied to the {@link #Minimum} and {@link #Maximum}*/
     public String Currency;
+
+    /**
+     * Time scale applied to the raw values to get the minimum and maximum annual salary. Possible values are:
+     * <ul>
+     * <li>Hourly</li>
+     * <li>Daily</li>
+     * <li>Weekly</li>
+     * <li>Monthly</li>
+     * <li>Annually</li>
+     * </ul>
+     * If no lexical cues are available from the vacancy, the time scale is guessed based on predefined salary ranges.
+     * Here are some rough salary ranges (note that country-specific conditions may apply):
+     * <ul>
+     * <li>1 or 2 digits salary (9, 12): Hourly</li>
+     * <li>3 or 4 digits salary (3800, 5000): Monthly</li>
+     * <li>5 digit salary (38000, 50000): Annually</li>
+     * </ul>
+     * If a monthly salary is extracted, to get the annual salary it is multiplied by 14 (if country = AT) or 12 (all other countries).
+    */
+    public String TimeScale;
 }