Skip to content

Commit e0434bd

Browse files
author
Api (Codebuild)
committed
Look for details in API documentation's changelog
1 parent 21502a3 commit e0434bd

320 files changed

Lines changed: 18527 additions & 150 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.openapi-generator/FILES‎

Lines changed: 192 additions & 0 deletions
Large diffs are not rendered by default.

‎README.md‎

Lines changed: 75 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/CustomCreateEzsignelementsPositionedByWordRequest.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# CustomCreateEzsignelementsPositionedByWordRequest
2+
3+
A CreateEzsignelementsPositionedByWord object
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**s_createezsignelementspositionedbyword_pattern** | **str** | The word to search |
10+
**i_createezsignelementspositionedbyword_offsetx** | **int** | The X offset |
11+
**i_createezsignelementspositionedbyword_offsety** | **int** | The Y offset |
12+
**e_createezsignelementspositionedbyword_occurance** | **str** | The occurance in the search to add the ezsign element |
13+
14+
## Example
15+
16+
```python
17+
from eZmaxApi.models.custom_create_ezsignelements_positioned_by_word_request import CustomCreateEzsignelementsPositionedByWordRequest
18+
19+
# TODO update the JSON string below
20+
json = "{}"
21+
# create an instance of CustomCreateEzsignelementsPositionedByWordRequest from a JSON string
22+
custom_create_ezsignelements_positioned_by_word_request_instance = CustomCreateEzsignelementsPositionedByWordRequest.from_json(json)
23+
# print the JSON string representation of the object
24+
print CustomCreateEzsignelementsPositionedByWordRequest.to_json()
25+
26+
# convert the object into a dict
27+
custom_create_ezsignelements_positioned_by_word_request_dict = custom_create_ezsignelements_positioned_by_word_request_instance.to_dict()
28+
# create an instance of CustomCreateEzsignelementsPositionedByWordRequest from a dict
29+
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)
30+
```
31+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
32+
33+

‎docs/CustomDiscussionconfigurationResponse.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# CustomDiscussionconfigurationResponse
2+
3+
A Custom Discussionconfiguration Object
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**b_discussionconfiguration_completehistorywhenadded** | **bool** | If the added Discussionmembership will have access to the entire history or not |
10+
**b_discussionconfiguration_createallowed** | **bool** | If the the creation of the Discussion is allowed or not |
11+
**b_discussionconfiguration_deleteallowed** | **bool** | If the the destruction of the Discussion is allowed or not |
12+
**b_discussionconfiguration_deletediscussionmessageallowed** | **bool** | If the the destruction of the Discussionmessage is allowed or not |
13+
**b_discussionconfiguration_editdiscussionmessageallowed** | **bool** | If the the creation of the Discussionmessage is allowed or not |
14+
15+
## Example
16+
17+
```python
18+
from eZmaxApi.models.custom_discussionconfiguration_response import CustomDiscussionconfigurationResponse
19+
20+
# TODO update the JSON string below
21+
json = "{}"
22+
# create an instance of CustomDiscussionconfigurationResponse from a JSON string
23+
custom_discussionconfiguration_response_instance = CustomDiscussionconfigurationResponse.from_json(json)
24+
# print the JSON string representation of the object
25+
print CustomDiscussionconfigurationResponse.to_json()
26+
27+
# convert the object into a dict
28+
custom_discussionconfiguration_response_dict = custom_discussionconfiguration_response_instance.to_dict()
29+
# create an instance of CustomDiscussionconfigurationResponse from a dict
30+
custom_discussionconfiguration_response_form_dict = custom_discussionconfiguration_response.from_dict(custom_discussionconfiguration_response_dict)
31+
```
32+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
33+
34+

‎docs/CustomEzmaxinvoicingEzsigndocumentResponse.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ An EzmaxinvoicingEzsigndocument object containing information about the Ezmaxinv
77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
**fki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder |
10+
**fki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | [optional]
1011
**s_name** | **str** | |
1112
**s_ezsignfolder_description** | **str** | The description of the Ezsignfolder |
1213
**s_ezsigndocument_name** | **str** | The name of the document that will be presented to Ezsignfoldersignerassociations |

