update

Author: mfriesen

.gitignore

@@ -1,5 +1,7 @@
 *.class
 
+.DS_Store
+
 # Mobile Tools for Java (J2ME)
 .mtj.tmp/
 

.openapi-generator/FILES

@@ -42,6 +42,9 @@ docs/AddDocumentOcrRequest.md
 docs/AddDocumentOcrResponse.md
 docs/AddDocumentRequest.md
 docs/AddDocumentResponse.md
+docs/AddDocumentSync.md
+docs/AddDocumentSyncRequest.md
+docs/AddDocumentSyncService.md
 docs/AddDocumentTag.md
 docs/AddDocumentTagsRequest.md
 docs/AddDocumentUploadRequest.md
@@ -536,6 +539,9 @@ src/main/java/com/formkiq/client/model/AddDocumentOcrRequest.java
 src/main/java/com/formkiq/client/model/AddDocumentOcrResponse.java
 src/main/java/com/formkiq/client/model/AddDocumentRequest.java
 src/main/java/com/formkiq/client/model/AddDocumentResponse.java
+src/main/java/com/formkiq/client/model/AddDocumentSync.java
+src/main/java/com/formkiq/client/model/AddDocumentSyncRequest.java
+src/main/java/com/formkiq/client/model/AddDocumentSyncService.java
 src/main/java/com/formkiq/client/model/AddDocumentTag.java
 src/main/java/com/formkiq/client/model/AddDocumentTagsRequest.java
 src/main/java/com/formkiq/client/model/AddDocumentUploadRequest.java
@@ -968,6 +974,9 @@ src/test/java/com/formkiq/client/model/AddDocumentOcrRequestTest.java
 src/test/java/com/formkiq/client/model/AddDocumentOcrResponseTest.java
 src/test/java/com/formkiq/client/model/AddDocumentRequestTest.java
 src/test/java/com/formkiq/client/model/AddDocumentResponseTest.java
+src/test/java/com/formkiq/client/model/AddDocumentSyncRequestTest.java
+src/test/java/com/formkiq/client/model/AddDocumentSyncServiceTest.java
+src/test/java/com/formkiq/client/model/AddDocumentSyncTest.java
 src/test/java/com/formkiq/client/model/AddDocumentTagTest.java
 src/test/java/com/formkiq/client/model/AddDocumentTagsRequestTest.java
 src/test/java/com/formkiq/client/model/AddDocumentUploadRequestTest.java

README.md

@@ -4,9 +4,9 @@
 This is the official supported Java library for the FormKiQ API. 
 
 FormKiQ HTTP API
-- API version: 1.17.0
-  - Build date: 2025-03-12T17:17:25.165880-05:00[America/Winnipeg]
-  - Generator version: 7.12.0
+- API version: 1.18.0
+  - Build date: 2025-06-21T14:21:22.314584-05:00[America/Winnipeg]
+  - Generator version: 7.13.0
 
 Formkiq API: Document Management Platform API using OAuth(JWT) Authentication
 
