Skip to content

Commit 4e3eada

Browse files
mfriesenmfriesen
committed
update
1 parent 13670a5 commit 4e3eada

853 files changed

Lines changed: 4428 additions & 3383 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.

‎.openapi-generator/VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7.12.0
1+
7.13.0

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Add this dependency to your project's POM:
6363
<dependency>
6464
<groupId>com.formkiq</groupId>
6565
<artifactId>client</artifactId>
66-
<version>1.17.0</version>
66+
<version>1.18.0</version>
6767
<scope>compile</scope>
6868
</dependency>
6969
```
@@ -79,7 +79,7 @@ Add this dependency to your project's build file:
7979
}
8080
8181
dependencies {
82-
implementation "com.formkiq:client:1.17.0"
82+
implementation "com.formkiq:client:1.18.0"
8383
}
8484
```
8585

@@ -93,7 +93,7 @@ mvn clean package
9393

9494
Then manually install the following JARs:
9595

96-
* `target/client-1.17.0.jar`
96+
* `target/client-1.18.0.jar`
9797
* `target/lib/*.jar`
9898

9999
## Getting Started

‎api/openapi.yaml‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ info:
2828
name: Apache 2.0
2929
url: https://www.apache.org/licenses/LICENSE-2.0.html
3030
title: FormKiQ API JWT
31-
version: 1.17.0
31+
version: 1.18.0
3232
x-logo:
3333
url: https://docs.formkiq.com/docs/latest/_images/formkiq-logo.png
3434
backgroundColor: '#FFFFFF'
@@ -4318,6 +4318,10 @@ paths:
43184318
| QUEUE | queueId | Id of Queue | |
43194319
| IDP | mappingId | Id of Mapping | |
43204320
| EVENTBRIDGE | eventBusName | The name or ARN of the Amazon EventBridge to receive the event. | |
4321+
| RESIZE | width | The width of the image to resize (or 'auto'). | |
4322+
| RESIZE | height | The height of the image to resize (or 'auto'). | |
4323+
| RESIZE | outputType | The output type of the image (optional). | |
4324+
| RESIZE | path | The path to use when creating resized document (optional). | |
43214325
operationId: AddDocumentActions
43224326
parameters:
43234327
- description: Site Identifier
@@ -17408,6 +17412,7 @@ components:
1740817412
- PUBLISH
1740917413
- PDFEXPORT
1741017414
- EVENTBRIDGE
17415+
- RESIZE
1741117416
type: string
1741217417
DocumentAction:
1741317418
example:

‎build.sbt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ lazy val root = (project in file(".")).
22
settings(
33
organization := "com.formkiq",
44
name := "client",
5-
version := "1.17.0",
6-
scalaVersion := "2.11.4",
5+
version := "1.18.0",
6+
scalaVersion := "2.11.12",
77
scalacOptions ++= Seq("-feature"),
8-
javacOptions in compile ++= Seq("-Xlint:deprecation"),
9-
publishArtifact in (Compile, packageDoc) := false,
8+
compile / javacOptions ++= Seq("-Xlint:deprecation"),
9+
Compile / packageDoc / publishArtifact := false,
1010
resolvers += Resolver.mavenLocal,
1111
libraryDependencies ++= Seq(
1212
"io.swagger" % "swagger-annotations" % "1.6.5",

‎docs/DocumentActionType.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,7 @@
2727

2828
* `EVENTBRIDGE` (value: `"EVENTBRIDGE"`)
2929

30+
* `RESIZE` (value: `"RESIZE"`)
31+
3032

3133

‎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 | | 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 | | 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. | |
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 | | 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 | | 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 &#39;auto&#39;). | | | RESIZE | height | The height of the image to resize (or &#39;auto&#39;). | | | 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/AccessControlApi.java‎

Lines changed: 42 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
* https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-iam.yaml ##
1212
* Authentication FormKiQ offers three forms of authentication: - OAuth(JWT) - AWS IAM - API Key
1313
*
14-
* The version of the OpenAPI document: 1.17.0 Contact: support@formkiq.com
14+
* The version of the OpenAPI document: 1.18.0 Contact: support@formkiq.com
1515
*
1616
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1717
* https://openapi-generator.tech Do not edit the class manually.
@@ -110,8 +110,8 @@ public void setCustomBaseUrl(String customBaseUrl) {
110110
* </tr>
111111
* </table>
112112
*/
113-
public okhttp3.Call deleteOpaAccessPolicyItemsCall(String siteId, final ApiCallback _callback)
114-
throws ApiException {
113+
public okhttp3.Call deleteOpaAccessPolicyItemsCall(@javax.annotation.Nonnull String siteId,
114+
final ApiCallback _callback) throws ApiException {
115115
String basePath = null;
116116
// Operation Servers
117117
String[] localBasePaths = new String[] {};
@@ -157,8 +157,8 @@ public okhttp3.Call deleteOpaAccessPolicyItemsCall(String siteId, final ApiCallb
157157
}
158158

159159
@SuppressWarnings("rawtypes")
160-
private okhttp3.Call deleteOpaAccessPolicyItemsValidateBeforeCall(String siteId,
161-
final ApiCallback _callback) throws ApiException {
160+
private okhttp3.Call deleteOpaAccessPolicyItemsValidateBeforeCall(
161+
@javax.annotation.Nonnull String siteId, final ApiCallback _callback) throws ApiException {
162162
// verify the required parameter 'siteId' is set
163163
if (siteId == null) {
164164
throw new ApiException(
@@ -194,7 +194,8 @@ private okhttp3.Call deleteOpaAccessPolicyItemsValidateBeforeCall(String siteId,
194194
* </tr>
195195
* </table>
196196
*/
197-
public DeleteResponse deleteOpaAccessPolicyItems(String siteId) throws ApiException {
197+
public DeleteResponse deleteOpaAccessPolicyItems(@javax.annotation.Nonnull String siteId)
198+
throws ApiException {
198199
ApiResponse<DeleteResponse> localVarResp = deleteOpaAccessPolicyItemsWithHttpInfo(siteId);
199200
return localVarResp.getData();
200201
}
@@ -224,8 +225,8 @@ public DeleteResponse deleteOpaAccessPolicyItems(String siteId) throws ApiExcept
224225
* </tr>
225226
* </table>
226227
*/
227-
public ApiResponse<DeleteResponse> deleteOpaAccessPolicyItemsWithHttpInfo(String siteId)
228-
throws ApiException {
228+
public ApiResponse<DeleteResponse> deleteOpaAccessPolicyItemsWithHttpInfo(
229+
@javax.annotation.Nonnull String siteId) throws ApiException {
229230
okhttp3.Call localVarCall = deleteOpaAccessPolicyItemsValidateBeforeCall(siteId, null);
230231
Type localVarReturnType = new TypeToken<DeleteResponse>() {}.getType();
231232
return localVarApiClient.execute(localVarCall, localVarReturnType);
@@ -256,7 +257,7 @@ public ApiResponse<DeleteResponse> deleteOpaAccessPolicyItemsWithHttpInfo(String
256257
* </tr>
257258
* </table>
258259
*/
259-
public okhttp3.Call deleteOpaAccessPolicyItemsAsync(String siteId,
260+
public okhttp3.Call deleteOpaAccessPolicyItemsAsync(@javax.annotation.Nonnull String siteId,
260261
final ApiCallback<DeleteResponse> _callback) throws ApiException {
261262

262263
okhttp3.Call localVarCall = deleteOpaAccessPolicyItemsValidateBeforeCall(siteId, _callback);
@@ -461,8 +462,8 @@ public okhttp3.Call getOpaAccessPoliciesAsync(
461462
* </tr>
462463
* </table>
463464
*/
464-
public okhttp3.Call getOpaAccessPolicyCall(String siteId, final ApiCallback _callback)
465-
throws ApiException {
465+
public okhttp3.Call getOpaAccessPolicyCall(@javax.annotation.Nonnull String siteId,
466+
final ApiCallback _callback) throws ApiException {
466467
String basePath = null;
467468
// Operation Servers
468469
String[] localBasePaths = new String[] {};
@@ -508,7 +509,7 @@ public okhttp3.Call getOpaAccessPolicyCall(String siteId, final ApiCallback _cal
508509
}
509510

510511
@SuppressWarnings("rawtypes")
511-
private okhttp3.Call getOpaAccessPolicyValidateBeforeCall(String siteId,
512+
private okhttp3.Call getOpaAccessPolicyValidateBeforeCall(@javax.annotation.Nonnull String siteId,
512513
final ApiCallback _callback) throws ApiException {
513514
// verify the required parameter 'siteId' is set
514515
if (siteId == null) {
@@ -545,7 +546,8 @@ private okhttp3.Call getOpaAccessPolicyValidateBeforeCall(String siteId,
545546
* </tr>
546547
* </table>
547548
*/
548-
public GetOpaAccessPolicyResponse getOpaAccessPolicy(String siteId) throws ApiException {
549+
public GetOpaAccessPolicyResponse getOpaAccessPolicy(@javax.annotation.Nonnull String siteId)
550+
throws ApiException {
549551
ApiResponse<GetOpaAccessPolicyResponse> localVarResp = getOpaAccessPolicyWithHttpInfo(siteId);
550552
return localVarResp.getData();
551553
}
@@ -575,8 +577,8 @@ public GetOpaAccessPolicyResponse getOpaAccessPolicy(String siteId) throws ApiEx
575577
* </tr>
576578
* </table>
577579
*/
578-
public ApiResponse<GetOpaAccessPolicyResponse> getOpaAccessPolicyWithHttpInfo(String siteId)
579-
throws ApiException {
580+
public ApiResponse<GetOpaAccessPolicyResponse> getOpaAccessPolicyWithHttpInfo(
581+
@javax.annotation.Nonnull String siteId) throws ApiException {
580582
okhttp3.Call localVarCall = getOpaAccessPolicyValidateBeforeCall(siteId, null);
581583
Type localVarReturnType = new TypeToken<GetOpaAccessPolicyResponse>() {}.getType();
582584
return localVarApiClient.execute(localVarCall, localVarReturnType);
@@ -608,7 +610,7 @@ public ApiResponse<GetOpaAccessPolicyResponse> getOpaAccessPolicyWithHttpInfo(St
608610
* </tr>
609611
* </table>
610612
*/
611-
public okhttp3.Call getOpaAccessPolicyAsync(String siteId,
613+
public okhttp3.Call getOpaAccessPolicyAsync(@javax.annotation.Nonnull String siteId,
612614
final ApiCallback<GetOpaAccessPolicyResponse> _callback) throws ApiException {
613615

614616
okhttp3.Call localVarCall = getOpaAccessPolicyValidateBeforeCall(siteId, _callback);
@@ -642,8 +644,8 @@ public okhttp3.Call getOpaAccessPolicyAsync(String siteId,
642644
* </tr>
643645
* </table>
644646
*/
645-
public okhttp3.Call getOpaAccessPolicyItemsCall(String siteId, final ApiCallback _callback)
646-
throws ApiException {
647+
public okhttp3.Call getOpaAccessPolicyItemsCall(@javax.annotation.Nonnull String siteId,
648+
final ApiCallback _callback) throws ApiException {
647649
String basePath = null;
648650
// Operation Servers
649651
String[] localBasePaths = new String[] {};
@@ -689,8 +691,8 @@ public okhttp3.Call getOpaAccessPolicyItemsCall(String siteId, final ApiCallback
689691
}
690692

691693
@SuppressWarnings("rawtypes")
692-
private okhttp3.Call getOpaAccessPolicyItemsValidateBeforeCall(String siteId,
693-
final ApiCallback _callback) throws ApiException {
694+
private okhttp3.Call getOpaAccessPolicyItemsValidateBeforeCall(
695+
@javax.annotation.Nonnull String siteId, final ApiCallback _callback) throws ApiException {
694696
// verify the required parameter 'siteId' is set
695697
if (siteId == null) {
696698
throw new ApiException(
@@ -727,8 +729,8 @@ private okhttp3.Call getOpaAccessPolicyItemsValidateBeforeCall(String siteId,
727729
* </tr>
728730
* </table>
729731
*/
730-
public GetOpaAccessPolicyItemsResponse getOpaAccessPolicyItems(String siteId)
731-
throws ApiException {
732+
public GetOpaAccessPolicyItemsResponse getOpaAccessPolicyItems(
733+
@javax.annotation.Nonnull String siteId) throws ApiException {
732734
ApiResponse<GetOpaAccessPolicyItemsResponse> localVarResp =
733735
getOpaAccessPolicyItemsWithHttpInfo(siteId);
734736
return localVarResp.getData();
@@ -761,7 +763,7 @@ public GetOpaAccessPolicyItemsResponse getOpaAccessPolicyItems(String siteId)
761763
* </table>
762764
*/
763765
public ApiResponse<GetOpaAccessPolicyItemsResponse> getOpaAccessPolicyItemsWithHttpInfo(
764-
String siteId) throws ApiException {
766+
@javax.annotation.Nonnull String siteId) throws ApiException {
765767
okhttp3.Call localVarCall = getOpaAccessPolicyItemsValidateBeforeCall(siteId, null);
766768
Type localVarReturnType = new TypeToken<GetOpaAccessPolicyItemsResponse>() {}.getType();
767769
return localVarApiClient.execute(localVarCall, localVarReturnType);
@@ -793,7 +795,7 @@ public ApiResponse<GetOpaAccessPolicyItemsResponse> getOpaAccessPolicyItemsWithH
793795
* </tr>
794796
* </table>
795797
*/
796-
public okhttp3.Call getOpaAccessPolicyItemsAsync(String siteId,
798+
public okhttp3.Call getOpaAccessPolicyItemsAsync(@javax.annotation.Nonnull String siteId,
797799
final ApiCallback<GetOpaAccessPolicyItemsResponse> _callback) throws ApiException {
798800

799801
okhttp3.Call localVarCall = getOpaAccessPolicyItemsValidateBeforeCall(siteId, _callback);
@@ -833,9 +835,9 @@ public okhttp3.Call getOpaAccessPolicyItemsAsync(String siteId,
833835
* </tr>
834836
* </table>
835837
*/
836-
public okhttp3.Call setOpaAccessPolicyItemsCall(String siteId,
837-
SetOpaAccessPolicyItemsRequest setOpaAccessPolicyItemsRequest, final ApiCallback _callback)
838-
throws ApiException {
838+
public okhttp3.Call setOpaAccessPolicyItemsCall(@javax.annotation.Nonnull String siteId,
839+
@javax.annotation.Nonnull SetOpaAccessPolicyItemsRequest setOpaAccessPolicyItemsRequest,
840+
final ApiCallback _callback) throws ApiException {
839841
String basePath = null;
840842
// Operation Servers
841843
String[] localBasePaths = new String[] {};
@@ -881,9 +883,10 @@ public okhttp3.Call setOpaAccessPolicyItemsCall(String siteId,
881883
}
882884

883885
@SuppressWarnings("rawtypes")
884-
private okhttp3.Call setOpaAccessPolicyItemsValidateBeforeCall(String siteId,
885-
SetOpaAccessPolicyItemsRequest setOpaAccessPolicyItemsRequest, final ApiCallback _callback)
886-
throws ApiException {
886+
private okhttp3.Call setOpaAccessPolicyItemsValidateBeforeCall(
887+
@javax.annotation.Nonnull String siteId,
888+
@javax.annotation.Nonnull SetOpaAccessPolicyItemsRequest setOpaAccessPolicyItemsRequest,
889+
final ApiCallback _callback) throws ApiException {
887890
// verify the required parameter 'siteId' is set
888891
if (siteId == null) {
889892
throw new ApiException(
@@ -932,8 +935,9 @@ private okhttp3.Call setOpaAccessPolicyItemsValidateBeforeCall(String siteId,
932935
* </tr>
933936
* </table>
934937
*/
935-
public SetResponse setOpaAccessPolicyItems(String siteId,
936-
SetOpaAccessPolicyItemsRequest setOpaAccessPolicyItemsRequest) throws ApiException {
938+
public SetResponse setOpaAccessPolicyItems(@javax.annotation.Nonnull String siteId,
939+
@javax.annotation.Nonnull SetOpaAccessPolicyItemsRequest setOpaAccessPolicyItemsRequest)
940+
throws ApiException {
937941
ApiResponse<SetResponse> localVarResp =
938942
setOpaAccessPolicyItemsWithHttpInfo(siteId, setOpaAccessPolicyItemsRequest);
939943
return localVarResp.getData();
@@ -971,8 +975,10 @@ public SetResponse setOpaAccessPolicyItems(String siteId,
971975
* </tr>
972976
* </table>
973977
*/
974-
public ApiResponse<SetResponse> setOpaAccessPolicyItemsWithHttpInfo(String siteId,
975-
SetOpaAccessPolicyItemsRequest setOpaAccessPolicyItemsRequest) throws ApiException {
978+
public ApiResponse<SetResponse> setOpaAccessPolicyItemsWithHttpInfo(
979+
@javax.annotation.Nonnull String siteId,
980+
@javax.annotation.Nonnull SetOpaAccessPolicyItemsRequest setOpaAccessPolicyItemsRequest)
981+
throws ApiException {
976982
okhttp3.Call localVarCall =
977983
setOpaAccessPolicyItemsValidateBeforeCall(siteId, setOpaAccessPolicyItemsRequest, null);
978984
Type localVarReturnType = new TypeToken<SetResponse>() {}.getType();
@@ -1011,8 +1017,8 @@ public ApiResponse<SetResponse> setOpaAccessPolicyItemsWithHttpInfo(String siteI
10111017
* </tr>
10121018
* </table>
10131019
*/
1014-
public okhttp3.Call setOpaAccessPolicyItemsAsync(String siteId,
1015-
SetOpaAccessPolicyItemsRequest setOpaAccessPolicyItemsRequest,
1020+
public okhttp3.Call setOpaAccessPolicyItemsAsync(@javax.annotation.Nonnull String siteId,
1021+
@javax.annotation.Nonnull SetOpaAccessPolicyItemsRequest setOpaAccessPolicyItemsRequest,
10161022
final ApiCallback<SetResponse> _callback) throws ApiException {
10171023

10181024
okhttp3.Call localVarCall = setOpaAccessPolicyItemsValidateBeforeCall(siteId,

0 commit comments

Comments
 (0)