Skip to content

Commit 79b9281

Browse files
author
Api (Codebuild)
committed
Look for details in API documentation's changelog
1 parent d79e0d8 commit 79b9281

9 files changed

Lines changed: 6 additions & 17 deletions

docs/EzsignfolderRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**fki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. |
1010
**fki_ezsigntsarequirement_id** | **int** | The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**| | [optional]
1111
**s_ezsignfolder_description** | **str** | The description of the Ezsignfolder |
12-
**t_ezsignfolder_note** | **str** | Note about the Ezsignfolder |
12+
**t_ezsignfolder_note** | **str** | Note about the Ezsignfolder | [optional]
1313
**e_ezsignfolder_sendreminderfrequency** | [**FieldEEzsignfolderSendreminderfrequency**](FieldEEzsignfolderSendreminderfrequency.md) | |
1414
**s_ezsignfolder_externalid** | **str** | This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. | [optional]
1515

docs/EzsignfolderRequestCompound.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**fki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. |
1010
**fki_ezsigntsarequirement_id** | **int** | The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**| | [optional]
1111
**s_ezsignfolder_description** | **str** | The description of the Ezsignfolder |
12-
**t_ezsignfolder_note** | **str** | Note about the Ezsignfolder |
12+
**t_ezsignfolder_note** | **str** | Note about the Ezsignfolder | [optional]
1313
**e_ezsignfolder_sendreminderfrequency** | [**FieldEEzsignfolderSendreminderfrequency**](FieldEEzsignfolderSendreminderfrequency.md) | |
1414
**s_ezsignfolder_externalid** | **str** | This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. | [optional]
1515

docs/EzsignfolderSendV3Request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Request for POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send
55
## Properties
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**t_ezsignfolder_message** | **str** | A custom text message that will be added to the email sent. |
8+
**t_ezsignfolder_message** | **str** | A custom text message that will be added to the email sent. | [optional]
99
**dt_ezsignfolder_delayedsenddate** | **str** | The date and time at which the Ezsignfolder will be sent in the future. | [optional]
1010
**a_fki_ezsignfoldersignerassociation_id** | **List[int]** | |
1111

eZmaxApi/models/ezsignfolder_request.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class EzsignfolderRequest(BaseModel):
3131
fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.")
3232
fki_ezsigntsarequirement_id: Optional[conint(strict=True, le=3, ge=1)] = Field(None, alias="fkiEzsigntsarequirementID", description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|")
3333
s_ezsignfolder_description: StrictStr = Field(..., alias="sEzsignfolderDescription", description="The description of the Ezsignfolder")
34-
t_ezsignfolder_note: StrictStr = Field(..., alias="tEzsignfolderNote", description="Note about the Ezsignfolder")
34+
t_ezsignfolder_note: Optional[StrictStr] = Field(None, alias="tEzsignfolderNote", description="Note about the Ezsignfolder")
3535
e_ezsignfolder_sendreminderfrequency: FieldEEzsignfolderSendreminderfrequency = Field(..., alias="eEzsignfolderSendreminderfrequency")
3636
s_ezsignfolder_externalid: Optional[constr(strict=True)] = Field(None, alias="sEzsignfolderExternalid", description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ")
3737
__properties = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "fkiEzsigntsarequirementID", "sEzsignfolderDescription", "tEzsignfolderNote", "eEzsignfolderSendreminderfrequency", "sEzsignfolderExternalid"]

eZmaxApi/models/ezsignfolder_request_compound.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class EzsignfolderRequestCompound(BaseModel):
3131
fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.")
3232
fki_ezsigntsarequirement_id: Optional[conint(strict=True, le=3, ge=1)] = Field(None, alias="fkiEzsigntsarequirementID", description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|")
3333
s_ezsignfolder_description: StrictStr = Field(..., alias="sEzsignfolderDescription", description="The description of the Ezsignfolder")
34-
t_ezsignfolder_note: StrictStr = Field(..., alias="tEzsignfolderNote", description="Note about the Ezsignfolder")
34+
t_ezsignfolder_note: Optional[StrictStr] = Field(None, alias="tEzsignfolderNote", description="Note about the Ezsignfolder")
3535
e_ezsignfolder_sendreminderfrequency: FieldEEzsignfolderSendreminderfrequency = Field(..., alias="eEzsignfolderSendreminderfrequency")
3636
s_ezsignfolder_externalid: Optional[constr(strict=True)] = Field(None, alias="sEzsignfolderExternalid", description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ")
3737
__properties = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "fkiEzsigntsarequirementID", "sEzsignfolderDescription", "tEzsignfolderNote", "eEzsignfolderSendreminderfrequency", "sEzsignfolderExternalid"]

eZmaxApi/models/ezsignfolder_send_v3_request.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class EzsignfolderSendV3Request(BaseModel):
2626
"""
2727
Request for POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send # noqa: E501
2828
"""
29-
t_ezsignfolder_message: StrictStr = Field(..., alias="tEzsignfolderMessage", description="A custom text message that will be added to the email sent.")
29+
t_ezsignfolder_message: Optional[StrictStr] = Field(None, alias="tEzsignfolderMessage", description="A custom text message that will be added to the email sent.")
3030
dt_ezsignfolder_delayedsenddate: Optional[StrictStr] = Field(None, alias="dtEzsignfolderDelayedsenddate", description="The date and time at which the Ezsignfolder will be sent in the future.")
3131
a_fki_ezsignfoldersignerassociation_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_fkiEzsignfoldersignerassociationID")
3232
__properties = ["tEzsignfolderMessage", "dtEzsignfolderDelayedsenddate", "a_fkiEzsignfoldersignerassociationID"]

test/test_ezsignfolder_request.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ def make_instance(self, include_optional) -> EzsignfolderRequest:
4949
return EzsignfolderRequest(
5050
fki_ezsignfoldertype_id = 5,
5151
s_ezsignfolder_description = 'Test eZsign Folder',
52-
t_ezsignfolder_note = 'This is a note',
5352
e_ezsignfolder_sendreminderfrequency = 'None',
5453
)
5554
"""

test/test_ezsignfolder_request_compound.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ def make_instance(self, include_optional) -> EzsignfolderRequestCompound:
4949
return EzsignfolderRequestCompound(
5050
fki_ezsignfoldertype_id = 5,
5151
s_ezsignfolder_description = 'Test eZsign Folder',
52-
t_ezsignfolder_note = 'This is a note',
5352
e_ezsignfolder_sendreminderfrequency = 'None',
5453
)
5554
"""

test/test_ezsignfolder_send_v3_request.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,6 @@ def make_instance(self, include_optional) -> EzsignfolderSendV3Request:
5353
)
5454
else:
5555
return EzsignfolderSendV3Request(
56-
t_ezsignfolder_message = 'Hi everyone,
57-
58-
This is the document I need you to review.
59-
60-
Could you sign it before Monday please.
61-
62-
Best Regards.
63-
64-
Mary',
6556
a_fki_ezsignfoldersignerassociation_id = [
6657
20
6758
],

0 commit comments

Comments
 (0)