Skip to content

Commit

Permalink
Look for details in API documentation's changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
Api (Codebuild) committed Jan 15, 2025
1 parent 1900452 commit 098f458
Show file tree
Hide file tree
Showing 362 changed files with 2,246 additions and 1,422 deletions.
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.9.0
7.10.0
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ This Python package is automatically generated by the [OpenAPI Generator](https:

- API version: 1.2.1
- Package version: 1.2.1
- Generator version: 7.9.0
- Generator version: 7.10.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://www.ezmax.ca/en/contact](https://www.ezmax.ca/en/contact)

## Requirements.

Python 3.7+
Python 3.8+

## Installation & Usage
### pip install
Expand Down
2 changes: 1 addition & 1 deletion docs/ActivesessionGetCurrentV1Response.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | |
**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional]
**m_payload** | [**ActivesessionGetCurrentV1ResponseMPayload**](ActivesessionGetCurrentV1ResponseMPayload.md) | |
**m_payload** | [**ActivesessionResponseCompound**](ActivesessionResponseCompound.md) | Payload for GET /1/object/activesession/getCurrent |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/ApikeyCreateObjectV2Request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Request for POST /2/object/apikey

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**a_obj_apikey** | [**List[ApikeyRequestCompound]**](ApikeyRequestCompound.md) | |
**a_obj_apikey** | [**List[ApikeyRequestCompound]**](ApikeyRequest.md) | |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/ApikeyCreateObjectV2ResponseMPayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Payload for POST /2/object/apikey

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**a_obj_apikey** | [**List[ApikeyResponseCompound]**](ApikeyResponseCompound.md) | |
**a_obj_apikey** | [**List[ApikeyResponseCompound]**](ApikeyResponse.md) | |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/ApikeyEditObjectV1Request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Request for PUT /1/object/apikey/{pkiApikeyID}

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**obj_apikey** | [**ApikeyRequestCompound**](ApikeyRequestCompound.md) | |
**obj_apikey** | [**ApikeyRequest**](ApikeyRequest.md) | An Apikey Object and children to create a complete structure |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/ApikeyEditPermissionsV1Request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Request for PUT /1/object/apikey/{pkiApikeyID}/editPermissions

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**a_obj_permission** | [**List[PermissionRequestCompound]**](PermissionRequestCompound.md) | |
**a_obj_permission** | [**List[PermissionRequestCompound]**](PermissionRequest.md) | |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/ApikeyGetObjectV2ResponseMPayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Payload for GET /2/object/apikey/{pkiApikeyID}

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**obj_apikey** | [**ApikeyResponseCompound**](ApikeyResponseCompound.md) | |
**obj_apikey** | [**ApikeyResponse**](ApikeyResponse.md) | An Apikey Object and children to create a complete structure |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/ApikeyRegenerateV1ResponseMPayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Response for GET /1/object/apikey/{pkiApikeyID}/regenerate

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**obj_apikey** | [**ApikeyResponseCompound**](ApikeyResponseCompound.md) | |
**obj_apikey** | [**ApikeyResponse**](ApikeyResponse.md) | An Apikey Object and children to create a complete structure |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/CommonResponseErrorEzsignformValidation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**s_error_message** | **str** | The message giving details about the error |
**e_error_code** | [**FieldEErrorCode**](FieldEErrorCode.md) | |
**a_s_error_messagedetail** | **List[str]** | More error message detail | [optional]
**a_obj_ezsignformfielderror** | [**List[CustomEzsignformfielderrorResponse]**](CustomEzsignformfielderrorResponse.md) | |
**a_obj_ezsignformfielderror** | **List[CustomEzsignformfielderrorResponse]** | |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/CommonWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This is the base Webhook object
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**obj_webhook** | [**CustomWebhookResponse**](CustomWebhookResponse.md) | |
**a_obj_attempt** | [**List[AttemptResponseCompound]**](AttemptResponseCompound.md) | An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt. |
**a_obj_attempt** | [**List[AttemptResponseCompound]**](AttemptResponse.md) | An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt. |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/CommunicationRequestCompound.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Name | Type | Description | Notes
**b_communication_readreceipt** | **bool** | Whether we ask for a read receipt or not. | [optional]
**a_obj_communicationattachment** | [**List[CustomCommunicationattachmentRequest]**](CustomCommunicationattachmentRequest.md) | |
**a_obj_communicationrecipient** | [**List[CommunicationrecipientRequestCompound]**](CommunicationrecipientRequestCompound.md) | |
**a_obj_communicationreference** | [**List[CommunicationreferenceRequestCompound]**](CommunicationreferenceRequestCompound.md) | |
**a_obj_communicationreference** | [**List[CommunicationreferenceRequestCompound]**](CommunicationreferenceRequest.md) | |
**a_obj_communicationexternalrecipient** | [**List[CommunicationexternalrecipientRequestCompound]**](CommunicationexternalrecipientRequestCompound.md) | |

