Look for details in API documentation's changelog

eZmaxinc · Jan 17, 2025 · 2e08581 · 2e08581
1 parent c481378
commit 2e08581
Show file tree

Hide file tree

Showing 2,288 changed files with 26,025 additions and 4,414 deletions.
diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
@@ -1 +1 @@
-7.10.0
+7.9.0
diff --git a/README.md b/README.md
@@ -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.10.0
+- Generator version: 7.9.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.8+
+Python 3.7+
 
 ## Installation & Usage
 ### pip install

diff --git a/docs/ActivesessionGenerateFederationTokenV1Response.md b/docs/ActivesessionGenerateFederationTokenV1Response.md
@@ -6,6 +6,8 @@ Response for POST /1/object/activesession/generateFederationToken
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
 **m_payload** | [**ActivesessionGenerateFederationTokenV1ResponseMPayload**](ActivesessionGenerateFederationTokenV1ResponseMPayload.md) |  | 
 
 ## Example

diff --git a/docs/ActivesessionGetCurrentV1Response.md b/docs/ActivesessionGetCurrentV1Response.md
@@ -6,7 +6,9 @@ Response for GET /1/object/activesession/getCurrent
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**m_payload** | [**ActivesessionResponseCompound**](ActivesessionResponseCompound.md) | Payload for GET /1/object/activesession/getCurrent | 
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
+**m_payload** | [**ActivesessionGetCurrentV1ResponseMPayload**](ActivesessionGetCurrentV1ResponseMPayload.md) |  | 
 
 ## Example
 

diff --git a/docs/ActivesessionGetCurrentV1ResponseMPayload.md b/docs/ActivesessionGetCurrentV1ResponseMPayload.md
@@ -6,6 +6,37 @@ Payload for GET /1/object/activesession/getCurrent
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**e_activesession_usertype** | [**FieldEActivesessionUsertype**](FieldEActivesessionUsertype.md) |  | 
+**e_activesession_origin** | [**FieldEActivesessionOrigin**](FieldEActivesessionOrigin.md) |  | 
+**e_activesession_weekdaystart** | [**FieldEActivesessionWeekdaystart**](FieldEActivesessionWeekdaystart.md) |  | 
+**fki_language_id** | **int** | The unique ID of the Language.  Valid values:  |Value|Description| |-|-| |1|French| |2|English| | 
+**s_company_name_x** | **str** | The Name of the Company in the language of the requester | 
+**s_department_name_x** | **str** | The Name of the Department in the language of the requester | 
+**b_activesession_debug** | **bool** | Whether the active session is in debug or not | 
+**b_activesession_issuperadmin** | **bool** | Whether the active session is superadmin or not | 
+**b_activesession_attachment** | **bool** | Can access attachment when we clone a user | [optional] 
+**b_activesession_canafe** | **bool** | Can access canafe when we clone a user | [optional] 
+**b_activesession_financial** | **bool** | Can access financial element when we clone a user | [optional] 
+**b_activesession_realestatecompleted** | **bool** | Can access closed realestate folders when we clone a user | [optional] 
+**e_activesession_ezsign** | [**FieldEActivesessionEzsign**](FieldEActivesessionEzsign.md) |  | [optional] 
+**e_activesession_ezsignaccess** | [**FieldEActivesessionEzsignaccess**](FieldEActivesessionEzsignaccess.md) |  | 
+**e_activesession_ezsignprepaid** | [**FieldEActivesessionEzsignprepaid**](FieldEActivesessionEzsignprepaid.md) |  | [optional] 
+**e_activesession_realestateinprogress** | [**FieldEActivesessionRealestateinprogress**](FieldEActivesessionRealestateinprogress.md) |  | [optional] 
+**pks_customer_code** | **str** | The customer code assigned to your account | 
+**fki_systemconfigurationtype_id** | **int** | The unique ID of the Systemconfigurationtype | 
+**fki_signature_id** | **int** | The unique ID of the Signature | [optional] 
+**fki_ezsignuser_id** | **int** | The unique ID of the Ezsignuser | [optional] 
+**b_systemconfiguration_ezsignpaidbyoffice** | **bool** | Whether if Ezsign is paid by the company or not | [optional] 
+**e_systemconfiguration_ezsignofficeplan** | [**FieldESystemconfigurationEzsignofficeplan**](FieldESystemconfigurationEzsignofficeplan.md) |  | [optional] 
+**e_user_ezsignaccess** | [**FieldEUserEzsignaccess**](FieldEUserEzsignaccess.md) |  | 
+**e_user_ezsignprepaid** | [**FieldEUserEzsignprepaid**](FieldEUserEzsignprepaid.md) |  | [optional] 
+**b_user_ezsigntrial** | **bool** | Whether the User&#39;s eZsign subscription is a trial | [optional] 
+**dt_user_ezsignprepaidexpiration** | **str** | The eZsign prepaid expiration date | [optional] 
+**a_pki_permission_id** | **List[int]** | An array of permissions granted to the user or api key | 
+**obj_user_real** | [**ActivesessionResponseCompoundUser**](ActivesessionResponseCompoundUser.md) |  | 
+**obj_user_cloned** | [**ActivesessionResponseCompoundUser**](ActivesessionResponseCompoundUser.md) |  | [optional] 
+**obj_apikey** | [**ActivesessionResponseCompoundApikey**](ActivesessionResponseCompoundApikey.md) |  | [optional] 
+**a_e_module_internalname** | **List[str]** | An Array of Registered modules.  These are the modules that are Licensed to be used by the User or the API Key. | 
 
 ## Example
 

