update to formkiq 1.15.1

formkiq · Aug 6, 2024 · a649c98 · a649c98
1 parent 53c1ce3
commit a649c98
Show file tree

Hide file tree

Showing 385 changed files with 626 additions and 492 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -248,6 +248,7 @@ docs/MatchDocumentTag.md
 docs/Nigo.md
 docs/NigoStatus.md
 docs/OcrEngine.md
+docs/OcrKeyValues.md
 docs/OcrOutputType.md
 docs/OnlyOfficeConfig.md
 docs/OnlyOfficeConfigDocument.md
@@ -630,6 +631,7 @@ formkiq_client/models/match_document_tag.py
 formkiq_client/models/nigo.py
 formkiq_client/models/nigo_status.py
 formkiq_client/models/ocr_engine.py
+formkiq_client/models/ocr_key_values.py
 formkiq_client/models/ocr_output_type.py
 formkiq_client/models/only_office_config.py
 formkiq_client/models/only_office_config_document.py
@@ -749,96 +751,5 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
-test/test_add_attribute.py
-test/test_add_attribute_request.py
-test/test_add_attribute_response.py
-test/test_add_classification.py
-test/test_add_classification_request.py
-test/test_add_classification_response.py
-test/test_add_document_attribute.py
-test/test_add_document_attribute_classification.py
-test/test_add_document_attribute_standard.py
-test/test_add_document_attribute_value.py
-test/test_add_document_attributes_request.py
-test/test_add_group.py
-test/test_add_group_request.py
-test/test_add_mapping.py
-test/test_add_mapping_request.py
-test/test_add_mapping_response.py
-test/test_add_nigo_request.py
-test/test_add_nigo_response.py
-test/test_add_response.py
-test/test_add_task_request.py
-test/test_add_task_response.py
-test/test_add_user.py
-test/test_add_user_request.py
-test/test_attribute.py
-test/test_attribute_data_type.py
-test/test_attribute_schema_composite_key.py
-test/test_attribute_schema_optional.py
-test/test_attribute_schema_required.py
-test/test_attribute_type.py
-test/test_attribute_value_type.py
-test/test_attributes_api.py
-test/test_classification.py
-test/test_classification_summary.py
-test/test_delete_response.py
-test/test_document_attribute.py
-test/test_document_attributes_api.py
-test/test_document_fulltext_attribute.py
-test/test_document_fulltext_attribute_eq.py
-test/test_document_search_attribute.py
-test/test_document_search_match_attribute.py
-test/test_document_sync_service.py
-test/test_document_sync_status.py
-test/test_document_sync_type.py
-test/test_fulltext_attribute.py
-test/test_get_attribute_response.py
-test/test_get_attributes_response.py
-test/test_get_classification_response.py
-test/test_get_classifications_response.py
-test/test_get_document_attribute_response.py
-test/test_get_document_attribute_versions_response.py
-test/test_get_document_attributes_response.py
-test/test_get_group_response.py
-test/test_get_mapping_response.py
-test/test_get_mappings_response.py
-test/test_get_opa_access_policies_response.py
-test/test_get_opa_access_policy_items_response.py
-test/test_get_opa_access_policy_response.py
-test/test_get_sites_schema_response.py
-test/test_get_user_groups_response.py
-test/test_get_user_response.py
-test/test_get_users_response.py
-test/test_mapping.py
-test/test_mapping_attribute.py
-test/test_mapping_attribute_label_matching_type.py
-test/test_mapping_attribute_metadata_field.py
-test/test_mapping_attribute_source_type.py
-test/test_mappings_api.py
-test/test_ocr_engine.py
-test/test_ocr_output_type.py
-test/test_opa_policy_attribute.py
-test/test_opa_policy_attribute_eq.py
-test/test_opa_policy_attribute_gt.py
-test/test_opa_policy_attribute_gte.py
-test/test_opa_policy_attribute_input.py
-test/test_opa_policy_attribute_lt.py
-test/test_opa_policy_attribute_lte.py
-test/test_opa_policy_attribute_neq.py
-test/test_opa_policy_item.py
-test/test_opa_policy_item_type.py
-test/test_rule_condition_criterion.py
-test/test_schema_attributes.py
-test/test_schemas_api.py
-test/test_search_range_data_type.py
-test/test_search_result_document_attribute.py
-test/test_set_classification_request.py
-test/test_set_document_attribute_request.py
-test/test_set_document_attributes_request.py
-test/test_set_mapping_request.py
-test/test_set_opa_access_policy_items_request.py
-test/test_set_response.py
-test/test_set_sites_schema_request.py
-test/test_user_activity_type.py
+test/test_ocr_key_values.py
 tox.ini
diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ FormKiQ offers three forms of authentication:
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.15.0
+- API version: 1.15.1
 - Package version: 1.0.0
 - Generator version: 7.7.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
