-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Look for details in API documentation's changelog
- Loading branch information
Api (Codebuild)
committed
Jan 19, 2024
1 parent
099de97
commit a3acb5b
Showing
314 changed files
with
24,065 additions
and
239 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# eZmaxApi.Model.CustomCreateEzsignelementsPositionedByWordRequest | ||
A CreateEzsignelementsPositionedByWord object | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**SCreateezsignelementspositionedbywordPattern** | **string** | The word to search | | ||
**ICreateezsignelementspositionedbywordOffsetx** | **int** | The X offset | | ||
**ICreateezsignelementspositionedbywordOffsety** | **int** | The Y offset | | ||
**ECreateezsignelementspositionedbywordOccurance** | **string** | The occurance in the search to add the ezsign element | | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# eZmaxApi.Model.CustomDiscussionconfigurationResponse | ||
A Custom Discussionconfiguration Object | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**BDiscussionconfigurationCompletehistorywhenadded** | **bool** | If the added Discussionmembership will have access to the entire history or not | | ||
**BDiscussionconfigurationCreateallowed** | **bool** | If the the creation of the Discussion is allowed or not | | ||
**BDiscussionconfigurationDeleteallowed** | **bool** | If the the destruction of the Discussion is allowed or not | | ||
**BDiscussionconfigurationDeletediscussionmessageallowed** | **bool** | If the the destruction of the Discussionmessage is allowed or not | | ||
**BDiscussionconfigurationEditdiscussionmessageallowed** | **bool** | If the the creation of the Discussionmessage is allowed or not | | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes | |
**PkiEzsignformfieldID** | **int** | The unique ID of the Ezsignformfield | [optional] | ||
**SEzsignformfieldLabel** | **string** | The Label for the Ezsignformfield | [optional] | ||
**BEzsignformfieldSelected** | **bool** | Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio** | [optional] | ||
**SEzsignformfieldEnteredvalue** | **string** | This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea** | [optional] | ||
**SEzsignformfieldEnteredvalue** | **string** | 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 protected] | | {sPhoneE164} | A phone number in E.164 Format | +15149901516 | | {sPhoneE164Cell} | A phone number in E.164 Format | +15149901516 | | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
30 changes: 30 additions & 0 deletions
30
docs/CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# eZmaxApi.Model.CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest | ||
An Ezsignformfieldgroup Object in the context of a createEzsignelementsPositionedByWord path | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**PkiEzsignformfieldgroupID** | **int** | The unique ID of the Ezsignformfieldgroup | [optional] | ||
**FkiEzsigndocumentID** | **int** | The unique ID of the Ezsigndocument | | ||
**EEzsignformfieldgroupType** | **FieldEEzsignformfieldgroupType** | | | ||
**EEzsignformfieldgroupSignerrequirement** | **FieldEEzsignformfieldgroupSignerrequirement** | | | ||
**SEzsignformfieldgroupLabel** | **string** | The Label for the Ezsignformfieldgroup | | ||
**IEzsignformfieldgroupStep** | **int** | The step when the Ezsignsigner will be invited to fill the form fields | | ||
**SEzsignformfieldgroupDefaultvalue** | **string** | The default value for the Ezsignformfieldgroup | [optional] | ||
**IEzsignformfieldgroupFilledmin** | **int** | The minimum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup | | ||
**IEzsignformfieldgroupFilledmax** | **int** | The maximum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup | | ||
**BEzsignformfieldgroupReadonly** | **bool** | Whether the Ezsignformfieldgroup is read only or not. | | ||
**IEzsignformfieldgroupMaxlength** | **int** | The maximum length for the value in the Ezsignformfieldgroup This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea** | [optional] | ||
**BEzsignformfieldgroupEncrypted** | **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] | ||
**SEzsignformfieldgroupRegexp** | **string** | A regular expression to indicate what values are acceptable for the Ezsignformfieldgroup. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea** | [optional] | ||
**TEzsignformfieldgroupTooltip** | **string** | A tooltip that will be presented to Ezsignsigner about the Ezsignformfieldgroup | [optional] | ||
**EEzsignformfieldgroupTooltipposition** | **FieldEEzsignformfieldgroupTooltipposition** | | [optional] | ||
**EEzsignformfieldgroupTextvalidation** | **EnumTextvalidation** | | [optional] | ||
**AObjEzsignformfieldgroupsigner** | [**List<EzsignformfieldgroupsignerRequestCompound>**](EzsignformfieldgroupsignerRequestCompound.md) | | | ||
**AObjDropdownElement** | [**List<CustomDropdownElementRequestCompound>**](CustomDropdownElementRequestCompound.md) | | [optional] | ||
**AObjEzsignformfield** | [**List<EzsignformfieldRequestCompound>**](EzsignformfieldRequestCompound.md) | | | ||
**ObjCreateezsignelementspositionedbyword** | [**CustomCreateEzsignelementsPositionedByWordRequest**](CustomCreateEzsignelementsPositionedByWordRequest.md) | | | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
36 changes: 36 additions & 0 deletions
36
docs/CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# eZmaxApi.Model.CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest | ||
An Ezsignsignature Object in the context of an CreateEzsignelementsPositionedByWord path | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**PkiEzsignsignatureID** | **int** | The unique ID of the Ezsignsignature | [optional] | ||
**FkiEzsignfoldersignerassociationID** | **int** | The unique ID of the Ezsignfoldersignerassociation | | ||
**IEzsignpagePagenumber** | **int** | The page number in the Ezsigndocument | | ||
**IEzsignsignatureX** | **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. | | ||
**IEzsignsignatureY** | **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. | | ||
**IEzsignsignatureWidth** | **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] | ||
**IEzsignsignatureHeight** | **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] | ||
**IEzsignsignatureStep** | **int** | The step when the Ezsignsigner will be invited to sign | | ||
**EEzsignsignatureType** | **FieldEEzsignsignatureType** | | | ||
**FkiEzsigndocumentID** | **int** | The unique ID of the Ezsigndocument | | ||
**TEzsignsignatureTooltip** | **string** | A tooltip that will be presented to Ezsignsigner about the Ezsignsignature | [optional] | ||
**EEzsignsignatureTooltipposition** | **FieldEEzsignsignatureTooltipposition** | | [optional] | ||
**EEzsignsignatureFont** | **FieldEEzsignsignatureFont** | | [optional] | ||
**FkiEzsignfoldersignerassociationIDValidation** | **int** | The unique ID of the Ezsignfoldersignerassociation | [optional] | ||
**BEzsignsignatureRequired** | **bool** | Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments. | [optional] | ||
**EEzsignsignatureAttachmentnamesource** | **FieldEEzsignsignatureAttachmentnamesource** | | [optional] | ||
**SEzsignsignatureAttachmentdescription** | **string** | The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments | [optional] | ||
**IEzsignsignatureValidationstep** | **int** | The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments | [optional] | ||
**IEzsignsignatureMaxlength** | **int** | The maximum length for the value in the Ezsignsignature This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea** | [optional] | ||
**EEzsignsignatureTextvalidation** | **EnumTextvalidation** | | [optional] | ||
**SEzsignsignatureRegexp** | **string** | 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] | ||
**EEzsignsignatureDependencyrequirement** | **FieldEEzsignsignatureDependencyrequirement** | | [optional] | ||
**BEzsignsignatureCustomdate** | **bool** | Whether the Ezsignsignature has a custom date format or not. (Only possible when eEzsignsignatureType is **Name** or **Handwritten**) | [optional] | ||
**AObjEzsignsignaturecustomdate** | [**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] | ||
**AObjEzsignelementdependency** | [**List<EzsignelementdependencyRequestCompound>**](EzsignelementdependencyRequestCompound.md) | | [optional] | ||
**ObjCreateezsignelementspositionedbyword** | [**CustomCreateEzsignelementsPositionedByWordRequest**](CustomCreateEzsignelementsPositionedByWordRequest.md) | | | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# eZmaxApi.Model.DiscussionCreateObjectV1Request | ||
Request for POST /1/object/discussion | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**AObjDiscussion** | [**List<DiscussionRequestCompound>**](DiscussionRequestCompound.md) | | | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# eZmaxApi.Model.DiscussionCreateObjectV1Response | ||
Response for POST /1/object/discussion | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**ObjDebugPayload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | | ||
**ObjDebug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] | ||
**MPayload** | [**DiscussionCreateObjectV1ResponseMPayload**](DiscussionCreateObjectV1ResponseMPayload.md) | | | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# eZmaxApi.Model.DiscussionCreateObjectV1ResponseMPayload | ||
Payload for POST /1/object/discussion | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**APkiDiscussionID** | **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. | | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# eZmaxApi.Model.DiscussionDeleteObjectV1Response | ||
Response for DELETE /1/object/discussion/{pkiDiscussionID} | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**ObjDebugPayload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | | ||
**ObjDebug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# eZmaxApi.Model.DiscussionGetObjectV2Response | ||
Response for GET /2/object/discussion/{pkiDiscussionID} | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**ObjDebugPayload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | | ||
**ObjDebug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] | ||
**MPayload** | [**DiscussionGetObjectV2ResponseMPayload**](DiscussionGetObjectV2ResponseMPayload.md) | | | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# eZmaxApi.Model.DiscussionGetObjectV2ResponseMPayload | ||
Payload for GET /2/object/discussion/{pkiDiscussionID} | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**ObjDiscussion** | [**DiscussionResponseCompound**](DiscussionResponseCompound.md) | | | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# eZmaxApi.Model.DiscussionPatchObjectV1Request | ||
Request for PATCH /1/object/discussion/{pkiDiscussionID} | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**ObjDiscussion** | [**DiscussionRequestPatch**](DiscussionRequestPatch.md) | | | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# eZmaxApi.Model.DiscussionPatchObjectV1Response | ||
Response for PATCH /1/object/discussion/{pkiDiscussionID} | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**ObjDebugPayload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | | ||
**ObjDebug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# eZmaxApi.Model.DiscussionRequest | ||
A Discussion Object | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**PkiDiscussionID** | **int** | The unique ID of the Discussion | [optional] | ||
**SDiscussionDescription** | **string** | The description of the Discussion | | ||
**BDiscussionClosed** | **bool** | Whether if it's an closed | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# eZmaxApi.Model.DiscussionRequestCompound | ||
A Discussion Object and children | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**PkiDiscussionID** | **int** | The unique ID of the Discussion | [optional] | ||
**SDiscussionDescription** | **string** | The description of the Discussion | | ||
**BDiscussionClosed** | **bool** | Whether if it's an closed | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
Oops, something went wrong.