## Example
Expand Down
8 changes: 4 additions & 4 deletions docs/ContactinformationsRequestCompound.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Name | Type | Description | Notes
**i_phone_default** | **int** | The index in the a_objPhone array (zero based index) representing the Phone object that should become the default one. You can leave the value to 0 if the array is empty. |
**i_email_default** | **int** | The index in the a_objEmail array (zero based index) representing the Email object that should become the default one. You can leave the value to 0 if the array is empty. |
**i_website_default** | **int** | The index in the a_objWebsite array (zero based index) representing the Website object that should become the default one. You can leave the value to 0 if the array is empty. |
**a_obj_address** | [**List[AddressRequestCompound]**](AddressRequestCompound.md) | |
**a_obj_phone** | [**List[PhoneRequestCompound]**](PhoneRequestCompound.md) | |
**a_obj_email** | [**List[EmailRequestCompound]**](EmailRequestCompound.md) | |
**a_obj_website** | [**List[WebsiteRequestCompound]**](WebsiteRequestCompound.md) | |
**a_obj_address** | [**List[AddressRequestCompound]**](AddressRequest.md) | |
**a_obj_phone** | [**List[PhoneRequestCompound]**](PhoneRequest.md) | |
**a_obj_email** | [**List[EmailRequestCompound]**](EmailRequest.md) | |
**a_obj_website** | [**List[WebsiteRequestCompound]**](WebsiteRequest.md) | |

## Example

Expand Down
8 changes: 4 additions & 4 deletions docs/ContactinformationsRequestCompoundV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ Name | Type | Description | Notes
**i_phone_default** | **int** | The index in the a_objPhone array (zero based index) representing the Phone object that should become the default one. You can leave the value to 0 if the array is empty. |
**i_email_default** | **int** | The index in the a_objEmail array (zero based index) representing the Email object that should become the default one. You can leave the value to 0 if the array is empty. |
**i_website_default** | **int** | The index in the a_objWebsite array (zero based index) representing the Website object that should become the default one. You can leave the value to 0 if the array is empty. |
**a_obj_address** | [**List[AddressRequestCompound]**](AddressRequestCompound.md) | |
**a_obj_phone** | [**List[PhoneRequestCompound]**](PhoneRequestCompound.md) | |
**a_obj_email** | [**List[EmailRequestCompound]**](EmailRequestCompound.md) | |
**a_obj_website** | [**List[WebsiteRequestCompound]**](WebsiteRequestCompound.md) | |
**a_obj_address** | [**List[AddressRequestCompound]**](AddressRequest.md) | |
**a_obj_phone** | [**List[PhoneRequestCompound]**](PhoneRequest.md) | |
**a_obj_email** | [**List[EmailRequestCompound]**](EmailRequest.md) | |
**a_obj_website** | [**List[WebsiteRequestCompound]**](WebsiteRequest.md) | |

## Example

Expand Down
6 changes: 3 additions & 3 deletions docs/ContactinformationsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ Name | Type | Description | Notes
**fki_website_id_default** | **int** | The unique ID of the Website Default | [optional]
**e_contactinformations_type** | [**FieldEContactinformationsType**](FieldEContactinformationsType.md) | |
**s_contactinformations_url** | **str** | The url of the Contactinformations | [optional]
**obj_address_default** | [**AddressResponseCompound**](AddressResponseCompound.md) | | [optional]
**obj_address_default** | [**AddressResponse**](AddressResponse.md) | An Address Object and children to create a complete structure | [optional]
**obj_phone_default** | [**PhoneResponseCompound**](PhoneResponseCompound.md) | | [optional]
**obj_email_default** | [**EmailResponseCompound**](EmailResponseCompound.md) | | [optional]
**obj_website_default** | [**WebsiteResponseCompound**](WebsiteResponseCompound.md) | | [optional]
**obj_email_default** | [**EmailResponse**](EmailResponse.md) | An Email Object and children to create a complete structure | [optional]
**obj_website_default** | [**WebsiteResponse**](WebsiteResponse.md) | A Website Object and children to create a complete structure | [optional]

## Example

