Update to formkiq v1.15.0 (#3)

formkiq · Jul 7, 2024 · 53c1ce3 · 53c1ce3
1 parent f6d1215
commit 53c1ce3
Show file tree

Hide file tree

Showing 822 changed files with 32,936 additions and 3,685 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
@@ -1 +1 @@
-7.4.0
+7.7.0
diff --git a/README.md b/README.md
diff --git a/docs/AccessControlApi.md b/docs/AccessControlApi.md
diff --git a/docs/AddAction.md b/docs/AddAction.md
@@ -24,7 +24,7 @@ print(AddAction.to_json())
 # convert the object into a dict
 add_action_dict = add_action_instance.to_dict()
 # create an instance of AddAction from a dict
-add_action_form_dict = add_action.from_dict(add_action_dict)
+add_action_from_dict = AddAction.from_dict(add_action_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/docs/AddActionParameters.md b/docs/AddActionParameters.md
@@ -6,8 +6,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **ocr_parse_types** | **str** | OCR: Parse types - TEXT, FORMS, TABLES | [optional] 
-**ocr_engine** | **str** | OCR: Engine to use for Optical character recognition | [optional] 
-**add_pdf_detected_characters_as_text** | **bool** | OCR: For the rewriting of the PDF document, converting any image text to searchable text | [optional] 
+**ocr_engine** | [**OcrEngine**](OcrEngine.md) |  | [optional] 
+**ocr_output_type** | [**OcrOutputType**](OcrOutputType.md) |  | [optional] 
+**ocr_number_of_pages** | **str** | Number of pages to OCR (from start) (-1 all) | [optional] 
+**add_pdf_detected_characters_as_text** | **str** | OCR: For the rewriting of the PDF document, converting any image text to searchable text | [optional] 
 **url** | **str** | Webhook: Callback URL | [optional] 
 **character_max** | **str** | Fulltext: Maximum number of characters (-1 unlimited, Typesense defaults to 2048 characters) | [optional] 
 **engine** | **str** | DocumentTagging: Engine to use for document tagging generation | [optional] 
@@ -18,6 +20,7 @@ Name | Type | Description | Notes
 **notification_text** | **str** | Text of the notification | [optional] 
 **notification_html** | **str** | Html of the notification | [optional] 
 **tags** | **str** | DocumentTagging: Comma-deliminted list of keywords to generate tags for | [optional] 
+**mapping_id** | **str** | Id of Mapping | [optional] 
 
 ## Example
 
@@ -34,7 +37,7 @@ print(AddActionParameters.to_json())
 # convert the object into a dict
 add_action_parameters_dict = add_action_parameters_instance.to_dict()
 # create an instance of AddActionParameters from a dict
-add_action_parameters_form_dict = add_action_parameters.from_dict(add_action_parameters_dict)
+add_action_parameters_from_dict = AddActionParameters.from_dict(add_action_parameters_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/docs/AddApiKeyRequest.md b/docs/AddApiKeyRequest.md
@@ -23,7 +23,7 @@ print(AddApiKeyRequest.to_json())
 # convert the object into a dict
 add_api_key_request_dict = add_api_key_request_instance.to_dict()
 # create an instance of AddApiKeyRequest from a dict
-add_api_key_request_form_dict = add_api_key_request.from_dict(add_api_key_request_dict)
+add_api_key_request_from_dict = AddApiKeyRequest.from_dict(add_api_key_request_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/docs/AddApiKeyResponse.md b/docs/AddApiKeyResponse.md
@@ -22,7 +22,7 @@ print(AddApiKeyResponse.to_json())
 # convert the object into a dict
 add_api_key_response_dict = add_api_key_response_instance.to_dict()
 # create an instance of AddApiKeyResponse from a dict
-add_api_key_response_form_dict = add_api_key_response.from_dict(add_api_key_response_dict)
+add_api_key_response_from_dict = AddApiKeyResponse.from_dict(add_api_key_response_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/docs/AddAttribute.md b/docs/AddAttribute.md
@@ -0,0 +1,31 @@
+# AddAttribute
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **str** | Attribute Key | 
+**data_type** | [**AttributeDataType**](AttributeDataType.md) |  | [optional] [default to AttributeDataType.STRING]
+**type** | [**AttributeType**](AttributeType.md) |  | [optional] [default to AttributeType.STANDARD]
+
+## Example
+
+```python
+from formkiq_client.models.add_attribute import AddAttribute
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AddAttribute from a JSON string
+add_attribute_instance = AddAttribute.from_json(json)
+# print the JSON string representation of the object
+print(AddAttribute.to_json())
+
+# convert the object into a dict
+add_attribute_dict = add_attribute_instance.to_dict()
+# create an instance of AddAttribute from a dict
+add_attribute_from_dict = AddAttribute.from_dict(add_attribute_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/docs/AddAttributeRequest.md b/docs/AddAttributeRequest.md
@@ -0,0 +1,29 @@
+# AddAttributeRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attribute** | [**AddAttribute**](AddAttribute.md) |  | 
+
+## Example
+
+```python
+from formkiq_client.models.add_attribute_request import AddAttributeRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AddAttributeRequest from a JSON string
+add_attribute_request_instance = AddAttributeRequest.from_json(json)
+# print the JSON string representation of the object
+print(AddAttributeRequest.to_json())
+
+# convert the object into a dict
+add_attribute_request_dict = add_attribute_request_instance.to_dict()
+# create an instance of AddAttributeRequest from a dict
+add_attribute_request_from_dict = AddAttributeRequest.from_dict(add_attribute_request_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/docs/AddAttributeResponse.md b/docs/AddAttributeResponse.md
@@ -0,0 +1,29 @@
+# AddAttributeResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **str** | Response Message | [optional] 
+
+## Example
+
+```python
+from formkiq_client.models.add_attribute_response import AddAttributeResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AddAttributeResponse from a JSON string
+add_attribute_response_instance = AddAttributeResponse.from_json(json)
+# print the JSON string representation of the object
+print(AddAttributeResponse.to_json())
+
+# convert the object into a dict
+add_attribute_response_dict = add_attribute_response_instance.to_dict()
+# create an instance of AddAttributeResponse from a dict
+add_attribute_response_from_dict = AddAttributeResponse.from_dict(add_attribute_response_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/docs/AddCase.md b/docs/AddCase.md
@@ -14,8 +14,6 @@ Name | Type | Description | Notes
 **case_number_format** | [**List[StringFormat]**](StringFormat.md) | Format of Case Number | [optional] 
 **metadata** | **Dict[str, object]** |  | [optional] 
 **document_ids** | **List[str]** |  | [optional] 
-**tasks** | [**List[AddTask]**](AddTask.md) |  | [optional] 
-**nigos** | [**List[AddNigo]**](AddNigo.md) |  | [optional] 
 
 ## Example
 
@@ -32,7 +30,7 @@ print(AddCase.to_json())
 # convert the object into a dict
 add_case_dict = add_case_instance.to_dict()
 # create an instance of AddCase from a dict
-add_case_form_dict = add_case.from_dict(add_case_dict)
+add_case_from_dict = AddCase.from_dict(add_case_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/docs/AddCaseRequest.md b/docs/AddCaseRequest.md
@@ -22,7 +22,7 @@ print(AddCaseRequest.to_json())
 # convert the object into a dict
 add_case_request_dict = add_case_request_instance.to_dict()
 # create an instance of AddCaseRequest from a dict
-add_case_request_form_dict = add_case_request.from_dict(add_case_request_dict)
+add_case_request_from_dict = AddCaseRequest.from_dict(add_case_request_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/docs/AddCaseResponse.md b/docs/AddCaseResponse.md
@@ -22,7 +22,7 @@ print(AddCaseResponse.to_json())
 # convert the object into a dict
 add_case_response_dict = add_case_response_instance.to_dict()
 # create an instance of AddCaseResponse from a dict
-add_case_response_form_dict = add_case_response.from_dict(add_case_response_dict)
+add_case_response_from_dict = AddCaseResponse.from_dict(add_case_response_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/docs/AddChildDocument.md b/docs/AddChildDocument.md
@@ -29,7 +29,7 @@ print(AddChildDocument.to_json())
 # convert the object into a dict
 add_child_document_dict = add_child_document_instance.to_dict()
 # create an instance of AddChildDocument from a dict
-add_child_document_form_dict = add_child_document.from_dict(add_child_document_dict)
+add_child_document_from_dict = AddChildDocument.from_dict(add_child_document_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/docs/AddChildDocumentResponse.md b/docs/AddChildDocumentResponse.md
@@ -23,7 +23,7 @@ print(AddChildDocumentResponse.to_json())
 # convert the object into a dict
 add_child_document_response_dict = add_child_document_response_instance.to_dict()
 # create an instance of AddChildDocumentResponse from a dict
-add_child_document_response_form_dict = add_child_document_response.from_dict(add_child_document_response_dict)
+add_child_document_response_from_dict = AddChildDocumentResponse.from_dict(add_child_document_response_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/docs/AddClassification.md b/docs/AddClassification.md
@@ -0,0 +1,30 @@
+# AddClassification
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Name of Classification | [optional] 
+**attributes** | [**SchemaAttributes**](SchemaAttributes.md) |  | [optional] 
+
+## Example
+
+```python
+from formkiq_client.models.add_classification import AddClassification
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AddClassification from a JSON string
+add_classification_instance = AddClassification.from_json(json)
+# print the JSON string representation of the object
+print(AddClassification.to_json())
+
+# convert the object into a dict
+add_classification_dict = add_classification_instance.to_dict()
+# create an instance of AddClassification from a dict
+add_classification_from_dict = AddClassification.from_dict(add_classification_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/docs/AddClassificationRequest.md b/docs/AddClassificationRequest.md
@@ -0,0 +1,29 @@
+# AddClassificationRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**classification** | [**AddClassification**](AddClassification.md) |  | [optional] 
+
+## Example
+
+```python
+from formkiq_client.models.add_classification_request import AddClassificationRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AddClassificationRequest from a JSON string
+add_classification_request_instance = AddClassificationRequest.from_json(json)
+# print the JSON string representation of the object
+print(AddClassificationRequest.to_json())
+
+# convert the object into a dict
+add_classification_request_dict = add_classification_request_instance.to_dict()
+# create an instance of AddClassificationRequest from a dict
+add_classification_request_from_dict = AddClassificationRequest.from_dict(add_classification_request_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/docs/AddClassificationResponse.md b/docs/AddClassificationResponse.md
@@ -0,0 +1,29 @@
+# AddClassificationResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**classification_id** | **str** | Classification Identifier | [optional] 
+
+## Example
+
+```python
+from formkiq_client.models.add_classification_response import AddClassificationResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AddClassificationResponse from a JSON string
+add_classification_response_instance = AddClassificationResponse.from_json(json)
+# print the JSON string representation of the object
+print(AddClassificationResponse.to_json())
+
+# convert the object into a dict
+add_classification_response_dict = add_classification_response_instance.to_dict()
+# create an instance of AddClassificationResponse from a dict
+add_classification_response_from_dict = AddClassificationResponse.from_dict(add_classification_response_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/docs/AddDocumentActionsRequest.md b/docs/AddDocumentActionsRequest.md
@@ -22,7 +22,7 @@ print(AddDocumentActionsRequest.to_json())
 # convert the object into a dict
 add_document_actions_request_dict = add_document_actions_request_instance.to_dict()
 # create an instance of AddDocumentActionsRequest from a dict
-add_document_actions_request_form_dict = add_document_actions_request.from_dict(add_document_actions_request_dict)
+add_document_actions_request_from_dict = AddDocumentActionsRequest.from_dict(add_document_actions_request_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/docs/AddDocumentActionsResponse.md b/docs/AddDocumentActionsResponse.md
@@ -22,7 +22,7 @@ print(AddDocumentActionsResponse.to_json())
 # convert the object into a dict
 add_document_actions_response_dict = add_document_actions_response_instance.to_dict()
 # create an instance of AddDocumentActionsResponse from a dict
-add_document_actions_response_form_dict = add_document_actions_response.from_dict(add_document_actions_response_dict)
+add_document_actions_response_from_dict = AddDocumentActionsResponse.from_dict(add_document_actions_response_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/docs/AddDocumentActionsRetryResponse.md b/docs/AddDocumentActionsRetryResponse.md
@@ -22,7 +22,7 @@ print(AddDocumentActionsRetryResponse.to_json())
 # convert the object into a dict
 add_document_actions_retry_response_dict = add_document_actions_retry_response_instance.to_dict()
 # create an instance of AddDocumentActionsRetryResponse from a dict
-add_document_actions_retry_response_form_dict = add_document_actions_retry_response.from_dict(add_document_actions_retry_response_dict)
+add_document_actions_retry_response_from_dict = AddDocumentActionsRetryResponse.from_dict(add_document_actions_retry_response_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/docs/AddDocumentAttribute.md b/docs/AddDocumentAttribute.md
@@ -0,0 +1,35 @@
+# AddDocumentAttribute
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **str** | Attribute key | 
+**string_value** | **str** | Attribute with string value | [optional] 
+**string_values** | **List[str]** | Attribute with string values | [optional] 
+**number_value** | **float** | Attribute with number value | [optional] 
+**number_values** | **List[float]** | Attribute with number values | [optional] 
+**boolean_value** | **bool** | Attribute with boolean value | [optional] 
+**classification_id** | **str** | Classification Identifier | [optional] 
+
+## Example
+
+```python
+from formkiq_client.models.add_document_attribute import AddDocumentAttribute
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AddDocumentAttribute from a JSON string
+add_document_attribute_instance = AddDocumentAttribute.from_json(json)
+# print the JSON string representation of the object
+print(AddDocumentAttribute.to_json())
+
+# convert the object into a dict
+add_document_attribute_dict = add_document_attribute_instance.to_dict()
+# create an instance of AddDocumentAttribute from a dict
+add_document_attribute_from_dict = AddDocumentAttribute.from_dict(add_document_attribute_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/docs/AddDocumentAttributeClassification.md b/docs/AddDocumentAttributeClassification.md
@@ -0,0 +1,30 @@
+# AddDocumentAttributeClassification
+
+Document Classification
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**classification_id** | **str** | Classification Identifier | [optional] 
+
+## Example
+
+```python
+from formkiq_client.models.add_document_attribute_classification import AddDocumentAttributeClassification
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AddDocumentAttributeClassification from a JSON string
+add_document_attribute_classification_instance = AddDocumentAttributeClassification.from_json(json)
+# print the JSON string representation of the object
+print(AddDocumentAttributeClassification.to_json())
+
+# convert the object into a dict
+add_document_attribute_classification_dict = add_document_attribute_classification_instance.to_dict()
+# create an instance of AddDocumentAttributeClassification from a dict
+add_document_attribute_classification_from_dict = AddDocumentAttributeClassification.from_dict(add_document_attribute_classification_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)
+
+