Skip to content

Commit 2ec52bc

Browse files
committed
update to 1.17.1
1 parent 9e53b51 commit 2ec52bc

859 files changed

Lines changed: 2231 additions & 1212 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/FILES

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ docs/AddDocumentOcrRequest.md
4141
docs/AddDocumentOcrResponse.md
4242
docs/AddDocumentRequest.md
4343
docs/AddDocumentResponse.md
44+
docs/AddDocumentSync.md
45+
docs/AddDocumentSyncRequest.md
4446
docs/AddDocumentTag.md
4547
docs/AddDocumentTagsRequest.md
4648
docs/AddDocumentUploadRequest.md
@@ -514,6 +516,8 @@ src/main/java/com/formkiq/client/model/AddDocumentOcrRequest.java
514516
src/main/java/com/formkiq/client/model/AddDocumentOcrResponse.java
515517
src/main/java/com/formkiq/client/model/AddDocumentRequest.java
516518
src/main/java/com/formkiq/client/model/AddDocumentResponse.java
519+
src/main/java/com/formkiq/client/model/AddDocumentSync.java
520+
src/main/java/com/formkiq/client/model/AddDocumentSyncRequest.java
517521
src/main/java/com/formkiq/client/model/AddDocumentTag.java
518522
src/main/java/com/formkiq/client/model/AddDocumentTagsRequest.java
519523
src/main/java/com/formkiq/client/model/AddDocumentUploadRequest.java
@@ -926,6 +930,8 @@ src/test/java/com/formkiq/client/model/AddDocumentOcrRequestTest.java
926930
src/test/java/com/formkiq/client/model/AddDocumentOcrResponseTest.java
927931
src/test/java/com/formkiq/client/model/AddDocumentRequestTest.java
928932
src/test/java/com/formkiq/client/model/AddDocumentResponseTest.java
933+
src/test/java/com/formkiq/client/model/AddDocumentSyncRequestTest.java
934+
src/test/java/com/formkiq/client/model/AddDocumentSyncTest.java
929935
src/test/java/com/formkiq/client/model/AddDocumentTagTest.java
930936
src/test/java/com/formkiq/client/model/AddDocumentTagsRequestTest.java
931937
src/test/java/com/formkiq/client/model/AddDocumentUploadRequestTest.java

README.md