diff --git a/docs/ActivesessionGetCurrentV2Response.md b/docs/ActivesessionGetCurrentV2Response.md
@@ -6,6 +6,8 @@ Response for GET /2/object/activesession/getCurrent
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
 **m_payload** | [**ActivesessionGetCurrentV2ResponseMPayload**](ActivesessionGetCurrentV2ResponseMPayload.md) |  | 
 
 ## Example

diff --git a/docs/ActivesessionGetListV1Response.md b/docs/ActivesessionGetListV1Response.md
@@ -6,6 +6,8 @@ Response for GET /1/object/activesession/getList
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
 **m_payload** | [**ActivesessionGetListV1ResponseMPayload**](ActivesessionGetListV1ResponseMPayload.md) |  | 
 
 ## Example

diff --git a/docs/ActivesessionGetListV1ResponseMPayload.md b/docs/ActivesessionGetListV1ResponseMPayload.md
@@ -6,6 +6,8 @@ Payload for GET /1/object/activesession/getList
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**i_row_returned** | **int** | The number of rows returned | 
+**i_row_filtered** | **int** | The number of rows matching your filters (if any) or the total number of rows | 
 **a_obj_activesession** | [**List[ActivesessionListElement]**](ActivesessionListElement.md) |  | 
 
 ## Example

diff --git a/docs/ActivesessionResponseCompound.md b/docs/ActivesessionResponseCompound.md
@@ -6,6 +6,25 @@ Payload for GET /1/object/activesession/getCurrent
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**e_activesession_usertype** | [**FieldEActivesessionUsertype**](FieldEActivesessionUsertype.md) |  | 
+**e_activesession_origin** | [**FieldEActivesessionOrigin**](FieldEActivesessionOrigin.md) |  | 
+**e_activesession_weekdaystart** | [**FieldEActivesessionWeekdaystart**](FieldEActivesessionWeekdaystart.md) |  | 
+**fki_language_id** | **int** | The unique ID of the Language.  Valid values:  |Value|Description| |-|-| |1|French| |2|English| | 
+**s_company_name_x** | **str** | The Name of the Company in the language of the requester | 
+**s_department_name_x** | **str** | The Name of the Department in the language of the requester | 
+**b_activesession_debug** | **bool** | Whether the active session is in debug or not | 
+**b_activesession_issuperadmin** | **bool** | Whether the active session is superadmin or not | 
+**b_activesession_attachment** | **bool** | Can access attachment when we clone a user | [optional] 
+**b_activesession_canafe** | **bool** | Can access canafe when we clone a user | [optional] 
+**b_activesession_financial** | **bool** | Can access financial element when we clone a user | [optional] 
+**b_activesession_realestatecompleted** | **bool** | Can access closed realestate folders when we clone a user | [optional] 
+**e_activesession_ezsign** | [**FieldEActivesessionEzsign**](FieldEActivesessionEzsign.md) |  | [optional] 
+**e_activesession_ezsignaccess** | [**FieldEActivesessionEzsignaccess**](FieldEActivesessionEzsignaccess.md) |  | 
+**e_activesession_ezsignprepaid** | [**FieldEActivesessionEzsignprepaid**](FieldEActivesessionEzsignprepaid.md) |  | [optional] 
+**e_activesession_realestateinprogress** | [**FieldEActivesessionRealestateinprogress**](FieldEActivesessionRealestateinprogress.md) |  | [optional] 
+**pks_customer_code** | **str** | The customer code assigned to your account | 
+**fki_systemconfigurationtype_id** | **int** | The unique ID of the Systemconfigurationtype | 
+**fki_signature_id** | **int** | The unique ID of the Signature | [optional] 
 **fki_ezsignuser_id** | **int** | The unique ID of the Ezsignuser | [optional] 
 **b_systemconfiguration_ezsignpaidbyoffice** | **bool** | Whether if Ezsign is paid by the company or not | [optional] 
 **e_systemconfiguration_ezsignofficeplan** | [**FieldESystemconfigurationEzsignofficeplan**](FieldESystemconfigurationEzsignofficeplan.md) |  | [optional] 