@@ -517,6 +517,7 @@ Class | Method | HTTP request | Description
  - [Nigo](docs/Nigo.md)
  - [NigoStatus](docs/NigoStatus.md)
  - [OcrEngine](docs/OcrEngine.md)
+ - [OcrKeyValues](docs/OcrKeyValues.md)
  - [OcrOutputType](docs/OcrOutputType.md)
  - [OnlyOfficeConfig](docs/OnlyOfficeConfig.md)
  - [OnlyOfficeConfigDocument](docs/OnlyOfficeConfigDocument.md)

diff --git a/docs/AddDocumentRequest.md b/docs/AddDocumentRequest.md
@@ -5,6 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**document_id** | **str** | optional Document Identifier, if skipped one will be assigned | [optional] 
 **tag_schema_id** | **str** | Tag Schema Id | [optional] 
 **path** | **str** | Path or Name of document | [optional] 
 **deep_link_path** | **str** | Path or Name of deep link | [optional] 

diff --git a/docs/AddDocumentUploadRequest.md b/docs/AddDocumentUploadRequest.md
@@ -5,6 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**document_id** | **str** | optional Document Identifier, if skipped one will be assigned | [optional] 
 **tag_schema_id** | **str** | Tag Schema Id | [optional] 
 **path** | **str** | Path or Name of document | [optional] 
 **content_type** | **str** | Document media type | [optional] 

diff --git a/docs/AddUser.md b/docs/AddUser.md
@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**username** | **str** | Username of user | [optional] 
+**username** | **str** | Email address of user | [optional] 
 
 ## Example
 

diff --git a/docs/ClassificationSummary.md b/docs/ClassificationSummary.md
@@ -5,6 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**classification_id** | **str** | Classification Identifier | [optional] 
 **name** | **str** | Name of Classification | [optional] 
 **user_id** | **str** |  | [optional] 
 **inserted_date** | **str** | Inserted Timestamp | [optional] 

diff --git a/docs/DocumentOCRApi.md b/docs/DocumentOCRApi.md
@@ -162,7 +162,7 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **get_document_ocr**
-> GetDocumentOcrResponse get_document_ocr(document_id, site_id=site_id, content_url=content_url, text=text, share_key=share_key)
+> GetDocumentOcrResponse get_document_ocr(document_id, site_id=site_id, output_type=output_type, content_url=content_url, text=text, share_key=share_key)
 
 Get document ocr content
 
@@ -194,13 +194,14 @@ with formkiq_client.ApiClient(configuration) as api_client:
     api_instance = formkiq_client.DocumentOCRApi(api_client)
     document_id = 'document_id_example' # str | Document Identifier
     site_id = 'site_id_example' # str | Site Identifier (optional)
-    content_url = 'content_url_example' # str | Whether to return a \"contentUrl\", set value to 'true' (optional)
-    text = 'text_example' # str | Returns raw 'text' of OCR content. e.g. AWS Textract returns JSON, setting parameter to 'true' converts JSON to Text (optional)
+    output_type = 'output_type_example' # str | Output Format Type (optional)
+    content_url = 'content_url_example' # str | Whether to return a \"contentUrl\", set value to 'true' (deprecated) (optional)
+    text = 'text_example' # str | Returns raw 'text' of OCR content. e.g. AWS Textract returns JSON, setting parameter to 'true' converts JSON to Text (deprecated) (optional)
     share_key = 'share_key_example' # str | Share Identifier (optional)
 
     try:
         # Get document ocr content
-        api_response = api_instance.get_document_ocr(document_id, site_id=site_id, content_url=content_url, text=text, share_key=share_key)
+        api_response = api_instance.get_document_ocr(document_id, site_id=site_id, output_type=output_type, content_url=content_url, text=text, share_key=share_key)
         print("The response of DocumentOCRApi->get_document_ocr:\n")
         pprint(api_response)
     except Exception as e:
@@ -216,8 +217,9 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **document_id** | **str**| Document Identifier | 
  **site_id** | **str**| Site Identifier | [optional] 
- **content_url** | **str**| Whether to return a \&quot;contentUrl\&quot;, set value to &#39;true&#39; | [optional] 
- **text** | **str**| Returns raw &#39;text&#39; of OCR content. e.g. AWS Textract returns JSON, setting parameter to &#39;true&#39; converts JSON to Text | [optional] 
+ **output_type** | **str**| Output Format Type | [optional] 
+ **content_url** | **str**| Whether to return a \&quot;contentUrl\&quot;, set value to &#39;true&#39; (deprecated) | [optional] 
+ **text** | **str**| Returns raw &#39;text&#39; of OCR content. e.g. AWS Textract returns JSON, setting parameter to &#39;true&#39; converts JSON to Text (deprecated) | [optional] 
  **share_key** | **str**| Share Identifier | [optional] 
 
 ### Return type

