Skip to content

Commit 4934cda

Browse files
mfriesenmfriesen
committed
update
1 parent b19ab16 commit 4934cda

419 files changed

Lines changed: 510 additions & 440 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ This is the official supported Java library for the FormKiQ API.
66
FormKiQ HTTP API
77

88
- API version: 1.18.1
9-
- Build date: 2025-12-07T17:20:11.660615-06:00[America/Winnipeg]
10-
- Generator version: 7.17.0
9+
- Build date: 2026-03-16T21:45:19.549360-05:00[America/Winnipeg]
10+
- Generator version: 7.20.0
1111

1212
Formkiq API: Document Management Platform API using OAuth(JWT) Authentication
1313

‎api/openapi.yaml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4920,6 +4920,7 @@ paths:
49204920
| OCR | addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false |
49214921
| DATA_CLASSIFICATION | llmPromptEntityName | LLM Prompt Entity Name |
49224922
| METADATA_EXTRACTION | llmPromptEntityName | LLM Prompt Entity Name |
4923+
| CHECKSUM | checksumType | Checksum algorithm to calculate and persist for the document | SHA1 or SHA256 |
49234924
| FULLTEXT | characterMax | Maximum number of characters to add to Fulltext destination | -1 |
49244925
| DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt |
49254926
| DOCUMENTTAGGING | tags | Comma-deliminted list of keywords | author,title,description |
@@ -15020,6 +15021,7 @@ components:
1502015021
engine: chatgpt
1502115022
notificationText: notificationText
1502215023
eventBusName: eventBusName
15024+
checksumType: null
1502315025
width: width
1502415026
llmPromptEntityName: llmPromptEntityName
1502515027
notificationHtml: notificationHtml
@@ -15056,6 +15058,7 @@ components:
1505615058
engine: chatgpt
1505715059
notificationText: notificationText
1505815060
eventBusName: eventBusName
15061+
checksumType: null
1505915062
width: width
1506015063
llmPromptEntityName: llmPromptEntityName
1506115064
notificationHtml: notificationHtml
@@ -15268,6 +15271,7 @@ components:
1526815271
engine: chatgpt
1526915272
notificationText: notificationText
1527015273
eventBusName: eventBusName
15274+
checksumType: null
1527115275
width: width
1527215276
llmPromptEntityName: llmPromptEntityName
1527315277
notificationHtml: notificationHtml
@@ -15304,6 +15308,7 @@ components:
1530415308
engine: chatgpt
1530515309
notificationText: notificationText
1530615310
eventBusName: eventBusName
15311+
checksumType: null
1530715312
width: width
1530815313
llmPromptEntityName: llmPromptEntityName
1530915314
notificationHtml: notificationHtml
@@ -15517,6 +15522,7 @@ components:
1551715522
engine: chatgpt
1551815523
notificationText: notificationText
1551915524
eventBusName: eventBusName
15525+
checksumType: null
1552015526
width: width
1552115527
llmPromptEntityName: llmPromptEntityName
1552215528
notificationHtml: notificationHtml
@@ -15553,6 +15559,7 @@ components:
1555315559
engine: chatgpt
1555415560
notificationText: notificationText
1555515561
eventBusName: eventBusName
15562+
checksumType: null
1555615563
width: width
1555715564
llmPromptEntityName: llmPromptEntityName
1555815565
notificationHtml: notificationHtml
@@ -20854,6 +20861,7 @@ components:
2085420861
- ANTIVIRUS
2085520862
- DOCUMENTTAGGING
2085620863
- FULLTEXT
20864+
- CHECKSUM
2085720865
- NOTIFICATION
2085820866
- OCR
2085920867
- QUEUE
@@ -21467,6 +21475,7 @@ components:
2146721475
engine: chatgpt
2146821476
notificationText: notificationText
2146921477
eventBusName: eventBusName
21478+
checksumType: null
2147021479
width: width
2147121480
llmPromptEntityName: llmPromptEntityName
2147221481
notificationHtml: notificationHtml
@@ -21503,6 +21512,7 @@ components:
2150321512
engine: chatgpt
2150421513
notificationText: notificationText
2150521514
eventBusName: eventBusName
21515+
checksumType: null
2150621516
width: width
2150721517
llmPromptEntityName: llmPromptEntityName
2150821518
notificationHtml: notificationHtml
@@ -21548,6 +21558,7 @@ components:
2154821558
engine: chatgpt
2154921559
notificationText: notificationText
2155021560
eventBusName: eventBusName
21561+
checksumType: null
2155121562
width: width
2155221563
llmPromptEntityName: llmPromptEntityName
2155321564
notificationHtml: notificationHtml
@@ -21626,6 +21637,7 @@ components:
2162621637
engine: chatgpt
2162721638
notificationText: notificationText
2162821639
eventBusName: eventBusName
21640+
checksumType: null
2162921641
width: width
2163021642
llmPromptEntityName: llmPromptEntityName
2163121643
notificationHtml: notificationHtml
@@ -21698,6 +21710,8 @@ components:
2169821710
eventBusName:
2169921711
description: The name or ARN of the event bus to receive the event
2170021712
type: string
21713+
checksumType:
21714+
$ref: "#/components/schemas/ChecksumType"
2170121715
width:
2170221716
description: The width of the image to resize (or 'auto')
2170321717
type: string
@@ -24133,6 +24147,7 @@ components:
2413324147
engine: chatgpt
2413424148
notificationText: notificationText
2413524149
eventBusName: eventBusName
24150+
checksumType: null
2413624151
width: width
2413724152
llmPromptEntityName: llmPromptEntityName
2413824153
notificationHtml: notificationHtml
@@ -24181,6 +24196,7 @@ components:
2418124196
engine: chatgpt
2418224197
notificationText: notificationText
2418324198
eventBusName: eventBusName
24199+
checksumType: null
2418424200
width: width
2418524201
llmPromptEntityName: llmPromptEntityName
2418624202
notificationHtml: notificationHtml
@@ -24254,6 +24270,7 @@ components:
2425424270
engine: chatgpt
2425524271
notificationText: notificationText
2425624272
eventBusName: eventBusName
24273+
checksumType: null
2425724274
width: width
2425824275
llmPromptEntityName: llmPromptEntityName
2425924276
notificationHtml: notificationHtml
@@ -24302,6 +24319,7 @@ components:
2430224319
engine: chatgpt
2430324320
notificationText: notificationText
2430424321
eventBusName: eventBusName
24322+
checksumType: null
2430524323
width: width
2430624324
llmPromptEntityName: llmPromptEntityName
2430724325
notificationHtml: notificationHtml
@@ -24372,6 +24390,7 @@ components:
2437224390
engine: chatgpt
2437324391
notificationText: notificationText
2437424392
eventBusName: eventBusName
24393+
checksumType: null
2437524394
width: width
2437624395
llmPromptEntityName: llmPromptEntityName
2437724396
notificationHtml: notificationHtml

