#autocommit #release - 3.11.0

CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.11.0] - 2023-11-08
+### Added
+- Add `parent` field to `Annotation`
+
+### Fixed
+- Make `Annotation.rectangles` field non-nullable
+- Make `Annotation.document` field required
+
+### Changed
+- Remove enum constraint from `ordering` on the `getAllDocuments` operation
+
 ## [3.10.0] - 2023-10-24
 ### Added
 - Add display_enum_value config to Collection field config

affinda-api-client/pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.affinda.api</groupId>
     <artifactId>affinda-api-client</artifactId>
-    <version>3.10.0</version>
+    <version>3.11.0</version>
     <packaging>jar</packaging>
     <name>Java Client Library for Affinda Resume Parser API</name>
     <description>This package contains Java Client Library for the Affinda Resume Parser API. For documentation on how

affinda-api-client/src/main/java/com/affinda/api/client/AffindaAPI.java

@@ -31,11 +31,10 @@
 import com.affinda.api.client.models.DocumentFormat;
 import com.affinda.api.client.models.DocumentState;
 import com.affinda.api.client.models.DocumentUpdate;
-import com.affinda.api.client.models.Enum20;
+import com.affinda.api.client.models.Enum19;
 import com.affinda.api.client.models.Extractor;
 import com.affinda.api.client.models.ExtractorCreate;
 import com.affinda.api.client.models.ExtractorUpdate;
-import com.affinda.api.client.models.Get8ItemsItem;
 import com.affinda.api.client.models.IndexRequestBody;
 import com.affinda.api.client.models.Invitation;
 import com.affinda.api.client.models.InvitationCreate;
@@ -1274,7 +1273,7 @@ Mono<Response<PathsDvrcp3V3IndexGetResponses200ContentApplicationJsonSchema>> ge
                 @HostParam("region") Region region,
                 @QueryParam("offset") Integer offset,
                 @QueryParam("limit") Integer limit,
-                @QueryParam("document_type") Enum20 documentType,
+                @QueryParam("document_type") Enum19 documentType,
                 @HeaderParam("Accept") String accept);
 
         @Post("/v3/index")