Lines changed: 6 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.17.1</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.17.1"
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.17.1.jar`
9797
* `target/lib/*.jar`
9898

9999
## Getting Started
@@ -272,6 +272,7 @@ Class | Method | HTTP request | Description
272272
*DocumentWorkflowsApi* | [**setWorkflow**](docs/DocumentWorkflowsApi.md#setWorkflow) | **PUT** /workflows/{workflowId} | Set workflow
273273
*DocumentWorkflowsApi* | [**updateWorkflow**](docs/DocumentWorkflowsApi.md#updateWorkflow) | **PATCH** /workflows/{workflowId} | Update workflow
274274
*DocumentsApi* | [**addDocument**](docs/DocumentsApi.md#addDocument) | **POST** /documents | Add new document
275+
*DocumentsApi* | [**addDocumentSync**](docs/DocumentsApi.md#addDocumentSync) | **POST** /documents/{documentId}/syncs | Add document sync to service
275276
*DocumentsApi* | [**addDocumentUpload**](docs/DocumentsApi.md#addDocumentUpload) | **POST** /documents/upload | Add large document
276277
*DocumentsApi* | [**compressDocuments**](docs/DocumentsApi.md#compressDocuments) | **POST** /documents/compress | Compress multiple documents into a .zip file
277278
*DocumentsApi* | [**deleteDocument**](docs/DocumentsApi.md#deleteDocument) | **DELETE** /documents/{documentId} | Delete document
@@ -407,6 +408,8 @@ Class | Method | HTTP request | Description
407408
- [AddDocumentOcrResponse](docs/AddDocumentOcrResponse.md)
408409
- [AddDocumentRequest](docs/AddDocumentRequest.md)
409410
- [AddDocumentResponse](docs/AddDocumentResponse.md)
411+
- [AddDocumentSync](docs/AddDocumentSync.md)
412+
- [AddDocumentSyncRequest](docs/AddDocumentSyncRequest.md)
410413
- [AddDocumentTag](docs/AddDocumentTag.md)
411414
- [AddDocumentTagsRequest](docs/AddDocumentTagsRequest.md)
412415
- [AddDocumentUploadRequest](docs/AddDocumentUploadRequest.md)

api/openapi.yaml

Lines changed: 96 additions & 2 deletions
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.17.1
3232
x-logo:
3333
url: https://docs.formkiq.com/docs/latest/_images/formkiq-logo.png
3434
backgroundColor: '#FFFFFF'
@@ -1641,6 +1641,31 @@ paths:
16411641
requestBody:
16421642
content:
16431643
application/json:
1644+
examples:
1645+
interfaceResourceItem:
1646+
summary: Interface Resource Item Example
1647+
value:
1648+
resourceItem:
1649+
itemType: INTERFACE
1650+
interfaceKey: mainMenuTitle
1651+
localizedValue: Main Menu
1652+
schemaResourceItem:
1653+
summary: Schema Resource Item Example
1654+
value:
1655+
resourceItem:
1656+
itemType: SCHEMA
1657+
attributeKey: documentCategory
1658+
allowedValue: invoice
1659+
localizedValue: Facture
1660+
classificationResourceItem:
1661+
summary: Classification Resource Item Example
1662+
value:
1663+
resourceItem:
1664+
itemType: CLASSIFICATION
1665+
attributeKey: usageRegistrariat
1666+
allowedValue: ID
1667+
localizedValue: Gestion identitaire
1668+
classificationId: 219a7dd6-5fb2-4556-ad71-0ab4312fe577
16441669
schema:
16451670
$ref: '#/components/schemas/AddLocaleResourceItemRequest'
16461671
required: true
@@ -6355,7 +6380,7 @@ paths:
63556380
x-accepts:
63566381
- application/json
63576382
post:
6358-
description: Adde a document to OpenSearch; available as an Add-On Module
6383+
description: Add a document to OpenSearch; available as an Add-On Module
63596384
operationId: AddDocumentFulltext
63606385
parameters:
63616386
- description: Site Identifier
@@ -6639,6 +6664,56 @@ paths:
66396664
$ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
66406665
x-accepts:
66416666
- application/json
6667+
post:
6668+
description: Add a document to a service
6669+
operationId: AddDocumentSync
6670+
parameters:
6671+
- description: Site Identifier
6672+
explode: true
6673+
in: query
6674+
name: siteId
6675+
required: false
6676+
schema:
6677+
type: string
6678+
style: form
6679+
- description: Document Identifier
6680+
explode: false
6681+
in: path
6682+
name: documentId
6683+
required: true
6684+
schema:
6685+
type: string
6686+
style: simple
6687+
requestBody:
6688+
content:
6689+
application/json:
6690+
schema:
6691+
$ref: '#/components/schemas/AddDocumentSyncRequest'
6692+
required: false
6693+
responses:
6694+
"200":
6695+
content:
6696+
application/json:
6697+
schema:
6698+
$ref: '#/components/schemas/AddResponse'
6699+
description: 200 OK
6700+
headers:
6701+
Access-Control-Allow-Origin:
6702+
$ref: '#/components/headers/AccessControlAllowOrigin'
6703+
Access-Control-Allow-Methods:
6704+
$ref: '#/components/headers/AccessControlAllowMethods'
6705+
Access-Control-Allow-Headers:
6706+
$ref: '#/components/headers/AccessControlAllowHeaders'
6707+
security:
6708+
- ApiAuthorization: []
6709+
summary: Add document sync to service
6710+
tags:
6711+
- Documents
6712+
x-amazon-apigateway-integration:
6713+
$ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
6714+
x-content-type: application/json
6715+
x-accepts:
6716+
- application/json
66426717
/userActivities:
66436718
get:
66446719
description: Retrieve a user's activities
@@ -14008,6 +14083,15 @@ components:
1400814083
$ref: '#/components/schemas/FulltextAttribute'
1400914084
type: object
1401014085
type: object
14086+
AddDocumentSyncRequest:
14087+
example:
14088+
sync:
14089+
service: TYPESENSE
14090+
type: METADATA
14091+
properties:
14092+
sync:
14093+
$ref: '#/components/schemas/AddDocumentSync'
14094+
type: object
1401114095
GetDocumentSyncResponse:
1401214096
example:
1401314097
next: next
@@ -14058,6 +14142,16 @@ components:
1405814142
- SOFT_DELETE
1405914143
- DELETE
1406014144
type: string
14145+
AddDocumentSync:
14146+
example:
14147+
service: TYPESENSE
14148+
type: METADATA
14149+
properties:
14150+
service:
14151+
$ref: '#/components/schemas/DocumentSyncService'
14152+
type:
14153+
$ref: '#/components/schemas/DocumentSyncType'
14154+
type: object
1406114155
DocumentSync:
1406214156
example:
1406314157
insertedDate: insertedDate

build.sbt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
22
settings(
33
organization := "com.formkiq",
44
name := "client",
5-
version := "1.17.0",
5+
version := "1.17.1",
66
scalaVersion := "2.11.4",
77
scalacOptions ++= Seq("-feature"),
88
javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/AddDocumentSync.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
3+
# AddDocumentSync
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**service** | **DocumentSyncService** | | [optional] |
11+
|**type** | **DocumentSyncType** | | [optional] |
12+
13+
14+

docs/AddDocumentSyncRequest.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
3+
# AddDocumentSyncRequest
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**sync** | [**AddDocumentSync**](AddDocumentSync.md) | | [optional] |
11+
12+
13+

docs/AdvancedDocumentSearchApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ All URIs are relative to *http://localhost*
2121
2222
Add document&#39;s full-text
2323

24-
Adde a document to OpenSearch; available as an Add-On Module
24+
Add a document to OpenSearch; available as an Add-On Module
2525

2626
### Example
2727
```java

docs/DocumentsApi.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ All URIs are relative to *http://localhost*
55
| Method | HTTP request | Description |
66
|------------- | ------------- | -------------|
77
| [**addDocument**](DocumentsApi.md#addDocument) | **POST** /documents | Add new document |
8+
| [**addDocumentSync**](DocumentsApi.md#addDocumentSync) | **POST** /documents/{documentId}/syncs | Add document sync to service |
89
| [**addDocumentUpload**](DocumentsApi.md#addDocumentUpload) | **POST** /documents/upload | Add large document |
910
| [**compressDocuments**](DocumentsApi.md#compressDocuments) | **POST** /documents/compress | Compress multiple documents into a .zip file |
1011
| [**deleteDocument**](DocumentsApi.md#deleteDocument) | **DELETE** /documents/{documentId} | Delete document |
@@ -92,6 +93,75 @@ No authorization required
9293
| **201** | 201 CREATED | * Access-Control-Allow-Origin - <br> * Access-Control-Allow-Methods - <br> * Access-Control-Allow-Headers - <br> |
9394
| **400** | 400 OK | - |
9495

96+
<a id="addDocumentSync"></a>
97+
# **addDocumentSync**
98+
> AddResponse addDocumentSync(documentId, siteId, addDocumentSyncRequest)
99+
100+
Add document sync to service
101+
102+
Add a document to a service
103+
104+
### Example
105+
```java
106+
// Import classes:
107+
import com.formkiq.client.invoker.ApiClient;
108+
import com.formkiq.client.invoker.ApiException;
109+
import com.formkiq.client.invoker.Configuration;
110+
import com.formkiq.client.invoker.auth.*;
111+
import com.formkiq.client.invoker.models.*;
112+
import com.formkiq.client.api.DocumentsApi;
113+
114+
public class Example {
115+
public static void main(String[] args) {
116+
ApiClient defaultClient = Configuration.getDefaultApiClient();
117+
defaultClient.setBasePath("http://localhost");
118+
// Configure AWS Signature V4 authorization
119+
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
120+
121+
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
122+
String documentId = "documentId_example"; // String | Document Identifier
123+
String siteId = "siteId_example"; // String | Site Identifier
124+
AddDocumentSyncRequest addDocumentSyncRequest = new AddDocumentSyncRequest(); // AddDocumentSyncRequest |
125+
try {
126+
AddResponse result = apiInstance.addDocumentSync(documentId, siteId, addDocumentSyncRequest);
127+
System.out.println(result);
128+
} catch (ApiException e) {
129+
System.err.println("Exception when calling DocumentsApi#addDocumentSync");
130+
System.err.println("Status code: " + e.getCode());
131+
System.err.println("Reason: " + e.getResponseBody());
132+
System.err.println("Response headers: " + e.getResponseHeaders());
133+
e.printStackTrace();
134+
}
135+
}
136+
}
137+
```
138+
139+
### Parameters
140+
141+
| Name | Type | Description | Notes |
142+
|------------- | ------------- | ------------- | -------------|
143+
| **documentId** | **String**| Document Identifier | |
144+
| **siteId** | **String**| Site Identifier | [optional] |
145+
| **addDocumentSyncRequest** | [**AddDocumentSyncRequest**](AddDocumentSyncRequest.md)| | [optional] |
146+
147+
### Return type
148+
149+
[**AddResponse**](AddResponse.md)
150+
151+
### Authorization
152+
153+
No authorization required
154+
155+
### HTTP request headers
156+
157+
- **Content-Type**: application/json
158+
- **Accept**: application/json
159+
160+
### HTTP response details
161+
| Status code | Description | Response headers |
162+
|-------------|-------------|------------------|
163+
| **200** | 200 OK | * Access-Control-Allow-Origin - <br> * Access-Control-Allow-Methods - <br> * Access-Control-Allow-Headers - <br> |
164+
95165
<a id="addDocumentUpload"></a>
96166
# **addDocumentUpload**
97167
> GetDocumentUrlResponse addDocumentUpload(addDocumentUploadRequest, siteId, contentLength, duration, shareKey)

src/main/java/com/formkiq/client/api/AccessControlApi.java

Lines changed: 1 addition & 1 deletion
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.17.1 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.

src/main/java/com/formkiq/client/api/AdvancedDocumentSearchApi.java

Lines changed: 4 additions & 4 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.17.1 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.
@@ -183,7 +183,7 @@ private okhttp3.Call addDocumentFulltextValidateBeforeCall(String documentId, St
183183
}
184184

185185
/**
186-
* Add document&#39;s full-text Adde a document to OpenSearch; available as an Add-On Module
186+
* Add document&#39;s full-text Add a document to OpenSearch; available as an Add-On Module
187187
*
188188
* @param documentId Document Identifier (required)
189189
* @param siteId Site Identifier (optional)
@@ -217,7 +217,7 @@ public AddDocumentFulltextResponse addDocumentFulltext(String documentId, String
217217
}
218218

219219
/**
220-
* Add document&#39;s full-text Adde a document to OpenSearch; available as an Add-On Module
220+
* Add document&#39;s full-text Add a document to OpenSearch; available as an Add-On Module
221221
*
222222
* @param documentId Document Identifier (required)
223223
* @param siteId Site Identifier (optional)
@@ -252,7 +252,7 @@ public ApiResponse<AddDocumentFulltextResponse> addDocumentFulltextWithHttpInfo(
252252
}
253253

254254
/**
255-
* Add document&#39;s full-text (asynchronously) Adde a document to OpenSearch; available as an
255+
* Add document&#39;s full-text (asynchronously) Add a document to OpenSearch; available as an
256256
* Add-On Module
257257
*
258258
* @param documentId Document Identifier (required)

0 commit comments

Comments
 (0)