Look for details in API documentation's changelog

eZmaxinc · Nov 8, 2023 · 2da6347 · 2da6347
1 parent d7334f3
commit 2da6347
Show file tree

Hide file tree

Showing 254 changed files with 10,532 additions and 2,822 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
diff --git a/README.md b/README.md
diff --git a/docs/AttachmentDownloadV1Response.md b/docs/AttachmentDownloadV1Response.md
@@ -0,0 +1,30 @@
+# AttachmentDownloadV1Response
+
+Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
+
+## Example
+
+```python
+from eZmaxApi.models.attachment_download_v1_response import AttachmentDownloadV1Response
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AttachmentDownloadV1Response from a JSON string
+attachment_download_v1_response_instance = AttachmentDownloadV1Response.from_json(json)
+# print the JSON string representation of the object
+print AttachmentDownloadV1Response.to_json()
+
+# convert the object into a dict
+attachment_download_v1_response_dict = attachment_download_v1_response_instance.to_dict()
+# create an instance of AttachmentDownloadV1Response from a dict
+attachment_download_v1_response_form_dict = attachment_download_v1_response.from_dict(attachment_download_v1_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/BuyercontractGetCommunicationListV1Response.md b/docs/BuyercontractGetCommunicationListV1Response.md
@@ -0,0 +1,31 @@
+# BuyercontractGetCommunicationListV1Response
+
+Response for GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
+**m_payload** | [**BuyercontractGetCommunicationListV1ResponseMPayload**](BuyercontractGetCommunicationListV1ResponseMPayload.md) |  | 
+
+## Example
+
+```python
+from eZmaxApi.models.buyercontract_get_communication_list_v1_response import BuyercontractGetCommunicationListV1Response
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BuyercontractGetCommunicationListV1Response from a JSON string
+buyercontract_get_communication_list_v1_response_instance = BuyercontractGetCommunicationListV1Response.from_json(json)
+# print the JSON string representation of the object
+print BuyercontractGetCommunicationListV1Response.to_json()
+
+# convert the object into a dict
+buyercontract_get_communication_list_v1_response_dict = buyercontract_get_communication_list_v1_response_instance.to_dict()
+# create an instance of BuyercontractGetCommunicationListV1Response from a dict
+buyercontract_get_communication_list_v1_response_form_dict = buyercontract_get_communication_list_v1_response.from_dict(buyercontract_get_communication_list_v1_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/BuyercontractGetCommunicationListV1ResponseMPayload.md b/docs/BuyercontractGetCommunicationListV1ResponseMPayload.md
@@ -0,0 +1,29 @@
+# BuyercontractGetCommunicationListV1ResponseMPayload
+
+Response for GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**a_obj_communication** | [**List[CustomCommunicationListElementResponse]**](CustomCommunicationListElementResponse.md) |  | 
+
+## Example
+
+```python
+from eZmaxApi.models.buyercontract_get_communication_list_v1_response_m_payload import BuyercontractGetCommunicationListV1ResponseMPayload
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BuyercontractGetCommunicationListV1ResponseMPayload from a JSON string
+buyercontract_get_communication_list_v1_response_m_payload_instance = BuyercontractGetCommunicationListV1ResponseMPayload.from_json(json)
+# print the JSON string representation of the object
+print BuyercontractGetCommunicationListV1ResponseMPayload.to_json()
+
+# convert the object into a dict
+buyercontract_get_communication_list_v1_response_m_payload_dict = buyercontract_get_communication_list_v1_response_m_payload_instance.to_dict()
+# create an instance of BuyercontractGetCommunicationListV1ResponseMPayload from a dict
+buyercontract_get_communication_list_v1_response_m_payload_form_dict = buyercontract_get_communication_list_v1_response_m_payload.from_dict(buyercontract_get_communication_list_v1_response_m_payload_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/CommonResponseObjDebugPayloadGetList.md b/docs/CommonResponseObjDebugPayloadGetList.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **b_version_deprecated** | **bool** | Wheter the current route is deprecated or not | 
 **a_filter** | [**CommonResponseFilter**](CommonResponseFilter.md) |  | 
 **a_order_by** | **Dict[str, str]** | List of available values for *eOrderBy* | 
-**i_row_max** | **int** | The maximum numbers of results to be returned | [default to 10000]
+**i_row_max** | **int** | The maximum numbers of results to be returned.  When the content-type is **application/json** there is an implicit default of 10 000.  When it&#39;s **application/vnd.openxmlformats-officedocument.spreadsheetml.sheet** the is no implicit default so if you do not specify iRowMax, all records will be returned. | 
 **i_row_offset** | **int** | The starting element from where to start retrieving the results. For example if you started at iRowOffset&#x3D;0 and asked for iRowMax&#x3D;100, to get the next 100 results, you could specify iRowOffset&#x3D;100&amp;iRowMax&#x3D;100, | [default to 0]
 
 ## Example

diff --git a/docs/CommunicationCreateObjectV1ResponseMPayload.md b/docs/CommunicationCreateObjectV1ResponseMPayload.md
@@ -0,0 +1,29 @@
+# CommunicationCreateObjectV1ResponseMPayload
+
+Payload for POST /1/object/communication
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**a_pki_communication_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created.  They are returned in the same order as the array containing the objects to be created that was sent in the request. | 
+
+## Example
+
+```python
+from eZmaxApi.models.communication_create_object_v1_response_m_payload import CommunicationCreateObjectV1ResponseMPayload
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CommunicationCreateObjectV1ResponseMPayload from a JSON string
+communication_create_object_v1_response_m_payload_instance = CommunicationCreateObjectV1ResponseMPayload.from_json(json)
+# print the JSON string representation of the object
+print CommunicationCreateObjectV1ResponseMPayload.to_json()
+
+# convert the object into a dict
+communication_create_object_v1_response_m_payload_dict = communication_create_object_v1_response_m_payload_instance.to_dict()
+# create an instance of CommunicationCreateObjectV1ResponseMPayload from a dict
+communication_create_object_v1_response_m_payload_form_dict = communication_create_object_v1_response_m_payload.from_dict(communication_create_object_v1_response_m_payload_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/CommunicationGetObjectV2Response.md b/docs/CommunicationGetObjectV2Response.md
diff --git a/docs/CommunicationGetObjectV2ResponseMPayload.md b/docs/CommunicationGetObjectV2ResponseMPayload.md
diff --git a/docs/CommunicationRequest.md b/docs/CommunicationRequest.md
@@ -0,0 +1,38 @@
+# CommunicationRequest
+
+Request for POST /1/object/communication
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pki_communication_id** | **int** | The unique ID of the Communication. | [optional] 
+**e_communication_importance** | [**FieldECommunicationImportance**](FieldECommunicationImportance.md) |  | [optional] 
+**e_communication_type** | [**FieldECommunicationType**](FieldECommunicationType.md) |  | 
+**obj_communicationsender** | [**CustomCommunicationsenderRequest**](CustomCommunicationsenderRequest.md) |  | [optional] 
+**s_communication_subject** | **str** | The subject of the Communication | [optional] 
+**t_communication_body** | **str** | The Body of the Communication | 
+**b_communication_private** | **bool** | Whether the Communication is private or not | 
+**e_communication_attachmenttype** | **str** | How the attachment should be included in the email.   Only used if eCommunicationType is **Email** | [optional] 
+**i_communication_attachmentlinkexpiration** | **int** | The number of days before the attachment link expired.   Only used if eCommunicationType is **Email** and eCommunicationattachmentType is **Link** | [optional] 
+**b_communication_readreceipt** | **bool** | Whether we ask for a read receipt or not. | [optional] 
+
+## Example
+
+```python
+from eZmaxApi.models.communication_request import CommunicationRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CommunicationRequest from a JSON string
+communication_request_instance = CommunicationRequest.from_json(json)
+# print the JSON string representation of the object
+print CommunicationRequest.to_json()
+
+# convert the object into a dict
+communication_request_dict = communication_request_instance.to_dict()
+# create an instance of CommunicationRequest from a dict
+communication_request_form_dict = communication_request.from_dict(communication_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/CommunicationRequestCompound.md b/docs/CommunicationRequestCompound.md
@@ -0,0 +1,42 @@
+# CommunicationRequestCompound
+
+Request for POST /1/object/communication
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pki_communication_id** | **int** | The unique ID of the Communication. | [optional] 
+**e_communication_importance** | [**FieldECommunicationImportance**](FieldECommunicationImportance.md) |  | [optional] 
+**e_communication_type** | [**FieldECommunicationType**](FieldECommunicationType.md) |  | 
+**obj_communicationsender** | [**CustomCommunicationsenderRequest**](CustomCommunicationsenderRequest.md) |  | [optional] 
+**s_communication_subject** | **str** | The subject of the Communication | [optional] 
+**t_communication_body** | **str** | The Body of the Communication | 
+**b_communication_private** | **bool** | Whether the Communication is private or not | 
+**e_communication_attachmenttype** | **str** | How the attachment should be included in the email.   Only used if eCommunicationType is **Email** | [optional] 
+**i_communication_attachmentlinkexpiration** | **int** | The number of days before the attachment link expired.   Only used if eCommunicationType is **Email** and eCommunicationattachmentType is **Link** | [optional] 
+**b_communication_readreceipt** | **bool** | Whether we ask for a read receipt or not. | [optional] 
+**a_obj_communicationattachment** | [**List[CustomCommunicationattachmentRequest]**](CustomCommunicationattachmentRequest.md) |  | 
+**a_obj_communicationrecipient** | [**List[CommunicationrecipientRequestCompound]**](CommunicationrecipientRequestCompound.md) |  | 
+**a_obj_communicationreference** | [**List[CommunicationreferenceRequestCompound]**](CommunicationreferenceRequestCompound.md) |  | 
+**a_obj_communicationexternalrecipient** | [**List[CommunicationexternalrecipientRequestCompound]**](CommunicationexternalrecipientRequestCompound.md) |  | 
+
+## Example
+
+```python
+from eZmaxApi.models.communication_request_compound import CommunicationRequestCompound
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CommunicationRequestCompound from a JSON string
+communication_request_compound_instance = CommunicationRequestCompound.from_json(json)
+# print the JSON string representation of the object
+print CommunicationRequestCompound.to_json()
+
+# convert the object into a dict
+communication_request_compound_dict = communication_request_compound_instance.to_dict()
+# create an instance of CommunicationRequestCompound from a dict
+communication_request_compound_form_dict = communication_request_compound.from_dict(communication_request_compound_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/CommunicationResponse.md b/docs/CommunicationResponse.md
diff --git a/docs/CommunicationResponseCompound.md b/docs/CommunicationResponseCompound.md