‎docs/CustomEzmaxinvoicingEzsignfolderResponse.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ An EzmaxinvoicingEzsignfolder object containing information about the Ezmaxinvoi
77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
**fki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder |
10+
**fki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | [optional]
1011
**s_ezsignfolder_description** | **str** | The description of the Ezsignfolder |
1112
**b_ezsigntsarequirement_billable** | **bool** | Whether the TSA requirement is billable or not |
1213
**b_ezsignfolder_mfaused** | **bool** | Whether the MFA was used or not for the Ezsignfolder |

‎docs/CustomEzsignfoldertypeResponse.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Name | Type | Description | Notes
1515
**b_ezsignfoldertype_allowdownloadproofezsignsigner** | **bool** | Whether we allow the proof to be downloaded by an Ezsignsigner | [optional]
1616
**b_ezsignfoldertype_delegate** | **bool** | Wheter if delegation of signature is allowed to another user or not | [optional]
1717
**b_ezsignfoldertype_reassign** | **bool** | Wheter if Reassignment of signature is allowed to another signatory or not | [optional]
18+
**b_ezsignfoldertype_reassignezsignsigner** | **bool** | Wheter if Reassignment of signature is allowed by a signatory to another signatory or not | [optional]
19+
**b_ezsignfoldertype_reassignuser** | **bool** | Wheter if Reassignment of signature is allowed by a user to a signatory or another user or not | [optional]
1820

1921
## Example
2022

‎docs/CustomEzsignformfieldRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**pki_ezsignformfield_id** | **int** | The unique ID of the Ezsignformfield | [optional]
1010
**s_ezsignformfield_label** | **str** | The Label for the Ezsignformfield | [optional]
1111
**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]
12-
**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]
12+
**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]
1313

1414
## Example
1515

‎docs/CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest
2+
3+
An Ezsignformfieldgroup Object in the context of a createEzsignelementsPositionedByWord path
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**pki_ezsignformfieldgroup_id** | **int** | The unique ID of the Ezsignformfieldgroup | [optional]
10+
**fki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument |
11+
**e_ezsignformfieldgroup_type** | [**FieldEEzsignformfieldgroupType**](FieldEEzsignformfieldgroupType.md) | |
12+
**e_ezsignformfieldgroup_signerrequirement** | [**FieldEEzsignformfieldgroupSignerrequirement**](FieldEEzsignformfieldgroupSignerrequirement.md) | |
13+
**s_ezsignformfieldgroup_label** | **str** | The Label for the Ezsignformfieldgroup |
14+
**i_ezsignformfieldgroup_step** | **int** | The step when the Ezsignsigner will be invited to fill the form fields |
15+
**s_ezsignformfieldgroup_defaultvalue** | **str** | The default value for the Ezsignformfieldgroup | [optional]
16+
**i_ezsignformfieldgroup_filledmin** | **int** | The minimum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup |
17+
**i_ezsignformfieldgroup_filledmax** | **int** | The maximum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup |
18+
**b_ezsignformfieldgroup_readonly** | **bool** | Whether the Ezsignformfieldgroup is read only or not. |
19+
**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]
20+
**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]
21+
**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]
22+
**t_ezsignformfieldgroup_tooltip** | **str** | A tooltip that will be presented to Ezsignsigner about the Ezsignformfieldgroup | [optional]
23+
**e_ezsignformfieldgroup_tooltipposition** | [**FieldEEzsignformfieldgroupTooltipposition**](FieldEEzsignformfieldgroupTooltipposition.md) | | [optional]
24+
**e_ezsignformfieldgroup_textvalidation** | [**EnumTextvalidation**](EnumTextvalidation.md) | | [optional]
25+
**a_obj_ezsignformfieldgroupsigner** | [**List[EzsignformfieldgroupsignerRequestCompound]**](EzsignformfieldgroupsignerRequestCompound.md) | |
26+
**a_obj_dropdown_element** | [**List[CustomDropdownElementRequestCompound]**](CustomDropdownElementRequestCompound.md) | | [optional]
27+
**a_obj_ezsignformfield** | [**List[EzsignformfieldRequestCompound]**](EzsignformfieldRequestCompound.md) | |
28+
**obj_createezsignelementspositionedbyword** | [**CustomCreateEzsignelementsPositionedByWordRequest**](CustomCreateEzsignelementsPositionedByWordRequest.md) | |
29+
30+
## Example
31+
32+
```python
33+
from eZmaxApi.models.custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request import CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest
34+
35+
# TODO update the JSON string below
36+
json = "{}"
37+
# create an instance of CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest from a JSON string
38+
custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request_instance = CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.from_json(json)
39+
# print the JSON string representation of the object
40+
print CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.to_json()
41+
42+
# convert the object into a dict
43+
custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request_dict = custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request_instance.to_dict()
44+
# create an instance of CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest from a dict
45+
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)
46+
```
47+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
48+
49+