Expand Down
12 changes: 6 additions & 6 deletions docs/ContactinformationsResponseCompound.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ Name | Type | Description | Notes
**fki_website_id_default** | **int** | The unique ID of the Website Default | [optional]
**e_contactinformations_type** | [**FieldEContactinformationsType**](FieldEContactinformationsType.md) | |
**s_contactinformations_url** | **str** | The url of the Contactinformations | [optional]
**obj_address_default** | [**AddressResponseCompound**](AddressResponseCompound.md) | | [optional]
**obj_address_default** | [**AddressResponse**](AddressResponse.md) | An Address Object and children to create a complete structure | [optional]
**obj_phone_default** | [**PhoneResponseCompound**](PhoneResponseCompound.md) | | [optional]
**obj_email_default** | [**EmailResponseCompound**](EmailResponseCompound.md) | | [optional]
**obj_website_default** | [**WebsiteResponseCompound**](WebsiteResponseCompound.md) | | [optional]
**a_obj_address** | [**List[AddressResponseCompound]**](AddressResponseCompound.md) | |
**obj_email_default** | [**EmailResponse**](EmailResponse.md) | An Email Object and children to create a complete structure | [optional]
**obj_website_default** | [**WebsiteResponse**](WebsiteResponse.md) | A Website Object and children to create a complete structure | [optional]
**a_obj_address** | [**List[AddressResponseCompound]**](AddressResponse.md) | |
**a_obj_phone** | [**List[PhoneResponseCompound]**](PhoneResponseCompound.md) | |
**a_obj_email** | [**List[EmailResponseCompound]**](EmailResponseCompound.md) | |
**a_obj_website** | [**List[WebsiteResponseCompound]**](WebsiteResponseCompound.md) | |
**a_obj_email** | [**List[EmailResponseCompound]**](EmailResponse.md) | |
**a_obj_website** | [**List[WebsiteResponseCompound]**](WebsiteResponse.md) | |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/CustomCommunicationrecipientsrecipientResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Name | Type | Description | Notes
**fki_supplier_id** | **int** | The unique ID of the Supplier. | [optional]
**e_communicationrecipientsrecipient_objecttype** | **str** | |
**obj_contact_name** | [**CustomContactNameResponse**](CustomContactNameResponse.md) | |
**obj_email** | [**EmailResponseCompound**](EmailResponseCompound.md) | | [optional]
**obj_email** | [**EmailResponse**](EmailResponse.md) | An Email Object and children to create a complete structure | [optional]
**obj_phone_fax** | [**PhoneResponseCompound**](PhoneResponseCompound.md) | | [optional]
**obj_phone_sms** | [**PhoneResponseCompound**](PhoneResponseCompound.md) | | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/CustomCommunicationsenderResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Name | Type | Description | Notes
**fki_phonelineshared_id** | **int** | The unique ID of the Phonelineshared | [optional]
**e_communicationsender_objecttype** | **str** | |
**obj_contact_name** | [**CustomContactNameResponse**](CustomContactNameResponse.md) | |
**obj_email** | [**EmailResponseCompound**](EmailResponseCompound.md) | | [optional]
**obj_email** | [**EmailResponse**](EmailResponse.md) | An Email Object and children to create a complete structure | [optional]
**obj_phone_fax** | [**PhoneResponseCompound**](PhoneResponseCompound.md) | | [optional]
**obj_phone_sms** | [**PhoneResponseCompound**](PhoneResponseCompound.md) | | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/CustomEzsigndocumentRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Request for POST /2/object/ezsignfolder/{pkiEzsignfolderID}/reorder
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument |
**a_obj_ezsigndocumentdependency** | [**List[EzsigndocumentdependencyRequestCompound]**](EzsigndocumentdependencyRequestCompound.md) | |
**a_obj_ezsigndocumentdependency** | [**List[EzsigndocumentdependencyRequestCompound]**](EzsigndocumentdependencyRequest.md) | |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/CustomEzsignformfielderrorResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A Custom Ezsignformfield Object to contain an error list
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**s_ezsignformfield_label** | **str** | The Label for the Ezsignformfield |
**a_obj_ezsignformfielderrortest** | [**List[CustomEzsignformfielderrortestResponse]**](CustomEzsignformfielderrortestResponse.md) | |
**a_obj_ezsignformfielderrortest** | **List[CustomEzsignformfielderrortestResponse]** | |

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ Name | Type | Description | Notes
**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_ezsignformfieldgroupsigner** | [**List[EzsignformfieldgroupsignerRequestCompound]**](EzsignformfieldgroupsignerRequest.md) | |
**a_obj_dropdown_element** | [**List[CustomDropdownElementRequestCompound]**](CustomDropdownElementRequest.md) | | [optional]
**a_obj_ezsignformfield** | [**List[EzsignformfieldRequestCompound]**](EzsignformfieldRequestCompound.md) | |
**obj_createezsignelementspositionedbyword** | [**CustomCreateEzsignelementsPositionedByWordRequest**](CustomCreateEzsignelementsPositionedByWordRequest.md) | |