@@ -273,6 +273,7 @@ Class | Method | HTTP request | Description
 *DocumentWorkflowsApi* | [**setWorkflow**](docs/DocumentWorkflowsApi.md#setWorkflow) | **PUT** /workflows/{workflowId} | Set workflow
 *DocumentWorkflowsApi* | [**updateWorkflow**](docs/DocumentWorkflowsApi.md#updateWorkflow) | **PATCH** /workflows/{workflowId} | Update workflow
 *DocumentsApi* | [**addDocument**](docs/DocumentsApi.md#addDocument) | **POST** /documents | Add new document
+*DocumentsApi* | [**addDocumentSync**](docs/DocumentsApi.md#addDocumentSync) | **POST** /documents/{documentId}/syncs | Add document sync to service
 *DocumentsApi* | [**addDocumentUpload**](docs/DocumentsApi.md#addDocumentUpload) | **POST** /documents/upload | Add large document
 *DocumentsApi* | [**compressDocuments**](docs/DocumentsApi.md#compressDocuments) | **POST** /documents/compress | Compress multiple documents into a .zip file
 *DocumentsApi* | [**deleteDocument**](docs/DocumentsApi.md#deleteDocument) | **DELETE** /documents/{documentId} | Delete document
@@ -418,6 +419,9 @@ Class | Method | HTTP request | Description
  - [AddDocumentOcrResponse](docs/AddDocumentOcrResponse.md)
  - [AddDocumentRequest](docs/AddDocumentRequest.md)
  - [AddDocumentResponse](docs/AddDocumentResponse.md)
+ - [AddDocumentSync](docs/AddDocumentSync.md)
+ - [AddDocumentSyncRequest](docs/AddDocumentSyncRequest.md)
+ - [AddDocumentSyncService](docs/AddDocumentSyncService.md)
  - [AddDocumentTag](docs/AddDocumentTag.md)
  - [AddDocumentTagsRequest](docs/AddDocumentTagsRequest.md)
  - [AddDocumentUploadRequest](docs/AddDocumentUploadRequest.md)

api/openapi.yaml

@@ -1645,6 +1645,31 @@ paths:
       requestBody:
         content:
           application/json:
+            examples:
+              interfaceResourceItem:
+                summary: Interface Resource Item Example
+                value:
+                  resourceItem:
+                    itemType: INTERFACE
+                    interfaceKey: mainMenuTitle
+                    localizedValue: Main Menu
+              schemaResourceItem:
+                summary: Schema Resource Item Example
+                value:
+                  resourceItem:
+                    itemType: SCHEMA
+                    attributeKey: documentCategory
+                    allowedValue: invoice
+                    localizedValue: Facture
+              classificationResourceItem:
+                summary: Classification Resource Item Example
+                value:
+                  resourceItem:
+                    itemType: CLASSIFICATION
+                    attributeKey: usageRegistrariat
+                    allowedValue: ID
+                    localizedValue: Gestion identitaire
+                    classificationId: 219a7dd6-5fb2-4556-ad71-0ab4312fe577
             schema:
               $ref: '#/components/schemas/AddLocaleResourceItemRequest'
         required: true
@@ -1862,6 +1887,17 @@ paths:
           - FAILED_RETRY
           type: string
         style: form
+      - description: Fetch documents with an sync status
+        explode: true
+        in: query
+        name: syncStatus
+        required: false
+        schema:
+          enum:
+          - FULLTEXT_METADATA_FAILED
+          - FULLTEXT_CONTENT_FAILED
+          type: string
+        style: form
       - description: Fetch soft deleted documents
         explode: true
         in: query
@@ -2439,15 +2475,6 @@ paths:
         schema:
           type: string
         style: simple
-      - description: Whether to enable WebSocket real-time communication with the
-          request
-        explode: true
-        in: query
-        name: ws
-        required: false
-        schema:
-          type: string
-        style: form
       requestBody:
         content:
           application/json:
@@ -2917,15 +2944,6 @@ paths:
         schema:
           type: string
         style: simple
-      - description: Whether to enable WebSocket real-time communication with the
-          request
-        explode: true
-        in: query
-        name: ws
-        required: false
-        schema:
-          type: string
-        style: form
       requestBody:
         content:
           application/json:
@@ -6419,7 +6437,7 @@ paths:
       x-accepts:
       - application/json
     post:
-      description: Adde a document to OpenSearch; available as an Add-On Module
+      description: Add a document to OpenSearch; available as an Add-On Module
       operationId: AddDocumentFulltext
       parameters:
       - description: Site Identifier
@@ -6703,6 +6721,56 @@ paths:
         $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
       x-accepts:
       - application/json
+    post:
+      description: Add a document to a service
+      operationId: AddDocumentSync
+      parameters:
+      - description: Site Identifier
+        explode: true
+        in: query
+        name: siteId
+        required: false
+        schema:
+          type: string
+        style: form
+      - description: Document Identifier
+        explode: false
+        in: path
+        name: documentId
+        required: true
+        schema:
+          type: string
+        style: simple
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AddDocumentSyncRequest'
+        required: false
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AddResponse'
+          description: 200 OK
+          headers:
+            Access-Control-Allow-Origin:
+              $ref: '#/components/headers/AccessControlAllowOrigin'
+            Access-Control-Allow-Methods:
+              $ref: '#/components/headers/AccessControlAllowMethods'
+            Access-Control-Allow-Headers:
+              $ref: '#/components/headers/AccessControlAllowHeaders'
+      security:
+      - ApiAuthorization: []
+      summary: Add document sync to service
+      tags:
+      - Documents
+      x-amazon-apigateway-integration:
+        $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
+      x-content-type: application/json
+      x-accepts:
+      - application/json
   /userActivities:
     get:
       description: Retrieve a user's activities
@@ -11251,15 +11319,6 @@ components:
       schema:
         type: boolean
       style: form
-    wsParam:
-      description: Whether to enable WebSocket real-time communication with the request
-      explode: true
-      in: query
-      name: ws
-      required: false
-      schema:
-        type: string
-      style: form
     groupParam:
       description: Group Identifier
       explode: true
@@ -14685,6 +14744,15 @@ components:
             $ref: '#/components/schemas/FulltextAttribute'
           type: object
       type: object
+    AddDocumentSyncRequest:
+      example:
+        sync:
+          service: FULLTEXT
+          type: METADATA
+      properties:
+        sync:
+          $ref: '#/components/schemas/AddDocumentSync'
+      type: object
     GetDocumentSyncResponse:
       example:
         next: next
@@ -14713,6 +14781,12 @@ components:
             $ref: '#/components/schemas/DocumentSync'
           type: array
       type: object
+    AddDocumentSyncService:
+      description: Add Document Sync Service
+      enum:
+      - FULLTEXT
+      - EVENTBRIDGE
+      type: string
     DocumentSyncService:
       description: Service of Document Sync
       enum:
@@ -14725,6 +14799,7 @@ components:
       enum:
       - COMPLETE
       - FAILED
+      - FAILED_RETRY
       - PENDING
       type: string
     DocumentSyncType:
@@ -14735,6 +14810,16 @@ components:
       - SOFT_DELETE
       - DELETE
       type: string
+    AddDocumentSync:
+      example:
+        service: FULLTEXT
+        type: METADATA
+      properties:
+        service:
+          $ref: '#/components/schemas/AddDocumentSyncService'
+        type:
+          $ref: '#/components/schemas/DocumentSyncType'
+      type: object
     DocumentSync:
       example:
         insertedDate: insertedDate

docs/AddDocumentSync.md

@@ -0,0 +1,14 @@
+
+
+# AddDocumentSync
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**service** | **AddDocumentSyncService** |  |  [optional] |
+|**type** | **DocumentSyncType** |  |  [optional] |
+
+
+

docs/AddDocumentSyncRequest.md

@@ -0,0 +1,13 @@
+
+
+# AddDocumentSyncRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**sync** | [**AddDocumentSync**](AddDocumentSync.md) |  |  [optional] |
+
+
+

docs/AddDocumentSyncService.md

@@ -0,0 +1,13 @@
+
+
+# AddDocumentSyncService
+
+## Enum
+
+
+* `FULLTEXT` (value: `"FULLTEXT"`)
+
+* `EVENTBRIDGE` (value: `"EVENTBRIDGE"`)
+
+
+

docs/AdvancedDocumentSearchApi.md

@@ -21,7 +21,7 @@ All URIs are relative to *http://localhost*
 
 Add document's full-text
 
-Adde a document to OpenSearch; available as an Add-On Module
+Add a document to OpenSearch; available as an Add-On Module
 
 ### Example
 ```java

docs/DocumentAttributesApi.md

@@ -16,7 +16,7 @@ All URIs are relative to *http://localhost*
 
 <a id="addDocumentAttributes"></a>
 # **addDocumentAttributes**
-> AddResponse addDocumentAttributes(documentId, addDocumentAttributesRequest, siteId, ws)
+> AddResponse addDocumentAttributes(documentId, addDocumentAttributesRequest, siteId)
 
 Add attribute to document
 
@@ -43,9 +43,8 @@ public class Example {
     String documentId = "documentId_example"; // String | Document Identifier
     AddDocumentAttributesRequest addDocumentAttributesRequest = new AddDocumentAttributesRequest(); // AddDocumentAttributesRequest | 
     String siteId = "siteId_example"; // String | Site Identifier
-    String ws = "ws_example"; // String | Whether to enable WebSocket real-time communication with the request
     try {
-      AddResponse result = apiInstance.addDocumentAttributes(documentId, addDocumentAttributesRequest, siteId, ws);
+      AddResponse result = apiInstance.addDocumentAttributes(documentId, addDocumentAttributesRequest, siteId);
       System.out.println(result);
     } catch (ApiException e) {
       System.err.println("Exception when calling DocumentAttributesApi#addDocumentAttributes");
@@ -65,7 +64,6 @@ public class Example {
 | **documentId** | **String**| Document Identifier | |
 | **addDocumentAttributesRequest** | [**AddDocumentAttributesRequest**](AddDocumentAttributesRequest.md)|  | |
 | **siteId** | **String**| Site Identifier | [optional] |
-| **ws** | **String**| Whether to enable WebSocket real-time communication with the request | [optional] |
 
 ### Return type
 

docs/DocumentSyncStatus.md

@@ -9,6 +9,8 @@
 
 * `FAILED` (value: `"FAILED"`)
 
+* `FAILED_RETRY` (value: `"FAILED_RETRY"`)
+
 * `PENDING` (value: `"PENDING"`)