‎docs/CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest
2+
3+
An Ezsignsignature Object in the context of an CreateEzsignelementsPositionedByWord path
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**pki_ezsignsignature_id** | **int** | The unique ID of the Ezsignsignature | [optional]
10+
**fki_ezsignfoldersignerassociation_id** | **int** | The unique ID of the Ezsignfoldersignerassociation |
11+
**i_ezsignpage_pagenumber** | **int** | The page number in the Ezsigndocument |
12+
**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 \"200\" for the X coordinate. |
13+
**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 \"300\" for the Y coordinate. |
14+
**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 \"200\" for the iEzsignsignatureWidth. | [optional]
15+
**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 \"200\" for the iEzsignsignatureHeight. | [optional]
16+
**i_ezsignsignature_step** | **int** | The step when the Ezsignsigner will be invited to sign |
17+
**e_ezsignsignature_type** | [**FieldEEzsignsignatureType**](FieldEEzsignsignatureType.md) | |
18+
**fki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument |
19+
**t_ezsignsignature_tooltip** | **str** | A tooltip that will be presented to Ezsignsigner about the Ezsignsignature | [optional]
20+
**e_ezsignsignature_tooltipposition** | [**FieldEEzsignsignatureTooltipposition**](FieldEEzsignsignatureTooltipposition.md) | | [optional]
21+
**e_ezsignsignature_font** | [**FieldEEzsignsignatureFont**](FieldEEzsignsignatureFont.md) | | [optional]
22+
**fki_ezsignfoldersignerassociation_id_validation** | **int** | The unique ID of the Ezsignfoldersignerassociation | [optional]
23+
**b_ezsignsignature_required** | **bool** | Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments. | [optional]
24+
**e_ezsignsignature_attachmentnamesource** | [**FieldEEzsignsignatureAttachmentnamesource**](FieldEEzsignsignatureAttachmentnamesource.md) | | [optional]
25+
**s_ezsignsignature_attachmentdescription** | **str** | The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments | [optional]
26+
**i_ezsignsignature_validationstep** | **int** | The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments | [optional]
27+
**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]
28+
**e_ezsignsignature_textvalidation** | [**EnumTextvalidation**](EnumTextvalidation.md) | | [optional]
29+
**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]
30+
**e_ezsignsignature_dependencyrequirement** | [**FieldEEzsignsignatureDependencyrequirement**](FieldEEzsignsignatureDependencyrequirement.md) | | [optional]
31+
**b_ezsignsignature_customdate** | **bool** | Whether the Ezsignsignature has a custom date format or not. (Only possible when eEzsignsignatureType is **Name** or **Handwritten**) | [optional]
32+
**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't want to have a date at all. | [optional]
33+
**a_obj_ezsignelementdependency** | [**List[EzsignelementdependencyRequestCompound]**](EzsignelementdependencyRequestCompound.md) | | [optional]
34+
**obj_createezsignelementspositionedbyword** | [**CustomCreateEzsignelementsPositionedByWordRequest**](CustomCreateEzsignelementsPositionedByWordRequest.md) | |
35+
36+
## Example
37+
38+
```python
39+
from eZmaxApi.models.custom_ezsignsignature_create_ezsignelements_positioned_by_word_request import CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest
40+
41+
# TODO update the JSON string below
42+
json = "{}"
43+
# create an instance of CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest from a JSON string
44+
custom_ezsignsignature_create_ezsignelements_positioned_by_word_request_instance = CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.from_json(json)
45+
# print the JSON string representation of the object
46+
print CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.to_json()
47+
48+
# convert the object into a dict
49+
custom_ezsignsignature_create_ezsignelements_positioned_by_word_request_dict = custom_ezsignsignature_create_ezsignelements_positioned_by_word_request_instance.to_dict()
50+
# create an instance of CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest from a dict
51+
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)
52+
```
53+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
54+
55+

0 commit comments

Comments
 (0)