‎build.gradle‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ plugins {
88
}
99

1010
group = 'com.formkiq'
11-
version = '1.18.2-SNAPSHOT'
11+
version = '1.18.2'
1212

1313
sourceCompatibility = JavaVersion.VERSION_11
1414
targetCompatibility = JavaVersion.VERSION_11

‎docs/AddActionParameters.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
|**tags** | **String** | DocumentTagging: Comma-deliminted list of keywords to generate tags for | [optional] |
2727
|**mappingId** | **String** | Id of Mapping | [optional] |
2828
|**eventBusName** | **String** | The name or ARN of the event bus to receive the event | [optional] |
29+
|**checksumType** | **ChecksumType** | | [optional] |
2930
|**width** | **String** | The width of the image to resize (or 'auto') | [optional] |
3031
|**height** | **String** | The height of the image to resize (or 'auto') | [optional] |
3132
|**path** | **String** | The path to use when creating resized document (optional) | [optional] |

‎docs/DocumentActionType.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
* `FULLTEXT` (value: `"FULLTEXT"`)
1313

14+
* `CHECKSUM` (value: `"CHECKSUM"`)
15+
1416
* `NOTIFICATION` (value: `"NOTIFICATION"`)
1517

1618
* `OCR` (value: `"OCR"`)

‎docs/DocumentActionsApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ All URIs are relative to *http://localhost*
1515
1616
Add document action
1717

