update

formkiq · Sep 30, 2024 · 3bf8289 · 3bf8289
1 parent 3f77843
commit 3bf8289
Show file tree

Hide file tree

Showing 343 changed files with 458 additions and 406 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -1628,7 +1628,11 @@ paths:
       x-accepts:
       - application/json
     patch:
-      description: "Update a document's details, i.e., metadata"
+      description: |-
+        Update a document's details, i.e., metadata
+
+        NOTE:
+        - provided attributes will overwrite existing matching attribute keys in the document. Attributes not included in the request body will remain unchanged.
       operationId: UpdateDocument
       parameters:
       - description: Site Identifier
@@ -1896,8 +1900,11 @@ paths:
       x-accepts:
       - application/json
     put:
-      description: Set multiple attributes to a document; this endpoint also accepts
-        a different body parameter for setting a single attribute
+      description: |-
+        Set multiple attributes to a document; this endpoint also accepts a different body parameter for setting a single attribute
+
+        Note:
+        - attributes in the request will overwrite existing attributes.
       operationId: SetDocumentAttributes
       parameters:
       - description: Site Identifier
@@ -9671,8 +9678,12 @@ paths:
       - application/json
   /documents/{documentId}/generate:
     post:
-      description: Generates a document based from a template file; ONLY available
-        with FormKiQ Enterprise
+      description: |-
+        Generates a new document using a specified template file and data sources. This operation allows users to merge data from multiple documents into a template to create a new document in the desired output format (e.g., DOCX).
+
+        By Default data source must include a `data` object, which contains key-value pairs that will be merged into the template. The value can be any valid JSON object. { "data":{}}. The data path can be adjusted via the "dataRoot" field.
+
+        ; ONLY available with FormKiQ Enterprise
       operationId: AddDocumentGenerate
       parameters:
       - description: Site Identifier
@@ -11628,7 +11639,6 @@ components:
         stringValues:
         - stringValues
         - stringValues
-        insertedDate: insertedDate
         valueType: BOOLEAN
         booleanValue: true
       properties:
@@ -11647,9 +11657,6 @@ components:
           type: boolean
         valueType:
           $ref: '#/components/schemas/AttributeValueType'
-        insertedDate:
-          description: Inserted Timestamp
-          type: string
     DocumentSearchMeta:
       example:
         path: path
@@ -13422,7 +13429,6 @@ components:
               stringValues:
               - stringValues
               - stringValues
-              insertedDate: insertedDate
               valueType: BOOLEAN
               booleanValue: true
           contentType: contentType
@@ -13476,7 +13482,6 @@ components:
               stringValues:
               - stringValues
               - stringValues
-              insertedDate: insertedDate
               valueType: BOOLEAN
               booleanValue: true
           contentType: contentType
@@ -13820,7 +13825,6 @@ components:
               stringValues:
               - stringValues
               - stringValues
-              insertedDate: insertedDate
               valueType: BOOLEAN
               booleanValue: true
           contentType: contentType
@@ -13874,7 +13878,6 @@ components:
               stringValues:
               - stringValues
               - stringValues
-              insertedDate: insertedDate
               valueType: BOOLEAN
               booleanValue: true
           contentType: contentType
@@ -13943,7 +13946,6 @@ components:
             stringValues:
             - stringValues
             - stringValues
-            insertedDate: insertedDate
             valueType: BOOLEAN
             booleanValue: true
         contentType: contentType
@@ -15365,8 +15367,10 @@ components:
         datasources:
         - name: name
           documentId: documentId
+          dataRoot: data
         - name: name
           documentId: documentId
+          dataRoot: data
         outputType: DOCX
       properties:
         datasources:
@@ -15381,13 +15385,18 @@ components:
       example:
         name: name
         documentId: documentId
+        dataRoot: data
       properties:
         name:
           description: The data source name
           type: string
         documentId:
           description: Document Identifier of the data source document
           type: string
+        dataRoot:
+          default: data
+          description: The default JSON object path for the data object
+          type: string
       required:
       - documentId
       type: object
@@ -16815,6 +16824,7 @@ components:
             - READ
             - WRITE
             - DELETE
+            - GOVERN
             type: string
           type: array
       type: object
@@ -17389,6 +17399,7 @@ components:
             - READ
             - WRITE
             - DELETE
+            - GOVERN
             type: string
           type: array
       type: object
@@ -18850,6 +18861,7 @@ components:
       - DELETE
       - READ
       - WRITE
+      - GOVERN
       type: string
     AddClassificationRequest:
       example:

diff --git a/docs/AddApiKeyRequest.md b/docs/AddApiKeyRequest.md
@@ -19,6 +19,7 @@
 | READ | &quot;READ&quot; |
 | WRITE | &quot;WRITE&quot; |
 | DELETE | &quot;DELETE&quot; |
+| GOVERN | &quot;GOVERN&quot; |
 
 
 
diff --git a/docs/ApiKey.md b/docs/ApiKey.md
@@ -23,6 +23,7 @@
 | READ | &quot;READ&quot; |
 | WRITE | &quot;WRITE&quot; |
 | DELETE | &quot;DELETE&quot; |
+| GOVERN | &quot;GOVERN&quot; |
 
 
 
diff --git a/docs/DocumentAttributesApi.md b/docs/DocumentAttributesApi.md
@@ -515,7 +515,7 @@ No authorization required
 
 Set document&#39;s attributes
 
-Set multiple attributes to a document; this endpoint also accepts a different body parameter for setting a single attribute
+Set multiple attributes to a document; this endpoint also accepts a different body parameter for setting a single attribute  Note: - attributes in the request will overwrite existing attributes.
 
 ### Example
 ```java

diff --git a/docs/DocumentGenerateDataSource.md b/docs/DocumentGenerateDataSource.md
@@ -9,6 +9,7 @@
 |------------ | ------------- | ------------- | -------------|
 |**name** | **String** | The data source name |  [optional] |
 |**documentId** | **String** | Document Identifier of the data source document |  |
+|**dataRoot** | **String** | The default JSON object path for the data object |  [optional] |
 
 
 
diff --git a/docs/DocumentGenerationApi.md b/docs/DocumentGenerationApi.md
@@ -13,7 +13,7 @@ All URIs are relative to *http://localhost*
 
 Add Document Generate
 
-Generates a document based from a template file; ONLY available with FormKiQ Enterprise
+Generates a new document using a specified template file and data sources. This operation allows users to merge data from multiple documents into a template to create a new document in the desired output format (e.g., DOCX).  By Default data source must include a &#x60;data&#x60; object, which contains key-value pairs that will be merged into the template. The value can be any valid JSON object. { \&quot;data\&quot;:{}}. The data path can be adjusted via the \&quot;dataRoot\&quot; field.  ; ONLY available with FormKiQ Enterprise
 
 ### Example
 ```java

diff --git a/docs/DocumentsApi.md b/docs/DocumentsApi.md
@@ -1025,7 +1025,7 @@ No authorization required
 
 Update document
 