@@ -2505,7 +2504,8 @@ public List<UsageByCollection> getUsageByCollection(String identifier, String st
      * @param createdDt Filter by created datetime.
      * @param search Partial, case-insensitive match with file name or tag name.
      * @param ordering Sort the result set. A "-" at the beginning denotes DESC sort, e.g. -created_dt. Sort by multiple
-     *     fields is supported.
+     *     fields is supported. Supported values include: 'file_name', 'extractor', 'created_dt', 'validated_dt',
+     *     'archived_dt' and 'parsed__&lt;dataPointSlug&gt;'.
      * @param includeData By default, this endpoint returns only the meta data of the documents. Set this to `true` will
      *     return a summary of the data that was parsed. If you want to retrieve the full set of data for a document,
      *     use the `GET /documents/{identifier}` endpoint.
@@ -2533,7 +2533,7 @@ public List<UsageByCollection> getUsageByCollection(String identifier, String st
                     List<Integer> tags,
                     DateRange createdDt,
                     String search,
-                    List<Get8ItemsItem> ordering,
+                    List<String> ordering,
                     Boolean includeData,
                     List<String> exclude,
                     Boolean inReview,
@@ -2583,7 +2583,8 @@ public List<UsageByCollection> getUsageByCollection(String identifier, String st
      * @param createdDt Filter by created datetime.
      * @param search Partial, case-insensitive match with file name or tag name.
      * @param ordering Sort the result set. A "-" at the beginning denotes DESC sort, e.g. -created_dt. Sort by multiple
-     *     fields is supported.
+     *     fields is supported. Supported values include: 'file_name', 'extractor', 'created_dt', 'validated_dt',
+     *     'archived_dt' and 'parsed__&lt;dataPointSlug&gt;'.
      * @param includeData By default, this endpoint returns only the meta data of the documents. Set this to `true` will
      *     return a summary of the data that was parsed. If you want to retrieve the full set of data for a document,
      *     use the `GET /documents/{identifier}` endpoint.
@@ -2610,7 +2611,7 @@ public Mono<PathsOxm5M7V3DocumentsGetResponses200ContentApplicationJsonSchema> g
             List<Integer> tags,
             DateRange createdDt,
             String search,
-            List<Get8ItemsItem> ordering,
+            List<String> ordering,
             Boolean includeData,
             List<String> exclude,
             Boolean inReview,
@@ -2659,7 +2660,8 @@ public Mono<PathsOxm5M7V3DocumentsGetResponses200ContentApplicationJsonSchema> g
      * @param createdDt Filter by created datetime.
      * @param search Partial, case-insensitive match with file name or tag name.
      * @param ordering Sort the result set. A "-" at the beginning denotes DESC sort, e.g. -created_dt. Sort by multiple
-     *     fields is supported.
+     *     fields is supported. Supported values include: 'file_name', 'extractor', 'created_dt', 'validated_dt',
+     *     'archived_dt' and 'parsed__&lt;dataPointSlug&gt;'.
      * @param includeData By default, this endpoint returns only the meta data of the documents. Set this to `true` will
      *     return a summary of the data that was parsed. If you want to retrieve the full set of data for a document,
      *     use the `GET /documents/{identifier}` endpoint.
@@ -2686,7 +2688,7 @@ public PathsOxm5M7V3DocumentsGetResponses200ContentApplicationJsonSchema getAllD
             List<Integer> tags,
             DateRange createdDt,
             String search,
-            List<Get8ItemsItem> ordering,
+            List<String> ordering,
             Boolean includeData,
             List<String> exclude,
             Boolean inReview,
@@ -6766,7 +6768,7 @@ public JobDescriptionSearchEmbed createJobDescriptionSearchEmbedUrl(
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<Response<PathsDvrcp3V3IndexGetResponses200ContentApplicationJsonSchema>> getAllIndexesWithResponseAsync(
-            Integer offset, Integer limit, Enum20 documentType) {
+            Integer offset, Integer limit, Enum19 documentType) {
         final String accept = "application/json";
         return service.getAllIndexes(this.getRegion(), offset, limit, documentType, accept);
     }
@@ -6785,7 +6787,7 @@ public Mono<Response<PathsDvrcp3V3IndexGetResponses200ContentApplicationJsonSche
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<PathsDvrcp3V3IndexGetResponses200ContentApplicationJsonSchema> getAllIndexesAsync(
-            Integer offset, Integer limit, Enum20 documentType) {
+            Integer offset, Integer limit, Enum19 documentType) {
         return getAllIndexesWithResponseAsync(offset, limit, documentType)
                 .flatMap(
                         (Response<PathsDvrcp3V3IndexGetResponses200ContentApplicationJsonSchema> res) -> {
@@ -6811,7 +6813,7 @@ public Mono<PathsDvrcp3V3IndexGetResponses200ContentApplicationJsonSchema> getAl
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public PathsDvrcp3V3IndexGetResponses200ContentApplicationJsonSchema getAllIndexes(
-            Integer offset, Integer limit, Enum20 documentType) {
+            Integer offset, Integer limit, Enum19 documentType) {
         return getAllIndexesAsync(offset, limit, documentType).block();
     }
 

affinda-api-client/src/main/java/com/affinda/api/client/models/Annotation.java

@@ -34,7 +34,7 @@ public class Annotation {
     /*
      * Unique identifier for the document
      */
-    @JsonProperty(value = "document")
+    @JsonProperty(value = "document", required = true)
     private String document;
 
     /*
@@ -99,6 +99,12 @@ public class Annotation {
     @JsonProperty(value = "contentType", required = true)
     private AnnotationContentType contentType;
 
+    /*
+     * The parent annotation's ID
+     */
+    @JsonProperty(value = "parent")
+    private Integer parent;
+
     /*
      * Dictionary of <any>
      */
@@ -390,6 +396,26 @@ public Annotation setContentType(AnnotationContentType contentType) {
         return this;
     }
 
+    /**
+     * Get the parent property: The parent annotation's ID.
+     *
+     * @return the parent value.
+     */
+    public Integer getParent() {
+        return this.parent;
+    }
+
+    /**
+     * Set the parent property: The parent annotation's ID.
+     *
+     * @param parent the parent value to set.
+     * @return the Annotation object itself.
+     */
+    public Annotation setParent(Integer parent) {
+        this.parent = parent;
+        return this;
+    }
+
     /**
      * Get the additionalProperties property: Dictionary of &lt;any&gt;.
      *

affinda-api-client/src/main/java/com/affinda/api/client/models/Enum19.java

@@ -0,0 +1,30 @@
+package com.affinda.api.client.models;
+
+import com.azure.core.util.ExpandableStringEnum;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import java.util.Collection;
+
+/** Defines values for Enum19. */
+public final class Enum19 extends ExpandableStringEnum<Enum19> {
+    /** Static value resumes for Enum19. */
+    public static final Enum19 RESUMES = fromString("resumes");
+
+    /** Static value job_descriptions for Enum19. */
+    public static final Enum19 JOB_DESCRIPTIONS = fromString("job_descriptions");
+
+    /**
+     * Creates or finds a Enum19 from its string representation.
+     *
+     * @param name a name to look for.
+     * @return the corresponding Enum19.
+     */
+    @JsonCreator
+    public static Enum19 fromString(String name) {
+        return fromString(name, Enum19.class);
+    }
+
+    /** @return known Enum19 values. */
+    public static Collection<Enum19> values() {
+        return values(Enum19.class);
+    }
+}

affinda-api-client/src/main/java/com/affinda/api/client/models/Enum22.java

@@ -0,0 +1,30 @@
+package com.affinda.api.client.models;
+
+import com.azure.core.util.ExpandableStringEnum;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import java.util.Collection;
+
+/** Defines values for Enum22. */
+public final class Enum22 extends ExpandableStringEnum<Enum22> {
+    /** Static value resumes for Enum22. */
+    public static final Enum22 RESUMES = fromString("resumes");
+
+    /** Static value job_descriptions for Enum22. */
+    public static final Enum22 JOB_DESCRIPTIONS = fromString("job_descriptions");
+
+    /**
+     * Creates or finds a Enum22 from its string representation.
+     *
+     * @param name a name to look for.
+     * @return the corresponding Enum22.
+     */
+    @JsonCreator
+    public static Enum22 fromString(String name) {
+        return fromString(name, Enum22.class);
+    }
+
+    /** @return known Enum22 values. */
+    public static Collection<Enum22> values() {
+        return values(Enum22.class);
+    }
+}

affinda-api-client/src/main/java/com/affinda/api/client/models/Paths1TvfqeiV3IndexPostResponses201ContentApplicationJsonSchema.java

@@ -16,7 +16,7 @@ public final class Paths1TvfqeiV3IndexPostResponses201ContentApplicationJsonSche
      * The documentType property.
      */
     @JsonProperty(value = "documentType")
-    private Enum23 documentType;
+    private Enum22 documentType;
 
     /**
      * Get the name property: The name property.
@@ -43,7 +43,7 @@ public Paths1TvfqeiV3IndexPostResponses201ContentApplicationJsonSchema setName(S
      *
      * @return the documentType value.
      */
-    public Enum23 getDocumentType() {
+    public Enum22 getDocumentType() {
         return this.documentType;
     }
 
@@ -53,7 +53,7 @@ public Enum23 getDocumentType() {
      * @param documentType the documentType value to set.
      * @return the Paths1TvfqeiV3IndexPostResponses201ContentApplicationJsonSchema object itself.
      */
-    public Paths1TvfqeiV3IndexPostResponses201ContentApplicationJsonSchema setDocumentType(Enum23 documentType) {
+    public Paths1TvfqeiV3IndexPostResponses201ContentApplicationJsonSchema setDocumentType(Enum22 documentType) {
         this.documentType = documentType;
         return this;
     }

affinda-api-sample/pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.affinda.api</groupId>
     <artifactId>affinda-api-sample</artifactId>
-    <version>3.10.0</version>
+    <version>3.11.0</version>
     <name>Affinda API Sample</name>
     <description>This package contains a sample usage of the Affinda API client</description>
     <url>https://github.com/affinda/affinda-java</url>
@@ -27,9 +27,9 @@
         <dependency>
             <groupId>com.affinda.api</groupId>
             <artifactId>affinda-api-client</artifactId>
-            <version>3.10.0</version>
+            <version>3.11.0</version>
             <scope>system</scope>
-            <systemPath>${basedir}/../affinda-api-client/target/affinda-api-client-3.10.0.jar</systemPath>
+            <systemPath>${basedir}/../affinda-api-client/target/affinda-api-client-3.11.0.jar</systemPath>
         </dependency>
         <dependency>
             <groupId>com.microsoft.rest</groupId>