18-
Add one or more actions to a document; this appends actions and does not replace previous actions Each action type supports a different set of parameters as shown in the table below: ### Action Parameters | ActionType | Parameter | Description | Example | | -------- | ------- | ------- | ------- | | OCR | ocrParseTypes | Ocr Parsing strategy to use | TEXT, FORMS, TABLES, QUERIES (requires 'ocrTextractQueries') | | OCR | ocrTextractQueries | Required for \"QUERIES\", questions to ask Textract | | OCR | ocrEngine | Ocr Engine to use | tesseract or textract | | OCR | ocrOutputType | Convert OCR result to an Output format (textract table only) | true | | OCR | ocrNumberOfPages | Number of pages to OCR (from start) | -1 | | OCR | addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false | | DATA_CLASSIFICATION | llmPromptEntityName | LLM Prompt Entity Name | | METADATA_EXTRACTION | llmPromptEntityName | LLM Prompt Entity Name | | FULLTEXT | characterMax | Maximum number of characters to add to Fulltext destination | -1 | | DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt | | DOCUMENTTAGGING | tags | Comma-deliminted list of keywords | author,title,description | | WEBHOOK | url | Webhook URL | https://yourdomain.com/webhook-endpoint | | NOTIFICATION | notificationType | Type of Notification | email | | NOTIFICATION | notificationToCc | Notification Carbon Copy | email@yourdomain.com | | NOTIFICATION | notificationToBcc | Notification Blind Carbon Copy | email@yourdomain.com | | NOTIFICATION | notificationSubject | Notification Subject | Email Subject | | NOTIFICATION | notificationText | Notification as Text | Email Text | | NOTIFICATION | notificationHtml | Notification as Html | Email HTML Text | | QUEUE | queueId | Id of Queue | | | IDP | mappingId | Id of Mapping | | | EVENTBRIDGE | eventBusName | The name or ARN of the Amazon EventBridge to receive the event. | | | RESIZE | width | The width of the image to resize (or 'auto'). | | | RESIZE | height | The height of the image to resize (or 'auto'). | | | RESIZE | outputType | The output type of the image (optional). | | | RESIZE | path | The path to use when creating resized document (optional). | |
18+
Add one or more actions to a document; this appends actions and does not replace previous actions Each action type supports a different set of parameters as shown in the table below: ### Action Parameters | ActionType | Parameter | Description | Example | | -------- | ------- | ------- | ------- | | OCR | ocrParseTypes | Ocr Parsing strategy to use | TEXT, FORMS, TABLES, QUERIES (requires 'ocrTextractQueries') | | OCR | ocrTextractQueries | Required for \"QUERIES\", questions to ask Textract | | OCR | ocrEngine | Ocr Engine to use | tesseract or textract | | OCR | ocrOutputType | Convert OCR result to an Output format (textract table only) | true | | OCR | ocrNumberOfPages | Number of pages to OCR (from start) | -1 | | OCR | addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false | | DATA_CLASSIFICATION | llmPromptEntityName | LLM Prompt Entity Name | | METADATA_EXTRACTION | llmPromptEntityName | LLM Prompt Entity Name | | CHECKSUM | checksumType | Checksum algorithm to calculate and persist for the document | SHA1 or SHA256 | | FULLTEXT | characterMax | Maximum number of characters to add to Fulltext destination | -1 | | DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt | | DOCUMENTTAGGING | tags | Comma-deliminted list of keywords | author,title,description | | WEBHOOK | url | Webhook URL | https://yourdomain.com/webhook-endpoint | | NOTIFICATION | notificationType | Type of Notification | email | | NOTIFICATION | notificationToCc | Notification Carbon Copy | email@yourdomain.com | | NOTIFICATION | notificationToBcc | Notification Blind Carbon Copy | email@yourdomain.com | | NOTIFICATION | notificationSubject | Notification Subject | Email Subject | | NOTIFICATION | notificationText | Notification as Text | Email Text | | NOTIFICATION | notificationHtml | Notification as Html | Email HTML Text | | QUEUE | queueId | Id of Queue | | | IDP | mappingId | Id of Mapping | | | EVENTBRIDGE | eventBusName | The name or ARN of the Amazon EventBridge to receive the event. | | | RESIZE | width | The width of the image to resize (or 'auto'). | | | RESIZE | height | The height of the image to resize (or 'auto'). | | | RESIZE | outputType | The output type of the image (optional). | | | RESIZE | path | The path to use when creating resized document (optional). | |
1919