-Update a document&#39;s details, i.e., metadata
+Update a document&#39;s details, i.e., metadata  NOTE: - provided attributes will overwrite existing matching attribute keys in the document. Attributes not included in the request body will remain unchanged.
 
 ### Example
 ```java

diff --git a/docs/SearchResultDocumentAttribute.md b/docs/SearchResultDocumentAttribute.md
@@ -11,7 +11,6 @@
 |**numberValues** | **List&lt;BigDecimal&gt;** | Attribute with number values |  [optional] |
 |**booleanValue** | **Boolean** | Attribute with boolean value |  [optional] |
 |**valueType** | **AttributeValueType** |  |  [optional] |
-|**insertedDate** | **String** | Inserted Timestamp |  [optional] |
 
 
 
diff --git a/docs/SiteGroupPermissions.md b/docs/SiteGroupPermissions.md
@@ -13,5 +13,7 @@
 
 * `WRITE` (value: `"WRITE"`)
 
+* `GOVERN` (value: `"GOVERN"`)
+
 
 
diff --git a/src/main/java/com/formkiq/client/api/DocumentAttributesApi.java b/src/main/java/com/formkiq/client/api/DocumentAttributesApi.java
@@ -1662,7 +1662,8 @@ private okhttp3.Call setDocumentAttributesValidateBeforeCall(String documentId,
 
   /**
    * Set document&#39;s attributes Set multiple attributes to a document; this endpoint also accepts
-   * a different body parameter for setting a single attribute
+   * a different body parameter for setting a single attribute Note: - attributes in the request
+   * will overwrite existing attributes.
    * 
    * @param documentId Document Identifier (required)
    * @param setDocumentAttributesRequest (required)
@@ -1697,7 +1698,8 @@ public SetResponse setDocumentAttributes(String documentId,
 
   /**
    * Set document&#39;s attributes Set multiple attributes to a document; this endpoint also accepts
-   * a different body parameter for setting a single attribute
+   * a different body parameter for setting a single attribute Note: - attributes in the request
+   * will overwrite existing attributes.
    * 
    * @param documentId Document Identifier (required)
    * @param setDocumentAttributesRequest (required)
@@ -1733,7 +1735,8 @@ public ApiResponse<SetResponse> setDocumentAttributesWithHttpInfo(String documen
 
   /**
    * Set document&#39;s attributes (asynchronously) Set multiple attributes to a document; this
-   * endpoint also accepts a different body parameter for setting a single attribute
+   * endpoint also accepts a different body parameter for setting a single attribute Note: -
+   * attributes in the request will overwrite existing attributes.
    * 
    * @param documentId Document Identifier (required)
    * @param setDocumentAttributesRequest (required)

diff --git a/src/main/java/com/formkiq/client/api/DocumentGenerationApi.java b/src/main/java/com/formkiq/client/api/DocumentGenerationApi.java
@@ -183,8 +183,12 @@ private okhttp3.Call addDocumentGenerateValidateBeforeCall(String documentId,
   }
 
   /**
-   * Add Document Generate Generates a document based from a template file; ONLY available with
-   * FormKiQ Enterprise
+   * Add Document Generate Generates a new document using a specified template file and data
+   * sources. This operation allows users to merge data from multiple documents into a template to
+   * create a new document in the desired output format (e.g., DOCX). By Default data source must
+   * include a &#x60;data&#x60; object, which contains key-value pairs that will be merged into the
+   * template. The value can be any valid JSON object. { \&quot;data\&quot;:{}}. The data path can
+   * be adjusted via the \&quot;dataRoot\&quot; field. ; ONLY available with FormKiQ Enterprise
    * 
    * @param documentId Document Identifier (required)
    * @param addDocumentGenerateRequest (required)
@@ -222,8 +226,12 @@ public AddDocumentGenerateResponse addDocumentGenerate(String documentId,
   }
 
   /**
-   * Add Document Generate Generates a document based from a template file; ONLY available with
-   * FormKiQ Enterprise
+   * Add Document Generate Generates a new document using a specified template file and data
+   * sources. This operation allows users to merge data from multiple documents into a template to
+   * create a new document in the desired output format (e.g., DOCX). By Default data source must
+   * include a &#x60;data&#x60; object, which contains key-value pairs that will be merged into the
+   * template. The value can be any valid JSON object. { \&quot;data\&quot;:{}}. The data path can
+   * be adjusted via the \&quot;dataRoot\&quot; field. ; ONLY available with FormKiQ Enterprise
    * 
    * @param documentId Document Identifier (required)
    * @param addDocumentGenerateRequest (required)
@@ -262,8 +270,13 @@ public ApiResponse<AddDocumentGenerateResponse> addDocumentGenerateWithHttpInfo(
   }
 
   /**
-   * Add Document Generate (asynchronously) Generates a document based from a template file; ONLY
-   * available with FormKiQ Enterprise
+   * Add Document Generate (asynchronously) Generates a new document using a specified template file
+   * and data sources. This operation allows users to merge data from multiple documents into a
+   * template to create a new document in the desired output format (e.g., DOCX). By Default data
+   * source must include a &#x60;data&#x60; object, which contains key-value pairs that will be
+   * merged into the template. The value can be any valid JSON object. { \&quot;data\&quot;:{}}. The
+   * data path can be adjusted via the \&quot;dataRoot\&quot; field. ; ONLY available with FormKiQ
+   * Enterprise
    * 
    * @param documentId Document Identifier (required)
    * @param addDocumentGenerateRequest (required)

diff --git a/src/main/java/com/formkiq/client/api/DocumentsApi.java b/src/main/java/com/formkiq/client/api/DocumentsApi.java
@@ -3162,7 +3162,9 @@ private okhttp3.Call updateDocumentValidateBeforeCall(String documentId,
   }
 
   /**
-   * Update document Update a document&#39;s details, i.e., metadata
+   * Update document Update a document&#39;s details, i.e., metadata NOTE: - provided attributes
+   * will overwrite existing matching attribute keys in the document. Attributes not included in the
+   * request body will remain unchanged.
    * 
    * @param documentId Document Identifier (required)
    * @param updateDocumentRequest (required)
@@ -3202,7 +3204,9 @@ public AddDocumentResponse updateDocument(String documentId,
   }
 
   /**
-   * Update document Update a document&#39;s details, i.e., metadata
+   * Update document Update a document&#39;s details, i.e., metadata NOTE: - provided attributes
+   * will overwrite existing matching attribute keys in the document. Attributes not included in the
+   * request body will remain unchanged.
    * 
    * @param documentId Document Identifier (required)
    * @param updateDocumentRequest (required)
@@ -3243,7 +3247,9 @@ public ApiResponse<AddDocumentResponse> updateDocumentWithHttpInfo(String docume
   }
 
   /**
-   * Update document (asynchronously) Update a document&#39;s details, i.e., metadata
+   * Update document (asynchronously) Update a document&#39;s details, i.e., metadata NOTE: -
+   * provided attributes will overwrite existing matching attribute keys in the document. Attributes
+   * not included in the request body will remain unchanged.
    * 
    * @param documentId Document Identifier (required)
    * @param updateDocumentRequest (required)

diff --git a/src/main/java/com/formkiq/client/invoker/ApiException.java b/src/main/java/com/formkiq/client/invoker/ApiException.java
@@ -30,7 +30,7 @@
  */
 @SuppressWarnings("serial")
 @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen",
-    date = "2024-09-20T20:52:06.379355-05:00[America/Winnipeg]",
+    date = "2024-09-30T12:37:05.696833-05:00[America/Chicago]",
     comments = "Generator version: 7.8.0")
 public class ApiException extends Exception {
   private static final long serialVersionUID = 1L;

diff --git a/src/main/java/com/formkiq/client/invoker/Configuration.java b/src/main/java/com/formkiq/client/invoker/Configuration.java
@@ -20,7 +20,7 @@
 package com.formkiq.client.invoker;
 
 @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen",
-    date = "2024-09-20T20:52:06.379355-05:00[America/Winnipeg]",
+    date = "2024-09-30T12:37:05.696833-05:00[America/Chicago]",
     comments = "Generator version: 7.8.0")
 public class Configuration {
   public static final String VERSION = "1.16.0";

diff --git a/src/main/java/com/formkiq/client/invoker/Pair.java b/src/main/java/com/formkiq/client/invoker/Pair.java
@@ -20,7 +20,7 @@
 package com.formkiq.client.invoker;
 
 @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen",
-    date = "2024-09-20T20:52:06.379355-05:00[America/Winnipeg]",
+    date = "2024-09-30T12:37:05.696833-05:00[America/Chicago]",
     comments = "Generator version: 7.8.0")
 public class Pair {
   private String name = "";

diff --git a/src/main/java/com/formkiq/client/invoker/ServerConfiguration.java b/src/main/java/com/formkiq/client/invoker/ServerConfiguration.java
@@ -25,7 +25,7 @@
  * Representing a Server configuration.
  */
 @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen",
-    date = "2024-09-20T20:52:06.379355-05:00[America/Winnipeg]",
+    date = "2024-09-30T12:37:05.696833-05:00[America/Chicago]",
     comments = "Generator version: 7.8.0")
 public class ServerConfiguration {
   public String URL;

diff --git a/src/main/java/com/formkiq/client/invoker/ServerVariable.java b/src/main/java/com/formkiq/client/invoker/ServerVariable.java
@@ -25,7 +25,7 @@
  * Representing a Server Variable for server URL template substitution.
  */
 @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen",
-    date = "2024-09-20T20:52:06.379355-05:00[America/Winnipeg]",
+    date = "2024-09-30T12:37:05.696833-05:00[America/Chicago]",
     comments = "Generator version: 7.8.0")
 public class ServerVariable {
   public String description;

diff --git a/src/main/java/com/formkiq/client/invoker/StringUtil.java b/src/main/java/com/formkiq/client/invoker/StringUtil.java
@@ -23,7 +23,7 @@
 import java.util.Iterator;
 
 @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen",
-    date = "2024-09-20T20:52:06.379355-05:00[America/Winnipeg]",
+    date = "2024-09-30T12:37:05.696833-05:00[America/Chicago]",
     comments = "Generator version: 7.8.0")
 public class StringUtil {
   /**

diff --git a/src/main/java/com/formkiq/client/invoker/auth/AWS4Auth.java b/src/main/java/com/formkiq/client/invoker/auth/AWS4Auth.java
@@ -45,7 +45,7 @@
 import okio.Buffer;
 
 @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen",
-    date = "2024-09-20T20:52:06.379355-05:00[America/Winnipeg]",
+    date = "2024-09-30T12:37:05.696833-05:00[America/Chicago]",
     comments = "Generator version: 7.8.0")
 public class AWS4Auth implements Authentication {