Expand Down
2 changes: 1 addition & 1 deletion docs/CustomEzsignformfieldgroupRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pki_ezsignformfieldgroup_id** | **int** | The unique ID of the Ezsignformfieldgroup | [optional]
**s_ezsignformfieldgroup_label** | **str** | The Label for the Ezsignformfieldgroup | [optional]
**a_obj_ezsignformfield** | [**List[CustomEzsignformfieldRequest]**](CustomEzsignformfieldRequest.md) | An array containing all the values to fill the Ezsignform. |
**a_obj_ezsignformfield** | **List[CustomEzsignformfieldRequest]** | An array containing all the values to fill the Ezsignform. |

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Name | Type | Description | Notes
**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't want to have a date at all. | [optional]
**a_obj_ezsignelementdependency** | [**List[EzsignelementdependencyRequestCompound]**](EzsignelementdependencyRequestCompound.md) | | [optional]
**a_obj_ezsignsignaturecustomdate** | [**List[EzsignsignaturecustomdateRequestCompound]**](EzsignsignaturecustomdateRequest.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]
**a_obj_ezsignelementdependency** | [**List[EzsignelementdependencyRequestCompound]**](EzsignelementdependencyRequest.md) | | [optional]
**obj_createezsignelementspositionedbyword** | [**CustomCreateEzsignelementsPositionedByWordRequest**](CustomCreateEzsignelementsPositionedByWordRequest.md) | |

## Example
Expand Down
2 changes: 1 addition & 1 deletion docs/DiscussionResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Name | Type | Description | Notes
**dt_discussion_lastread** | **str** | The date the Discussion was last read | [optional]
**i_discussionmessage_count** | **int** | The count of Attachment. |
**i_discussionmessage_countunread** | **int** | The count of Attachment. |
**obj_discussionconfiguration** | [**CustomDiscussionconfigurationResponse**](CustomDiscussionconfigurationResponse.md) | | [optional]
**obj_discussionconfiguration** | **object** | A Custom Discussionconfiguration Object | [optional]

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/DiscussionResponseCompound.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Name | Type | Description | Notes
**dt_discussion_lastread** | **str** | The date the Discussion was last read | [optional]
**i_discussionmessage_count** | **int** | The count of Attachment. |
**i_discussionmessage_countunread** | **int** | The count of Attachment. |
**obj_discussionconfiguration** | [**CustomDiscussionconfigurationResponse**](CustomDiscussionconfigurationResponse.md) | | [optional]
**obj_discussionconfiguration** | **object** | A Custom Discussionconfiguration Object | [optional]
**a_obj_discussionmembership** | [**List[DiscussionmembershipResponseCompound]**](DiscussionmembershipResponseCompound.md) | |
**a_obj_discussionmessage** | [**List[DiscussionmessageResponseCompound]**](DiscussionmessageResponseCompound.md) | |

Expand Down
2 changes: 1 addition & 1 deletion docs/DomainResponseCompound.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Name | Type | Description | Notes
**b_domain_validmailfrom** | **bool** | Whether the mail from is valid or not |
**b_domain_validcustomer** | **bool** | Whether the customer has access to it or not |
**obj_audit** | [**CommonAudit**](CommonAudit.md) | |
**a_obj_dnsrecord** | [**List[CustomDnsrecordResponse]**](CustomDnsrecordResponse.md) | |
**a_obj_dnsrecord** | **List[CustomDnsrecordResponse]** | |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/EzmaxinvoicingGetProvisionalV1Response.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | |
**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional]
**m_payload** | [**EzmaxinvoicingGetProvisionalV1ResponseMPayload**](EzmaxinvoicingGetProvisionalV1ResponseMPayload.md) | |
**m_payload** | [**EzmaxinvoicingResponseCompound**](EzmaxinvoicingResponseCompound.md) | Payload for GET /1/object/ezmaxinvoicing/getProvisional |

## Example

Expand Down
Loading

0 comments on commit 098f458

Please sign in to comment.