2020
### Example
2121
```java

‎src/main/java/com/formkiq/client/api/DocumentActionsApi.java‎

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,10 @@ private okhttp3.Call addDocumentActionsValidateBeforeCall(
193193
* result to an Output format (textract table only) | true | | OCR | ocrNumberOfPages | Number of
194194
* pages to OCR (from start) | -1 | | OCR | addPdfDetectedCharactersAsText | PDF Documents convert
195195
* images to text | true or false | | DATA_CLASSIFICATION | llmPromptEntityName | LLM Prompt
196-
* Entity Name | | METADATA_EXTRACTION | llmPromptEntityName | LLM Prompt Entity Name | | FULLTEXT
197-
* | characterMax | Maximum number of characters to add to Fulltext destination | -1 | |
198-
* DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt | | DOCUMENTTAGGING | tags |
196+
* Entity Name | | METADATA_EXTRACTION | llmPromptEntityName | LLM Prompt Entity Name | | CHECKSUM
197+
* | checksumType | Checksum algorithm to calculate and persist for the document | SHA1 or SHA256
198+
* | | FULLTEXT | characterMax | Maximum number of characters to add to Fulltext destination | -1
199+
* | | DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt | | DOCUMENTTAGGING | tags |
199200
* Comma-deliminted list of keywords | author,title,description | | WEBHOOK | url | Webhook URL |
200201
* https://yourdomain.com/webhook-endpoint | | NOTIFICATION | notificationType | Type of
201202
* Notification | email | | NOTIFICATION | notificationToCc | Notification Carbon Copy |
@@ -258,9 +259,10 @@ public AddDocumentActionsResponse addDocumentActions(@javax.annotation.Nonnull S
258259
* result to an Output format (textract table only) | true | | OCR | ocrNumberOfPages | Number of
259260
* pages to OCR (from start) | -1 | | OCR | addPdfDetectedCharactersAsText | PDF Documents convert
260261
* images to text | true or false | | DATA_CLASSIFICATION | llmPromptEntityName | LLM Prompt
261-
* Entity Name | | METADATA_EXTRACTION | llmPromptEntityName | LLM Prompt Entity Name | | FULLTEXT
262-
* | characterMax | Maximum number of characters to add to Fulltext destination | -1 | |
263-
* DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt | | DOCUMENTTAGGING | tags |
262+
* Entity Name | | METADATA_EXTRACTION | llmPromptEntityName | LLM Prompt Entity Name | | CHECKSUM
263+
* | checksumType | Checksum algorithm to calculate and persist for the document | SHA1 or SHA256
264+
* | | FULLTEXT | characterMax | Maximum number of characters to add to Fulltext destination | -1
265+
* | | DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt | | DOCUMENTTAGGING | tags |
264266
* Comma-deliminted list of keywords | author,title,description | | WEBHOOK | url | Webhook URL |
265267
* https://yourdomain.com/webhook-endpoint | | NOTIFICATION | notificationType | Type of
266268
* Notification | email | | NOTIFICATION | notificationToCc | Notification Carbon Copy |
@@ -325,20 +327,22 @@ public ApiResponse<AddDocumentActionsResponse> addDocumentActionsWithHttpInfo(
325327
* of pages to OCR (from start) | -1 | | OCR | addPdfDetectedCharactersAsText | PDF Documents
326328
* convert images to text | true or false | | DATA_CLASSIFICATION | llmPromptEntityName | LLM
327329
* Prompt Entity Name | | METADATA_EXTRACTION | llmPromptEntityName | LLM Prompt Entity Name | |
328-
* FULLTEXT | characterMax | Maximum number of characters to add to Fulltext destination | -1 | |
329-
* DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt | | DOCUMENTTAGGING | tags |
330-
* Comma-deliminted list of keywords | author,title,description | | WEBHOOK | url | Webhook URL |
331-
* https://yourdomain.com/webhook-endpoint | | NOTIFICATION | notificationType | Type of
332-
* Notification | email | | NOTIFICATION | notificationToCc | Notification Carbon Copy |
333-
* email@yourdomain.com | | NOTIFICATION | notificationToBcc | Notification Blind Carbon Copy |
334-
* email@yourdomain.com | | NOTIFICATION | notificationSubject | Notification Subject | Email
335-
* Subject | | NOTIFICATION | notificationText | Notification as Text | Email Text | |
336-
* NOTIFICATION | notificationHtml | Notification as Html | Email HTML Text | | QUEUE | queueId |
337-
* Id of Queue | | | IDP | mappingId | Id of Mapping | | | EVENTBRIDGE | eventBusName | The name
338-
* or ARN of the Amazon EventBridge to receive the event. | | | RESIZE | width | The width of the
339-
* image to resize (or &#39;auto&#39;). | | | RESIZE | height | The height of the image to resize
340-
* (or &#39;auto&#39;). | | | RESIZE | outputType | The output type of the image (optional). | | |
341-
* RESIZE | path | The path to use when creating resized document (optional). | |
330+
* CHECKSUM | checksumType | Checksum algorithm to calculate and persist for the document | SHA1
331+
* or SHA256 | | FULLTEXT | characterMax | Maximum number of characters to add to Fulltext
332+
* destination | -1 | | DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt | |
333+
* DOCUMENTTAGGING | tags | Comma-deliminted list of keywords | author,title,description | |
334+
* WEBHOOK | url | Webhook URL | https://yourdomain.com/webhook-endpoint | | NOTIFICATION |
335+
* notificationType | Type of Notification | email | | NOTIFICATION | notificationToCc |
336+
* Notification Carbon Copy | email@yourdomain.com | | NOTIFICATION | notificationToBcc |
337+
* Notification Blind Carbon Copy | email@yourdomain.com | | NOTIFICATION | notificationSubject |
338+
* Notification Subject | Email Subject | | NOTIFICATION | notificationText | Notification as Text
339+
* | Email Text | | NOTIFICATION | notificationHtml | Notification as Html | Email HTML Text | |
340+
* QUEUE | queueId | Id of Queue | | | IDP | mappingId | Id of Mapping | | | EVENTBRIDGE |
341+
* eventBusName | The name or ARN of the Amazon EventBridge to receive the event. | | | RESIZE |
342+
* width | The width of the image to resize (or &#39;auto&#39;). | | | RESIZE | height | The
343+
* height of the image to resize (or &#39;auto&#39;). | | | RESIZE | outputType | The output type
344+
* of the image (optional). | | | RESIZE | path | The path to use when creating resized document
345+
* (optional). | |
342346
*
343347
* @param documentId Document Identifier (required)
344348
* @param siteId Site Identifier (optional)

‎src/main/java/com/formkiq/client/invoker/ApiException.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
*/
3232
@SuppressWarnings("serial")
3333
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen",
34-
date = "2026-03-16T14:13:21.118265-05:00[America/Winnipeg]",
34+
date = "2026-03-16T21:45:19.549360-05:00[America/Winnipeg]",
3535
comments = "Generator version: 7.20.0")
3636
public class ApiException extends Exception {
3737
private static final long serialVersionUID = 1L;

‎src/main/java/com/formkiq/client/invoker/Configuration.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import java.util.function.Supplier;
2626

2727
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen",
28-
date = "2026-03-16T14:13:21.118265-05:00[America/Winnipeg]",
28+
date = "2026-03-16T21:45:19.549360-05:00[America/Winnipeg]",
2929
comments = "Generator version: 7.20.0")
3030
public class Configuration {
3131
public static final String VERSION = "1.18.1";

‎src/main/java/com/formkiq/client/invoker/Pair.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
package com.formkiq.client.invoker;
2222

2323
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen",
24-
date = "2026-03-16T14:13:21.118265-05:00[America/Winnipeg]",
24+
date = "2026-03-16T21:45:19.549360-05:00[America/Winnipeg]",
2525
comments = "Generator version: 7.20.0")
2626
public class Pair {
2727
private final String name;

0 commit comments

Comments
 (0)