diff --git a/docs/ApikeyCreateObjectV2Request.md b/docs/ApikeyCreateObjectV2Request.md
@@ -6,7 +6,7 @@ Request for POST /2/object/apikey
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**a_obj_apikey** | [**List[ApikeyRequestCompound]**](ApikeyRequest.md) |  | 
+**a_obj_apikey** | [**List[ApikeyRequestCompound]**](ApikeyRequestCompound.md) |  | 
 
 ## Example
 

diff --git a/docs/ApikeyCreateObjectV2Response.md b/docs/ApikeyCreateObjectV2Response.md
@@ -6,6 +6,8 @@ Response for POST /2/object/apikey
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
 **m_payload** | [**ApikeyCreateObjectV2ResponseMPayload**](ApikeyCreateObjectV2ResponseMPayload.md) |  | 
 
 ## Example

diff --git a/docs/ApikeyCreateObjectV2ResponseMPayload.md b/docs/ApikeyCreateObjectV2ResponseMPayload.md
@@ -6,7 +6,7 @@ Payload for POST /2/object/apikey
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**a_obj_apikey** | [**List[ApikeyResponseCompound]**](ApikeyResponse.md) |  | 
+**a_obj_apikey** | [**List[ApikeyResponseCompound]**](ApikeyResponseCompound.md) |  | 
 
 ## Example
 

diff --git a/docs/ApikeyEditObjectV1Request.md b/docs/ApikeyEditObjectV1Request.md
@@ -6,7 +6,7 @@ Request for PUT /1/object/apikey/{pkiApikeyID}
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**obj_apikey** | [**ApikeyRequest**](ApikeyRequest.md) | An Apikey Object and children to create a complete structure | 
+**obj_apikey** | [**ApikeyRequestCompound**](ApikeyRequestCompound.md) |  | 
 
 ## Example
 

diff --git a/docs/ApikeyEditObjectV1Response.md b/docs/ApikeyEditObjectV1Response.md
@@ -6,6 +6,8 @@ Response for PUT /1/object/apikey/{pkiApikeyID}
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
 
 ## Example
 

diff --git a/docs/ApikeyEditPermissionsV1Request.md b/docs/ApikeyEditPermissionsV1Request.md
@@ -6,7 +6,7 @@ Request for PUT /1/object/apikey/{pkiApikeyID}/editPermissions
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**a_obj_permission** | [**List[PermissionRequestCompound]**](PermissionRequest.md) |  | 
+**a_obj_permission** | [**List[PermissionRequestCompound]**](PermissionRequestCompound.md) |  | 
 
 ## Example
 

diff --git a/docs/ApikeyEditPermissionsV1Response.md b/docs/ApikeyEditPermissionsV1Response.md
@@ -6,6 +6,8 @@ Response for PUT /1/object/apikey/{pkiApikeyID}/editPermissions
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
 **m_payload** | [**ApikeyEditPermissionsV1ResponseMPayload**](ApikeyEditPermissionsV1ResponseMPayload.md) |  | 
 
 ## Example

diff --git a/docs/ApikeyGenerateDelegatedCredentialsV1Response.md b/docs/ApikeyGenerateDelegatedCredentialsV1Response.md
@@ -6,6 +6,8 @@ Response for POST /1/object/apikey/generateDelegatedCredentials
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
 **m_payload** | [**ApikeyGenerateDelegatedCredentialsV1ResponseMPayload**](ApikeyGenerateDelegatedCredentialsV1ResponseMPayload.md) |  | 
 
 ## Example

