Look for details in API documentation's changelog

eZmaxinc · Jan 19, 2024 · e0434bd · e0434bd
1 parent 21502a3
commit e0434bd
Show file tree

Hide file tree

Showing 320 changed files with 18,527 additions and 150 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
diff --git a/README.md b/README.md
diff --git a/docs/CustomCreateEzsignelementsPositionedByWordRequest.md b/docs/CustomCreateEzsignelementsPositionedByWordRequest.md
@@ -0,0 +1,33 @@
+# CustomCreateEzsignelementsPositionedByWordRequest
+
+A CreateEzsignelementsPositionedByWord object
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**s_createezsignelementspositionedbyword_pattern** | **str** | The word to search | 
+**i_createezsignelementspositionedbyword_offsetx** | **int** | The X offset | 
+**i_createezsignelementspositionedbyword_offsety** | **int** | The Y offset | 
+**e_createezsignelementspositionedbyword_occurance** | **str** | The occurance in the search to add the ezsign element | 
+
+## Example
+
+```python
+from eZmaxApi.models.custom_create_ezsignelements_positioned_by_word_request import CustomCreateEzsignelementsPositionedByWordRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CustomCreateEzsignelementsPositionedByWordRequest from a JSON string
+custom_create_ezsignelements_positioned_by_word_request_instance = CustomCreateEzsignelementsPositionedByWordRequest.from_json(json)
+# print the JSON string representation of the object
+print CustomCreateEzsignelementsPositionedByWordRequest.to_json()
+
+# convert the object into a dict
+custom_create_ezsignelements_positioned_by_word_request_dict = custom_create_ezsignelements_positioned_by_word_request_instance.to_dict()
+# create an instance of CustomCreateEzsignelementsPositionedByWordRequest from a dict
+custom_create_ezsignelements_positioned_by_word_request_form_dict = custom_create_ezsignelements_positioned_by_word_request.from_dict(custom_create_ezsignelements_positioned_by_word_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/CustomDiscussionconfigurationResponse.md b/docs/CustomDiscussionconfigurationResponse.md
@@ -0,0 +1,34 @@
+# CustomDiscussionconfigurationResponse
+
+A Custom Discussionconfiguration Object
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**b_discussionconfiguration_completehistorywhenadded** | **bool** | If the added Discussionmembership will have access to the entire history or not | 
+**b_discussionconfiguration_createallowed** | **bool** | If the the creation of the Discussion is allowed or not | 
+**b_discussionconfiguration_deleteallowed** | **bool** | If the the destruction of the Discussion is allowed or not | 
+**b_discussionconfiguration_deletediscussionmessageallowed** | **bool** | If the the destruction of the Discussionmessage is allowed or not | 
+**b_discussionconfiguration_editdiscussionmessageallowed** | **bool** | If the the creation of the Discussionmessage is allowed or not | 
+
+## Example
+
+```python
+from eZmaxApi.models.custom_discussionconfiguration_response import CustomDiscussionconfigurationResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CustomDiscussionconfigurationResponse from a JSON string
+custom_discussionconfiguration_response_instance = CustomDiscussionconfigurationResponse.from_json(json)
+# print the JSON string representation of the object
+print CustomDiscussionconfigurationResponse.to_json()
+
+# convert the object into a dict
+custom_discussionconfiguration_response_dict = custom_discussionconfiguration_response_instance.to_dict()
+# create an instance of CustomDiscussionconfigurationResponse from a dict
+custom_discussionconfiguration_response_form_dict = custom_discussionconfiguration_response.from_dict(custom_discussionconfiguration_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/CustomEzmaxinvoicingEzsigndocumentResponse.md b/docs/CustomEzmaxinvoicingEzsigndocumentResponse.md
@@ -7,6 +7,7 @@ An EzmaxinvoicingEzsigndocument object containing information about the Ezmaxinv
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **fki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | 
+**fki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | [optional] 
 **s_name** | **str** |  | 
 **s_ezsignfolder_description** | **str** | The description of the Ezsignfolder | 
 **s_ezsigndocument_name** | **str** | The name of the document that will be presented to Ezsignfoldersignerassociations | 

diff --git a/docs/CustomEzmaxinvoicingEzsignfolderResponse.md b/docs/CustomEzmaxinvoicingEzsignfolderResponse.md
@@ -7,6 +7,7 @@ An EzmaxinvoicingEzsignfolder object containing information about the Ezmaxinvoi
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **fki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | 
+**fki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | [optional] 
 **s_ezsignfolder_description** | **str** | The description of the Ezsignfolder | 
 **b_ezsigntsarequirement_billable** | **bool** | Whether the TSA requirement is billable or not | 
 **b_ezsignfolder_mfaused** | **bool** | Whether the MFA was used or not for the Ezsignfolder | 

diff --git a/docs/CustomEzsignfoldertypeResponse.md b/docs/CustomEzsignfoldertypeResponse.md
@@ -15,6 +15,8 @@ Name | Type | Description | Notes
 **b_ezsignfoldertype_allowdownloadproofezsignsigner** | **bool** | Whether we allow the proof to be downloaded by an Ezsignsigner | [optional] 
 **b_ezsignfoldertype_delegate** | **bool** | Wheter if delegation of signature is allowed to another user or not | [optional] 
 **b_ezsignfoldertype_reassign** | **bool** | Wheter if Reassignment of signature is allowed to another signatory or not | [optional] 
+**b_ezsignfoldertype_reassignezsignsigner** | **bool** | Wheter if Reassignment of signature is allowed by a signatory to another signatory or not | [optional] 
+**b_ezsignfoldertype_reassignuser** | **bool** | Wheter if Reassignment of signature is allowed by a user to a signatory or another user or not | [optional] 
 
 ## Example
 

diff --git a/docs/CustomEzsignformfieldRequest.md b/docs/CustomEzsignformfieldRequest.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **pki_ezsignformfield_id** | **int** | The unique ID of the Ezsignformfield | [optional] 
 **s_ezsignformfield_label** | **str** | The Label for the Ezsignformfield | [optional] 
 **b_ezsignformfield_selected** | **bool** | Whether the Ezsignformfield is selected or not by default.  This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio** | [optional] 
-**s_ezsignformfield_enteredvalue** | **str** | This is the value enterred for the Ezsignformfield  This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea** | [optional] 
+**s_ezsignformfield_enteredvalue** | **str** | This is the value enterred for the Ezsignformfield  This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea**  You can use the codes below and they will be replaced at signature time.    | Code | Description | Example | | ------------------------- | ------------ | ------------ | | {sUserFirstname} | The first name of the contact | John | | {sUserLastname} | The last name of the contact | Doe | | {sUserJobtitle} | The job title | Sales Representative | | {sEmailAddress} | The email address | email@example.com | | {sPhoneE164} | A phone number in E.164 Format | +15149901516 | | {sPhoneE164Cell} | A phone number in E.164 Format | +15149901516 | | [optional] 
 
 ## Example
 

diff --git a/docs/CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.md b/docs/CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.md
@@ -0,0 +1,49 @@
+# CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest
+
+An Ezsignformfieldgroup Object in the context of a createEzsignelementsPositionedByWord path
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pki_ezsignformfieldgroup_id** | **int** | The unique ID of the Ezsignformfieldgroup | [optional] 
+**fki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | 
+**e_ezsignformfieldgroup_type** | [**FieldEEzsignformfieldgroupType**](FieldEEzsignformfieldgroupType.md) |  | 
+**e_ezsignformfieldgroup_signerrequirement** | [**FieldEEzsignformfieldgroupSignerrequirement**](FieldEEzsignformfieldgroupSignerrequirement.md) |  | 
+**s_ezsignformfieldgroup_label** | **str** | The Label for the Ezsignformfieldgroup | 
+**i_ezsignformfieldgroup_step** | **int** | The step when the Ezsignsigner will be invited to fill the form fields | 
+**s_ezsignformfieldgroup_defaultvalue** | **str** | The default value for the Ezsignformfieldgroup | [optional] 
+**i_ezsignformfieldgroup_filledmin** | **int** | The minimum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup | 
+**i_ezsignformfieldgroup_filledmax** | **int** | The maximum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup | 
+**b_ezsignformfieldgroup_readonly** | **bool** | Whether the Ezsignformfieldgroup is read only or not. | 
+**i_ezsignformfieldgroup_maxlength** | **int** | The maximum length for the value in the Ezsignformfieldgroup  This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea** | [optional] 
+**b_ezsignformfieldgroup_encrypted** | **bool** | Whether the Ezsignformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea** | [optional] 
+**s_ezsignformfieldgroup_regexp** | **str** | A regular expression to indicate what values are acceptable for the Ezsignformfieldgroup.  This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea** | [optional] 
+**t_ezsignformfieldgroup_tooltip** | **str** | A tooltip that will be presented to Ezsignsigner about the Ezsignformfieldgroup | [optional] 
+**e_ezsignformfieldgroup_tooltipposition** | [**FieldEEzsignformfieldgroupTooltipposition**](FieldEEzsignformfieldgroupTooltipposition.md) |  | [optional] 
+**e_ezsignformfieldgroup_textvalidation** | [**EnumTextvalidation**](EnumTextvalidation.md) |  | [optional] 
+**a_obj_ezsignformfieldgroupsigner** | [**List[EzsignformfieldgroupsignerRequestCompound]**](EzsignformfieldgroupsignerRequestCompound.md) |  | 
+**a_obj_dropdown_element** | [**List[CustomDropdownElementRequestCompound]**](CustomDropdownElementRequestCompound.md) |  | [optional] 
+**a_obj_ezsignformfield** | [**List[EzsignformfieldRequestCompound]**](EzsignformfieldRequestCompound.md) |  | 
+**obj_createezsignelementspositionedbyword** | [**CustomCreateEzsignelementsPositionedByWordRequest**](CustomCreateEzsignelementsPositionedByWordRequest.md) |  | 
+
+## Example
+
+```python
+from eZmaxApi.models.custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request import CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest from a JSON string
+custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request_instance = CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.from_json(json)
+# print the JSON string representation of the object
+print CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.to_json()
+
+# convert the object into a dict
+custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request_dict = custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request_instance.to_dict()
+# create an instance of CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest from a dict
+custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request_form_dict = custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request.from_dict(custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_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/CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.md b/docs/CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.md
@@ -0,0 +1,55 @@
+# CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest
+
+An Ezsignsignature Object in the context of an CreateEzsignelementsPositionedByWord path
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pki_ezsignsignature_id** | **int** | The unique ID of the Ezsignsignature | [optional] 
+**fki_ezsignfoldersignerassociation_id** | **int** | The unique ID of the Ezsignfoldersignerassociation | 
+**i_ezsignpage_pagenumber** | **int** | The page number in the Ezsigndocument | 
+**i_ezsignsignature_x** | **int** | The X coordinate (Horizontal) where to put the Ezsignsignature on the page.  Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 2 inches from the left border of the page, you would use \&quot;200\&quot; for the X coordinate. | 
+**i_ezsignsignature_y** | **int** | The Y coordinate (Vertical) where to put the Ezsignsignature on the page.  Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 3 inches from the top border of the page, you would use \&quot;300\&quot; for the Y coordinate. | 
+**i_ezsignsignature_width** | **int** | The width of the Ezsignsignature.  Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have a width of 2 inches, you would use \&quot;200\&quot; for the iEzsignsignatureWidth. | [optional] 
+**i_ezsignsignature_height** | **int** | The height of the Ezsignsignature.  Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have an height of 2 inches, you would use \&quot;200\&quot; for the iEzsignsignatureHeight. | [optional] 
+**i_ezsignsignature_step** | **int** | The step when the Ezsignsigner will be invited to sign | 
+**e_ezsignsignature_type** | [**FieldEEzsignsignatureType**](FieldEEzsignsignatureType.md) |  | 
+**fki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | 
+**t_ezsignsignature_tooltip** | **str** | A tooltip that will be presented to Ezsignsigner about the Ezsignsignature | [optional] 
+**e_ezsignsignature_tooltipposition** | [**FieldEEzsignsignatureTooltipposition**](FieldEEzsignsignatureTooltipposition.md) |  | [optional] 
+**e_ezsignsignature_font** | [**FieldEEzsignsignatureFont**](FieldEEzsignsignatureFont.md) |  | [optional] 
+**fki_ezsignfoldersignerassociation_id_validation** | **int** | The unique ID of the Ezsignfoldersignerassociation | [optional] 
+**b_ezsignsignature_required** | **bool** | Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType &#x3D; Attachments. | [optional] 
+**e_ezsignsignature_attachmentnamesource** | [**FieldEEzsignsignatureAttachmentnamesource**](FieldEEzsignsignatureAttachmentnamesource.md) |  | [optional] 
+**s_ezsignsignature_attachmentdescription** | **str** | The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments | [optional] 
+**i_ezsignsignature_validationstep** | **int** | The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments | [optional] 
+**i_ezsignsignature_maxlength** | **int** | The maximum length for the value in the Ezsignsignature  This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea** | [optional] 
+**e_ezsignsignature_textvalidation** | [**EnumTextvalidation**](EnumTextvalidation.md) |  | [optional] 
+**s_ezsignsignature_regexp** | **str** | A regular expression to indicate what values are acceptable for the Ezsignsignature.  This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea** and eEzsignsignatureTextvalidation is **Custom** | [optional] 
+**e_ezsignsignature_dependencyrequirement** | [**FieldEEzsignsignatureDependencyrequirement**](FieldEEzsignsignatureDependencyrequirement.md) |  | [optional] 
+**b_ezsignsignature_customdate** | **bool** | Whether the Ezsignsignature has a custom date format or not. (Only possible when eEzsignsignatureType is **Name** or **Handwritten**) | [optional] 
+**a_obj_ezsignsignaturecustomdate** | [**List[EzsignsignaturecustomdateRequestCompound]**](EzsignsignaturecustomdateRequestCompound.md) | An array of custom date blocks that will be filled at the time of signature.  Can only be used if bEzsignsignatureCustomdate is true.  Use an empty array if you don&#39;t want to have a date at all. | [optional] 
+**a_obj_ezsignelementdependency** | [**List[EzsignelementdependencyRequestCompound]**](EzsignelementdependencyRequestCompound.md) |  | [optional] 
+**obj_createezsignelementspositionedbyword** | [**CustomCreateEzsignelementsPositionedByWordRequest**](CustomCreateEzsignelementsPositionedByWordRequest.md) |  | 
+
+## Example
+
+```python
+from eZmaxApi.models.custom_ezsignsignature_create_ezsignelements_positioned_by_word_request import CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest from a JSON string
+custom_ezsignsignature_create_ezsignelements_positioned_by_word_request_instance = CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.from_json(json)
+# print the JSON string representation of the object
+print CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.to_json()
+
+# convert the object into a dict
+custom_ezsignsignature_create_ezsignelements_positioned_by_word_request_dict = custom_ezsignsignature_create_ezsignelements_positioned_by_word_request_instance.to_dict()
+# create an instance of CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest from a dict
+custom_ezsignsignature_create_ezsignelements_positioned_by_word_request_form_dict = custom_ezsignsignature_create_ezsignelements_positioned_by_word_request.from_dict(custom_ezsignsignature_create_ezsignelements_positioned_by_word_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/CustomWebhookResponse.md b/docs/CustomWebhookResponse.md
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **b_webhook_isactive** | **bool** | Whether the Webhook is active or not | 
 **b_webhook_issigned** | **bool** | Whether the requests will be signed or not | 
 **b_webhook_skipsslvalidation** | **bool** | Wheter the server&#39;s SSL certificate should be validated or not. Not recommended to skip for production use | 
+**obj_audit** | [**CommonAudit**](CommonAudit.md) |  | 
 **pks_customer_code** | **str** | The customer code assigned to your account | 
 **b_webhook_test** | **bool** | Wheter the webhook received is a manual test or a real event | 
 

diff --git a/docs/DiscussionCreateObjectV1Request.md b/docs/DiscussionCreateObjectV1Request.md
@@ -0,0 +1,30 @@
+# DiscussionCreateObjectV1Request
+
+Request for POST /1/object/discussion
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**a_obj_discussion** | [**List[DiscussionRequestCompound]**](DiscussionRequestCompound.md) |  | 
+
+## Example
+
+```python
+from eZmaxApi.models.discussion_create_object_v1_request import DiscussionCreateObjectV1Request
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of DiscussionCreateObjectV1Request from a JSON string
+discussion_create_object_v1_request_instance = DiscussionCreateObjectV1Request.from_json(json)
+# print the JSON string representation of the object
+print DiscussionCreateObjectV1Request.to_json()
+
+# convert the object into a dict
+discussion_create_object_v1_request_dict = discussion_create_object_v1_request_instance.to_dict()
+# create an instance of DiscussionCreateObjectV1Request from a dict
+discussion_create_object_v1_request_form_dict = discussion_create_object_v1_request.from_dict(discussion_create_object_v1_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)
+
+