Skip to content

Commit 2da6347

Browse files
author
Api (Codebuild)
committed
Look for details in API documentation's changelog
1 parent d7334f3 commit 2da6347

254 files changed

Lines changed: 10532 additions & 2822 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: 144 additions & 51 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 51 additions & 18 deletions
Large diffs are not rendered by default.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# AttachmentDownloadV1Response
2+
3+
Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | |
9+
**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional]
10+
11+
## Example
12+
13+
```python
14+
from eZmaxApi.models.attachment_download_v1_response import AttachmentDownloadV1Response
15+
16+
# TODO update the JSON string below
17+
json = "{}"
18+
# create an instance of AttachmentDownloadV1Response from a JSON string
19+
attachment_download_v1_response_instance = AttachmentDownloadV1Response.from_json(json)
20+
# print the JSON string representation of the object
21+
print AttachmentDownloadV1Response.to_json()
22+
23+
# convert the object into a dict
24+
attachment_download_v1_response_dict = attachment_download_v1_response_instance.to_dict()
25+
# create an instance of AttachmentDownloadV1Response from a dict
26+
attachment_download_v1_response_form_dict = attachment_download_v1_response.from_dict(attachment_download_v1_response_dict)
27+
```
28+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
29+
30+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# BuyercontractGetCommunicationListV1Response
2+
3+
Response for GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | |
9+
**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional]
10+
**m_payload** | [**BuyercontractGetCommunicationListV1ResponseMPayload**](BuyercontractGetCommunicationListV1ResponseMPayload.md) | |
11+
12+
## Example
13+
14+
```python
15+
from eZmaxApi.models.buyercontract_get_communication_list_v1_response import BuyercontractGetCommunicationListV1Response
16+
17+
# TODO update the JSON string below
18+
json = "{}"
19+
# create an instance of BuyercontractGetCommunicationListV1Response from a JSON string
20+
buyercontract_get_communication_list_v1_response_instance = BuyercontractGetCommunicationListV1Response.from_json(json)
21+
# print the JSON string representation of the object
22+
print BuyercontractGetCommunicationListV1Response.to_json()
23+
24+
# convert the object into a dict
25+
buyercontract_get_communication_list_v1_response_dict = buyercontract_get_communication_list_v1_response_instance.to_dict()
26+
# create an instance of BuyercontractGetCommunicationListV1Response from a dict
27+
buyercontract_get_communication_list_v1_response_form_dict = buyercontract_get_communication_list_v1_response.from_dict(buyercontract_get_communication_list_v1_response_dict)
28+
```
29+
[[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+
31+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# BuyercontractGetCommunicationListV1ResponseMPayload
2+
3+
Response for GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**a_obj_communication** | [**List[CustomCommunicationListElementResponse]**](CustomCommunicationListElementResponse.md) | |
9+
10+
## Example
11+
12+
```python
13+
from eZmaxApi.models.buyercontract_get_communication_list_v1_response_m_payload import BuyercontractGetCommunicationListV1ResponseMPayload
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of BuyercontractGetCommunicationListV1ResponseMPayload from a JSON string
18+
buyercontract_get_communication_list_v1_response_m_payload_instance = BuyercontractGetCommunicationListV1ResponseMPayload.from_json(json)
19+
# print the JSON string representation of the object
20+
print BuyercontractGetCommunicationListV1ResponseMPayload.to_json()
21+
22+
# convert the object into a dict
23+
buyercontract_get_communication_list_v1_response_m_payload_dict = buyercontract_get_communication_list_v1_response_m_payload_instance.to_dict()
24+
# create an instance of BuyercontractGetCommunicationListV1ResponseMPayload from a dict
25+
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)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+

docs/CommonResponseObjDebugPayloadGetList.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
1111
**b_version_deprecated** | **bool** | Wheter the current route is deprecated or not |
1212
**a_filter** | [**CommonResponseFilter**](CommonResponseFilter.md) | |
1313
**a_order_by** | **Dict[str, str]** | List of available values for *eOrderBy* |
14-
**i_row_max** | **int** | The maximum numbers of results to be returned | [default to 10000]
14+
**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's **application/vnd.openxmlformats-officedocument.spreadsheetml.sheet** the is no implicit default so if you do not specify iRowMax, all records will be returned. |
1515
**i_row_offset** | **int** | The starting element from where to start retrieving the results. For example if you started at iRowOffset=0 and asked for iRowMax=100, to get the next 100 results, you could specify iRowOffset=100&iRowMax=100, | [default to 0]
1616

1717
## Example
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# CommunicationCreateObjectV1ResponseMPayload
2+
3+
Payload for POST /1/object/communication
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**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. |
9+
10+
## Example
11+
12+
```python
13+
from eZmaxApi.models.communication_create_object_v1_response_m_payload import CommunicationCreateObjectV1ResponseMPayload
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of CommunicationCreateObjectV1ResponseMPayload from a JSON string
18+
communication_create_object_v1_response_m_payload_instance = CommunicationCreateObjectV1ResponseMPayload.from_json(json)
19+
# print the JSON string representation of the object
20+
print CommunicationCreateObjectV1ResponseMPayload.to_json()
21+
22+
# convert the object into a dict
23+
communication_create_object_v1_response_m_payload_dict = communication_create_object_v1_response_m_payload_instance.to_dict()
24+
# create an instance of CommunicationCreateObjectV1ResponseMPayload from a dict
25+
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)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+

docs/CommunicationGetObjectV2Response.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/CommunicationGetObjectV2ResponseMPayload.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

docs/CommunicationRequest.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# CommunicationRequest
2+
3+
Request for POST /1/object/communication
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**pki_communication_id** | **int** | The unique ID of the Communication. | [optional]
9+
**e_communication_importance** | [**FieldECommunicationImportance**](FieldECommunicationImportance.md) | | [optional]
10+
**e_communication_type** | [**FieldECommunicationType**](FieldECommunicationType.md) | |
11+
**obj_communicationsender** | [**CustomCommunicationsenderRequest**](CustomCommunicationsenderRequest.md) | | [optional]
12+
**s_communication_subject** | **str** | The subject of the Communication | [optional]
13+
**t_communication_body** | **str** | The Body of the Communication |
14+
**b_communication_private** | **bool** | Whether the Communication is private or not |
15+
**e_communication_attachmenttype** | **str** | How the attachment should be included in the email. Only used if eCommunicationType is **Email** | [optional]
16+
**i_communication_attachmentlinkexpiration** | **int** | The number of days before the attachment link expired. Only used if eCommunicationType is **Email** and eCommunicationattachmentType is **Link** | [optional]
17+
**b_communication_readreceipt** | **bool** | Whether we ask for a read receipt or not. | [optional]
18+
19+
## Example
20+
21+
```python
22+
from eZmaxApi.models.communication_request import CommunicationRequest
23+
24+
# TODO update the JSON string below
25+
json = "{}"
26+
# create an instance of CommunicationRequest from a JSON string
27+
communication_request_instance = CommunicationRequest.from_json(json)
28+
# print the JSON string representation of the object
29+
print CommunicationRequest.to_json()
30+
31+
# convert the object into a dict
32+
communication_request_dict = communication_request_instance.to_dict()
33+
# create an instance of CommunicationRequest from a dict
34+
communication_request_form_dict = communication_request.from_dict(communication_request_dict)
35+
```
36+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
37+
38+

0 commit comments

Comments
 (0)