diff --git a/docs/GetDocumentOcrResponse.md b/docs/GetDocumentOcrResponse.md
@@ -6,6 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **content_urls** | **List[str]** | Presigned S3 Urls for the OCR content | [optional] 
+**key_values** | [**List[OcrKeyValues]**](OcrKeyValues.md) | List of ocr key / values | [optional] 
 **data** | **str** | OCR text result | [optional] 
 **ocr_engine** | **str** | The OCR technique used | [optional] 
 **ocr_status** | **str** | The status of the OCR request | [optional] 

diff --git a/docs/Mapping.md b/docs/Mapping.md
@@ -5,6 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**mapping_id** | **str** | Mapping Identifier | [optional] 
 **name** | **str** | Name of Mapping | [optional] 
 **description** | **str** | Description of Mapping | [optional] 
 **attributes** | [**List[MappingAttribute]**](MappingAttribute.md) | List of attributes | [optional] 

diff --git a/docs/MappingAttributeSourceType.md b/docs/MappingAttributeSourceType.md
@@ -6,6 +6,8 @@ Attribute Source Type
 
 * `CONTENT` (value: `'CONTENT'`)
 
+* `CONTENT_KEY_VALUE` (value: `'CONTENT_KEY_VALUE'`)
+
 * `METADATA` (value: `'METADATA'`)
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/docs/OcrKeyValues.md b/docs/OcrKeyValues.md
@@ -0,0 +1,30 @@
+# OcrKeyValues
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **str** | Ocr Key | [optional] 
+**values** | **List[str]** |  | [optional] 
+
+## Example
+
+```python
+from formkiq_client.models.ocr_key_values import OcrKeyValues
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of OcrKeyValues from a JSON string
+ocr_key_values_instance = OcrKeyValues.from_json(json)
+# print the JSON string representation of the object
+print(OcrKeyValues.to_json())
+
+# convert the object into a dict
+ocr_key_values_dict = ocr_key_values_instance.to_dict()
+# create an instance of OcrKeyValues from a dict
+ocr_key_values_from_dict = OcrKeyValues.from_dict(ocr_key_values_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/formkiq_client/__init__.py b/formkiq_client/__init__.py
@@ -7,7 +7,7 @@
 
     Formkiq API: Document Management Platform API using OAuth(JWT) Authentication  You can find out more about FormKiQ at [https://formkiq.com](http://formkiq.com).  ## Introduction  FormKiQ is an API-first (head-less), battle-tested document management API. The FormKiQ API provides all the API endpoints to build your Perfect Document Management Platform.  FormKiQ API was built on top of [OpenAPI specification](https://www.openapis.org), so it is easy to use the API spec file with any application that supports the OpenAPI specification.  Open API OAuth Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-jwt.yaml  Open API IAM Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-iam.yaml  ## Authentication FormKiQ offers three forms of authentication:   - OAuth(JWT)   - AWS IAM   - API Key
 
-    The version of the OpenAPI document: 1.15.0
+    The version of the OpenAPI document: 1.15.1
     Contact: [email protected]
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -286,6 +286,7 @@
 from formkiq_client.models.nigo import Nigo
 from formkiq_client.models.nigo_status import NigoStatus
 from formkiq_client.models.ocr_engine import OcrEngine
+from formkiq_client.models.ocr_key_values import OcrKeyValues
 from formkiq_client.models.ocr_output_type import OcrOutputType
 from formkiq_client.models.only_office_config import OnlyOfficeConfig
 from formkiq_client.models.only_office_config_document import OnlyOfficeConfigDocument

diff --git a/formkiq_client/api/access_control_api.py b/formkiq_client/api/access_control_api.py
@@ -5,7 +5,7 @@
 
     Formkiq API: Document Management Platform API using OAuth(JWT) Authentication  You can find out more about FormKiQ at [https://formkiq.com](http://formkiq.com).  ## Introduction  FormKiQ is an API-first (head-less), battle-tested document management API. The FormKiQ API provides all the API endpoints to build your Perfect Document Management Platform.  FormKiQ API was built on top of [OpenAPI specification](https://www.openapis.org), so it is easy to use the API spec file with any application that supports the OpenAPI specification.  Open API OAuth Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-jwt.yaml  Open API IAM Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-iam.yaml  ## Authentication FormKiQ offers three forms of authentication:   - OAuth(JWT)   - AWS IAM   - API Key
 
-    The version of the OpenAPI document: 1.15.0
+    The version of the OpenAPI document: 1.15.1
     Contact: [email protected]
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/formkiq_client/api/advanced_document_search_api.py b/formkiq_client/api/advanced_document_search_api.py
@@ -5,7 +5,7 @@
 
     Formkiq API: Document Management Platform API using OAuth(JWT) Authentication  You can find out more about FormKiQ at [https://formkiq.com](http://formkiq.com).  ## Introduction  FormKiQ is an API-first (head-less), battle-tested document management API. The FormKiQ API provides all the API endpoints to build your Perfect Document Management Platform.  FormKiQ API was built on top of [OpenAPI specification](https://www.openapis.org), so it is easy to use the API spec file with any application that supports the OpenAPI specification.  Open API OAuth Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-jwt.yaml  Open API IAM Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-iam.yaml  ## Authentication FormKiQ offers three forms of authentication:   - OAuth(JWT)   - AWS IAM   - API Key
 
-    The version of the OpenAPI document: 1.15.0
+    The version of the OpenAPI document: 1.15.1
     Contact: [email protected]
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/formkiq_client/api/antivirus_api.py b/formkiq_client/api/antivirus_api.py
@@ -5,7 +5,7 @@
 
     Formkiq API: Document Management Platform API using OAuth(JWT) Authentication  You can find out more about FormKiQ at [https://formkiq.com](http://formkiq.com).  ## Introduction  FormKiQ is an API-first (head-less), battle-tested document management API. The FormKiQ API provides all the API endpoints to build your Perfect Document Management Platform.  FormKiQ API was built on top of [OpenAPI specification](https://www.openapis.org), so it is easy to use the API spec file with any application that supports the OpenAPI specification.  Open API OAuth Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-jwt.yaml  Open API IAM Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-iam.yaml  ## Authentication FormKiQ offers three forms of authentication:   - OAuth(JWT)   - AWS IAM   - API Key
 
-    The version of the OpenAPI document: 1.15.0
+    The version of the OpenAPI document: 1.15.1
     Contact: [email protected]
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/formkiq_client/api/attributes_api.py b/formkiq_client/api/attributes_api.py
@@ -5,7 +5,7 @@
 
     Formkiq API: Document Management Platform API using OAuth(JWT) Authentication  You can find out more about FormKiQ at [https://formkiq.com](http://formkiq.com).  ## Introduction  FormKiQ is an API-first (head-less), battle-tested document management API. The FormKiQ API provides all the API endpoints to build your Perfect Document Management Platform.  FormKiQ API was built on top of [OpenAPI specification](https://www.openapis.org), so it is easy to use the API spec file with any application that supports the OpenAPI specification.  Open API OAuth Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-jwt.yaml  Open API IAM Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-iam.yaml  ## Authentication FormKiQ offers three forms of authentication:   - OAuth(JWT)   - AWS IAM   - API Key
 
-    The version of the OpenAPI document: 1.15.0
+    The version of the OpenAPI document: 1.15.1
     Contact: [email protected]
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/formkiq_client/api/case_management_api.py b/formkiq_client/api/case_management_api.py
@@ -5,7 +5,7 @@
 
     Formkiq API: Document Management Platform API using OAuth(JWT) Authentication  You can find out more about FormKiQ at [https://formkiq.com](http://formkiq.com).  ## Introduction  FormKiQ is an API-first (head-less), battle-tested document management API. The FormKiQ API provides all the API endpoints to build your Perfect Document Management Platform.  FormKiQ API was built on top of [OpenAPI specification](https://www.openapis.org), so it is easy to use the API spec file with any application that supports the OpenAPI specification.  Open API OAuth Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-jwt.yaml  Open API IAM Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-iam.yaml  ## Authentication FormKiQ offers three forms of authentication:   - OAuth(JWT)   - AWS IAM   - API Key
 
-    The version of the OpenAPI document: 1.15.0
+    The version of the OpenAPI document: 1.15.1
     Contact: [email protected]
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/formkiq_client/api/custom_index_api.py b/formkiq_client/api/custom_index_api.py
@@ -5,7 +5,7 @@
 
     Formkiq API: Document Management Platform API using OAuth(JWT) Authentication  You can find out more about FormKiQ at [https://formkiq.com](http://formkiq.com).  ## Introduction  FormKiQ is an API-first (head-less), battle-tested document management API. The FormKiQ API provides all the API endpoints to build your Perfect Document Management Platform.  FormKiQ API was built on top of [OpenAPI specification](https://www.openapis.org), so it is easy to use the API spec file with any application that supports the OpenAPI specification.  Open API OAuth Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-jwt.yaml  Open API IAM Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-iam.yaml  ## Authentication FormKiQ offers three forms of authentication:   - OAuth(JWT)   - AWS IAM   - API Key
 
-    The version of the OpenAPI document: 1.15.0
+    The version of the OpenAPI document: 1.15.1
     Contact: [email protected]
     Generated by OpenAPI Generator (https://openapi-generator.tech)