diff --git a/docs/ApikeyGetCorsV1Response.md b/docs/ApikeyGetCorsV1Response.md
@@ -6,6 +6,8 @@ Response for GET /1/object/apikey/{pkiApikeyID}/getCors
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
 **m_payload** | [**ApikeyGetCorsV1ResponseMPayload**](ApikeyGetCorsV1ResponseMPayload.md) |  | 
 
 ## Example

diff --git a/docs/ApikeyGetListV1Response.md b/docs/ApikeyGetListV1Response.md
@@ -6,6 +6,8 @@ Response for GET /1/object/apikey/getList
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
 **m_payload** | [**ApikeyGetListV1ResponseMPayload**](ApikeyGetListV1ResponseMPayload.md) |  | 
 
 ## Example

diff --git a/docs/ApikeyGetListV1ResponseMPayload.md b/docs/ApikeyGetListV1ResponseMPayload.md
@@ -6,6 +6,8 @@ Payload for GET /1/object/apikey/getList
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**i_row_returned** | **int** | The number of rows returned | 
+**i_row_filtered** | **int** | The number of rows matching your filters (if any) or the total number of rows | 
 **a_obj_apikey** | [**List[ApikeyListElement]**](ApikeyListElement.md) |  | 
 
 ## Example

diff --git a/docs/ApikeyGetObjectV2Response.md b/docs/ApikeyGetObjectV2Response.md
@@ -6,6 +6,8 @@ Response for GET /2/object/apikey/{pkiApikeyID}
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
 **m_payload** | [**ApikeyGetObjectV2ResponseMPayload**](ApikeyGetObjectV2ResponseMPayload.md) |  | 
 
 ## Example

diff --git a/docs/ApikeyGetObjectV2ResponseMPayload.md b/docs/ApikeyGetObjectV2ResponseMPayload.md
@@ -6,7 +6,7 @@ Payload for GET /2/object/apikey/{pkiApikeyID}
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**obj_apikey** | [**ApikeyResponse**](ApikeyResponse.md) | An Apikey Object and children to create a complete structure | 
+**obj_apikey** | [**ApikeyResponseCompound**](ApikeyResponseCompound.md) |  | 
 
 ## Example
 

diff --git a/docs/ApikeyGetPermissionsV1Response.md b/docs/ApikeyGetPermissionsV1Response.md
@@ -6,6 +6,8 @@ Response for GET /1/object/apikey/{pkiApikeyID}/getPermissions
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
 **m_payload** | [**ApikeyGetPermissionsV1ResponseMPayload**](ApikeyGetPermissionsV1ResponseMPayload.md) |  | 
 
 ## Example

diff --git a/docs/ApikeyGetSubnetsV1Response.md b/docs/ApikeyGetSubnetsV1Response.md
@@ -6,6 +6,8 @@ Response for GET /1/object/apikey/{pkiApikeyID}/getSubnets
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
 **m_payload** | [**ApikeyGetSubnetsV1ResponseMPayload**](ApikeyGetSubnetsV1ResponseMPayload.md) |  | 
 
 ## Example

diff --git a/docs/ApikeyRegenerateV1Response.md b/docs/ApikeyRegenerateV1Response.md
@@ -6,6 +6,8 @@ Response for GET /1/object/apikey/{pkiApikeyID}/regenerate
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
 **m_payload** | [**ApikeyRegenerateV1ResponseMPayload**](ApikeyRegenerateV1ResponseMPayload.md) |  | 
 
 ## Example

diff --git a/docs/ApikeyRegenerateV1ResponseMPayload.md b/docs/ApikeyRegenerateV1ResponseMPayload.md
@@ -6,7 +6,7 @@ Response for GET /1/object/apikey/{pkiApikeyID}/regenerate
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**obj_apikey** | [**ApikeyResponse**](ApikeyResponse.md) | An Apikey Object and children to create a complete structure | 
+**obj_apikey** | [**ApikeyResponseCompound**](ApikeyResponseCompound.md) |  | 
 
 ## Example
 

diff --git a/docs/AttachmentGetAttachmentlogsV1Response.md b/docs/AttachmentGetAttachmentlogsV1Response.md
@@ -6,6 +6,8 @@ Response for GET /1/object/attachment/{pkiAttachmentID}/getAttachmentlogs
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
 **m_payload** | [**AttachmentGetAttachmentlogsV1ResponseMPayload**](AttachmentGetAttachmentlogsV1ResponseMPayload.md) |  | 
 
 ## Example