V1.15.1 (#41)

* added OCR outputType

Author: mfriesen

.openapi-generator/FILES

@@ -250,6 +250,7 @@ docs/ModelCase.md
 docs/Nigo.md
 docs/NigoStatus.md
 docs/OcrEngine.md
+docs/OcrKeyValues.md
 docs/OcrOutputType.md
 docs/OnlyOfficeConfig.md
 docs/OnlyOfficeConfigDocument.md
@@ -657,6 +658,7 @@ src/main/java/com/formkiq/client/model/ModelCase.java
 src/main/java/com/formkiq/client/model/Nigo.java
 src/main/java/com/formkiq/client/model/NigoStatus.java
 src/main/java/com/formkiq/client/model/OcrEngine.java
+src/main/java/com/formkiq/client/model/OcrKeyValues.java
 src/main/java/com/formkiq/client/model/OcrOutputType.java
 src/main/java/com/formkiq/client/model/OnlyOfficeConfig.java
 src/main/java/com/formkiq/client/model/OnlyOfficeConfigDocument.java
@@ -1022,6 +1024,7 @@ src/test/java/com/formkiq/client/model/ModelCaseTest.java
 src/test/java/com/formkiq/client/model/NigoStatusTest.java
 src/test/java/com/formkiq/client/model/NigoTest.java
 src/test/java/com/formkiq/client/model/OcrEngineTest.java
+src/test/java/com/formkiq/client/model/OcrKeyValuesTest.java
 src/test/java/com/formkiq/client/model/OcrOutputTypeTest.java
 src/test/java/com/formkiq/client/model/OnlyOfficeConfigDocumentTest.java
 src/test/java/com/formkiq/client/model/OnlyOfficeConfigTest.java

api/openapi.yaml

@@ -28,7 +28,7 @@ info:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
   title: FormKiQ API
-  version: 1.15.0
+  version: 1.15.1
   x-logo:
     url: https://docs.formkiq.com/docs/latest/_images/formkiq-logo.png
     backgroundColor: '#FFFFFF'
@@ -3514,7 +3514,19 @@ paths:
         schema:
           type: string
         style: simple
-      - description: "Whether to return a \"contentUrl\", set value to 'true'"
+      - description: Output Format Type
+        explode: true
+        in: query
+        name: outputType
+        required: false
+        schema:
+          enum:
+          - TEXT
+          - KEY_VALUE
+          - CONTENT_URL
+          type: string
+        style: form
+      - description: "Whether to return a \"contentUrl\", set value to 'true' (deprecated)"
         explode: true
         in: query
         name: contentUrl
@@ -3523,7 +3535,7 @@ paths:
           type: string
         style: form
       - description: "Returns raw 'text' of OCR content. e.g. AWS Textract returns\
-          \ JSON, setting parameter to 'true' converts JSON to Text"
+          \ JSON, setting parameter to 'true' converts JSON to Text (deprecated)"
         explode: true
         in: query
         name: text
@@ -9794,6 +9806,19 @@ components:
         - INACTIVE
         type: string
       style: form
+    ocrOutputTypeParam:
+      description: Output Format Type
+      explode: true
+      in: query
+      name: outputType
+      required: false
+      schema:
+        enum:
+        - TEXT
+        - KEY_VALUE
+        - CONTENT_URL
+        type: string
+      style: form
     limitParam:
       description: Limit Results
       explode: true
@@ -9967,7 +9992,7 @@ components:
         type: integer
       style: form
     contentUrlParam:
-      description: "Whether to return a \"contentUrl\", set value to 'true'"
+      description: "Whether to return a \"contentUrl\", set value to 'true' (deprecated)"
       explode: true
       in: query
       name: contentUrl
@@ -9977,7 +10002,7 @@ components:
       style: form
     textParam:
       description: "Returns raw 'text' of OCR content. e.g. AWS Textract returns JSON,\
-        \ setting parameter to 'true' converts JSON to Text"
+        \ setting parameter to 'true' converts JSON to Text (deprecated)"
       explode: true
       in: query
       name: text
@@ -11567,6 +11592,7 @@ components:
         path: path
         tagSchemaId: tagSchemaId
         deepLinkPath: deepLinkPath
+        documentId: documentId
         attributes:
         - numberValues:
           - 6.027456183070403
@@ -11640,6 +11666,9 @@ components:
           value: value
           key: key
       properties:
+        documentId:
+          description: "optional Document Identifier, if skipped one will be assigned"
+          type: string
         tagSchemaId:
           description: Tag Schema Id
           type: string
@@ -11739,6 +11768,7 @@ components:
             - values
             value: value
             key: key
+        documentId: documentId
         attributes:
         - numberValues:
           - 6.027456183070403
@@ -11814,6 +11844,9 @@ components:
           value: value
           key: key
       properties:
+        documentId:
+          description: "optional Document Identifier, if skipped one will be assigned"
+          type: string
         tagSchemaId:
           description: Tag Schema Id
           type: string
@@ -15174,7 +15207,8 @@ components:
       example:
         next: next
         mappings:
-        - name: name
+        - mappingId: mappingId
+          name: name
           description: description
           attributes:
           - labelMatchingType: FUZZY
@@ -15201,7 +15235,8 @@ components:
             labelTexts:
             - labelTexts
             - labelTexts
-        - name: name
+        - mappingId: mappingId
+          name: name
           description: description
           attributes:
           - labelMatchingType: FUZZY
@@ -15240,6 +15275,7 @@ components:
     GetMappingResponse:
       example:
         mapping:
+          mappingId: mappingId
           name: name
           description: description
           attributes:
@@ -15273,6 +15309,7 @@ components:
       type: object
     Mapping:
       example:
+        mappingId: mappingId
         name: name
         description: description
         attributes:
@@ -15301,6 +15338,9 @@ components:
           - labelTexts
           - labelTexts
       properties:
+        mappingId:
+          description: Mapping Identifier
+          type: string
         name:
           description: Name of Mapping
           type: string
@@ -15373,6 +15413,7 @@ components:
       description: Attribute Source Type
       enum:
       - CONTENT
+      - CONTENT_KEY_VALUE
       - METADATA
       type: string
     GetAttributeResponse:
@@ -15779,6 +15820,21 @@ components:
           description: Action metadata
           type: object
       type: object
+    OcrKeyValues:
+      example:
+        values:
+        - values
+        - values
+        key: key
+      properties:
+        key:
+          description: Ocr Key
+          type: string
+        values:
+          items:
+            type: string
+          type: array
+      type: object
     GetDocumentOcrResponse:
       example:
         contentUrls:
@@ -15789,6 +15845,15 @@ components:
         insertedDate: insertedDate
         ocrStatus: ocrStatus
         documentId: documentId
+        keyValues:
+        - values:
+          - values
+          - values
+          key: key
+        - values:
+          - values
+          - values
+          key: key
         contentType: contentType
         isBase64: true
         userId: userId
@@ -15798,6 +15863,11 @@ components:
           items:
             type: string
           type: array
+        keyValues:
+          description: List of ocr key / values
+          items:
+            $ref: '#/components/schemas/OcrKeyValues'
+          type: array
         data:
           description: OCR text result
           type: string
@@ -17004,7 +17074,7 @@ components:
         username: username
       properties:
         username:
-          description: Username of user
+          description: Email address of user
           type: string
       type: object
     User:

build.gradle

@@ -7,7 +7,7 @@ plugins {
 }
 
 group = 'com.formkiq'
-version = '1.15.1'
+version = '1.15.1-SNAPSHOT'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -87,8 +87,8 @@ publishing {
             // password project.githubToken
           }
           // maven central
-          url "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
-          //url "https://oss.sonatype.org/content/repositories/snapshots/"
+          //url "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
+          url "https://oss.sonatype.org/content/repositories/snapshots/"
 
           // github packages
           //url "https://maven.pkg.github.com/formkiq/formkiq-client-sdk-java"

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "com.formkiq",
     name := "client",
-    version := "1.15.0",
+    version := "1.15.1",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/AddDocumentRequest.md

@@ -7,6 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
+|**documentId** | **String** | optional Document Identifier, if skipped one will be assigned |  [optional] |
 |**tagSchemaId** | **String** | Tag Schema Id |  [optional] |
 |**path** | **String** | Path or Name of document |  [optional] |
 |**deepLinkPath** | **String** | Path or Name of deep link |  [optional] |

docs/AddDocumentUploadRequest.md

@@ -7,6 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
+|**documentId** | **String** | optional Document Identifier, if skipped one will be assigned |  [optional] |
 |**tagSchemaId** | **String** | Tag Schema Id |  [optional] |
 |**path** | **String** | Path or Name of document |  [optional] |
 |**contentType** | **String** | Document media type |  [optional] |

docs/AddUser.md

@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**username** | **String** | Username of user |  [optional] |
+|**username** | **String** | Email address of user |  [optional] |
 
 
 

docs/DocumentOcrApi.md

@@ -148,7 +148,7 @@ No authorization required
 
 <a id="getDocumentOcr"></a>
 # **getDocumentOcr**
-> GetDocumentOcrResponse getDocumentOcr(documentId, siteId, contentUrl, text, shareKey)
+> GetDocumentOcrResponse getDocumentOcr(documentId, siteId, outputType, contentUrl, text, shareKey)
 
 Get document ocr content
 
@@ -174,11 +174,12 @@ public class Example {
     DocumentOcrApi apiInstance = new DocumentOcrApi(defaultClient);
     String documentId = "documentId_example"; // String | Document Identifier
     String siteId = "siteId_example"; // String | Site Identifier
-    String contentUrl = "contentUrl_example"; // String | Whether to return a \"contentUrl\", set value to 'true'
-    String text = "text_example"; // String | Returns raw 'text' of OCR content. e.g. AWS Textract returns JSON, setting parameter to 'true' converts JSON to Text
+    String outputType = "TEXT"; // String | Output Format Type
+    String contentUrl = "contentUrl_example"; // String | Whether to return a \"contentUrl\", set value to 'true' (deprecated)
+    String text = "text_example"; // String | Returns raw 'text' of OCR content. e.g. AWS Textract returns JSON, setting parameter to 'true' converts JSON to Text (deprecated)
     String shareKey = "shareKey_example"; // String | Share Identifier
     try {
-      GetDocumentOcrResponse result = apiInstance.getDocumentOcr(documentId, siteId, contentUrl, text, shareKey);
+      GetDocumentOcrResponse result = apiInstance.getDocumentOcr(documentId, siteId, outputType, contentUrl, text, shareKey);
       System.out.println(result);
     } catch (ApiException e) {
       System.err.println("Exception when calling DocumentOcrApi#getDocumentOcr");
@@ -197,8 +198,9 @@ public class Example {
 |------------- | ------------- | ------------- | -------------|
 | **documentId** | **String**| Document Identifier | |
 | **siteId** | **String**| Site Identifier | [optional] |
-| **contentUrl** | **String**| Whether to return a \&quot;contentUrl\&quot;, set value to &#39;true&#39; | [optional] |
-| **text** | **String**| Returns raw &#39;text&#39; of OCR content. e.g. AWS Textract returns JSON, setting parameter to &#39;true&#39; converts JSON to Text | [optional] |
+| **outputType** | **String**| Output Format Type | [optional] [enum: TEXT, KEY_VALUE, CONTENT_URL] |
+| **contentUrl** | **String**| Whether to return a \&quot;contentUrl\&quot;, set value to &#39;true&#39; (deprecated) | [optional] |
+| **text** | **String**| Returns raw &#39;text&#39; of OCR content. e.g. AWS Textract returns JSON, setting parameter to &#39;true&#39; converts JSON to Text (deprecated) | [optional] |
 | **shareKey** | **String**| Share Identifier | [optional] |
 
 ### Return type

docs/GetDocumentOcrResponse.md

@@ -8,6 +8,7 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**contentUrls** | **List<String>** | Presigned S3 Urls for the OCR content |  [optional] |
+|**keyValues** | [**List<OcrKeyValues>**](OcrKeyValues.md) | List of ocr key / values |  [optional] |
 |**data** | **String** | OCR text result |  [optional] |
 |**ocrEngine** | **String** | The OCR technique used |  [optional] |
 |**ocrStatus** | **String** | The status of the OCR request |  [optional] |

docs/Mapping.md

@@ -7,6 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
+|**mappingId** | **String** | Mapping Identifier |  [optional] |
 |**name** | **String** | Name of Mapping |  [optional] |
 |**description** | **String** | Description of Mapping |  [optional] |
 |**attributes** | [**List<MappingAttribute>**](MappingAttribute.md) | List of attributes |  [optional] |