Look for details in API documentation's changelog

eZmaxinc · Jan 16, 2025 · edb7678 · edb7678
1 parent 4faca57
commit edb7678
Show file tree

Hide file tree

Showing 37 changed files with 367 additions and 57 deletions.
diff --git a/docs/DiscussionResponse.md b/docs/DiscussionResponse.md
@@ -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** | **object** | A Custom Discussionconfiguration Object | [optional] 
+**obj_discussionconfiguration** | [**CustomDiscussionconfigurationResponse**](CustomDiscussionconfigurationResponse.md) |  | [optional] 
 
 ## Example
 

diff --git a/docs/DiscussionResponseCompound.md b/docs/DiscussionResponseCompound.md
@@ -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** | **object** | A Custom Discussionconfiguration Object | [optional] 
+**obj_discussionconfiguration** | [**CustomDiscussionconfigurationResponse**](CustomDiscussionconfigurationResponse.md) |  | [optional] 
 **a_obj_discussionmembership** | [**List[DiscussionmembershipResponseCompound]**](DiscussionmembershipResponseCompound.md) |  | 
 **a_obj_discussionmessage** | [**List[DiscussionmessageResponseCompound]**](DiscussionmessageResponseCompound.md) |  | 
 

diff --git a/docs/EzsignfolderGetObjectV1ResponseMPayload.md b/docs/EzsignfolderGetObjectV1ResponseMPayload.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | 
 **fki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. | [optional] 
-**obj_ezsignfoldertype** | **object** | A Custom Ezsignfoldertype Object | [optional] 
+**obj_ezsignfoldertype** | [**CustomEzsignfoldertypeResponse**](CustomEzsignfoldertypeResponse.md) |  | [optional] 
 **fki_timezone_id** | **int** | The unique ID of the Timezone | [optional] 
 **e_ezsignfolder_completion** | [**FieldEEzsignfolderCompletion**](FieldEEzsignfolderCompletion.md) |  | 
 **s_ezsignfoldertype_name_x** | **str** |  | [optional] 

diff --git a/docs/EzsignfolderResponse.md b/docs/EzsignfolderResponse.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | 
 **fki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. | [optional] 
-**obj_ezsignfoldertype** | **object** | A Custom Ezsignfoldertype Object | [optional] 
+**obj_ezsignfoldertype** | [**CustomEzsignfoldertypeResponse**](CustomEzsignfoldertypeResponse.md) |  | [optional] 
 **fki_timezone_id** | **int** | The unique ID of the Timezone | [optional] 
 **e_ezsignfolder_completion** | [**FieldEEzsignfolderCompletion**](FieldEEzsignfolderCompletion.md) |  | 
 **s_ezsignfoldertype_name_x** | **str** |  | [optional] 

diff --git a/docs/EzsignfolderResponseCompound.md b/docs/EzsignfolderResponseCompound.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | 
 **fki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. | [optional] 
-**obj_ezsignfoldertype** | **object** | A Custom Ezsignfoldertype Object | [optional] 
+**obj_ezsignfoldertype** | [**CustomEzsignfoldertypeResponse**](CustomEzsignfoldertypeResponse.md) |  | [optional] 
 **fki_timezone_id** | **int** | The unique ID of the Timezone | [optional] 
 **e_ezsignfolder_completion** | [**FieldEEzsignfolderCompletion**](FieldEEzsignfolderCompletion.md) |  | 
 **s_ezsignfoldertype_name_x** | **str** |  | [optional] 

diff --git a/docs/EzsignfolderResponseCompoundV3.md b/docs/EzsignfolderResponseCompoundV3.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | 
 **fki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. | [optional] 
-**obj_ezsignfoldertype** | **object** | A Custom Ezsignfoldertype Object | [optional] 
+**obj_ezsignfoldertype** | [**CustomEzsignfoldertypeResponse**](CustomEzsignfoldertypeResponse.md) |  | [optional] 
 **fki_timezone_id** | **int** | The unique ID of the Timezone | [optional] 
 **e_ezsignfolder_completion** | [**FieldEEzsignfolderCompletion**](FieldEEzsignfolderCompletion.md) |  | 
 **e_ezsignfolder_documentdependency** | [**FieldEEzsignfolderDocumentdependency**](FieldEEzsignfolderDocumentdependency.md) |  | [optional] 

diff --git a/docs/EzsignfolderResponseV3.md b/docs/EzsignfolderResponseV3.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | 
 **fki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. | [optional] 
-**obj_ezsignfoldertype** | **object** | A Custom Ezsignfoldertype Object | [optional] 
+**obj_ezsignfoldertype** | [**CustomEzsignfoldertypeResponse**](CustomEzsignfoldertypeResponse.md) |  | [optional] 
 **fki_timezone_id** | **int** | The unique ID of the Timezone | [optional] 
 **e_ezsignfolder_completion** | [**FieldEEzsignfolderCompletion**](FieldEEzsignfolderCompletion.md) |  | 
 **e_ezsignfolder_documentdependency** | [**FieldEEzsignfolderDocumentdependency**](FieldEEzsignfolderDocumentdependency.md) |  | [optional] 

diff --git a/docs/EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1ResponseMPayload.md b/docs/EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1ResponseMPayload.md
@@ -6,7 +6,7 @@ Payload for POST /1/object/ezsigntemplatepublic/getEzsigntemplatepublicDetails
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**obj_branding** | **object** | A Custom Branding Object | [optional] 
+**obj_branding** | [**CustomBrandingResponse**](CustomBrandingResponse.md) |  | [optional] 
 **fki_userlogintype_id** | **int** | The unique ID of the Userlogintype  Valid values:  |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \&quot;In-Person\&quot; and there won&#39;t be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \&quot;In-Person\&quot; and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**| |6|**Embedded**|The Ezsignsigner will only be able to sign in the embedded solution. No email will be sent for invitation to sign. **Additional fee applies**|   |7|**Embedded with phone or SMS**|The Ezsignsigner will only be able to sign in the embedded solution and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**|   |8|**No validation**|The Ezsignsigner will not receive an email and won&#39;t have to validate his connection using 2 factor. **Additional fee applies**|      |9|**Sms only**|The Ezsignsigner will not receive an email but will will need to authenticate using SMS. **Additional fee applies**|      | 
 **a_s_ezsigntemplatesigner_description** | **List[str]** |  | 
 

diff --git a/docs/SystemconfigurationResponse.md b/docs/SystemconfigurationResponse.md
@@ -22,7 +22,7 @@ Name | Type | Description | Notes
 **b_systemconfiguration_sspr** | **bool** | Whether if we allow SSPR | 
 **dt_systemconfiguration_readonlyexpirationstart** | **str** | The start date where the system will be in read only | [optional] 
 **dt_systemconfiguration_readonlyexpirationend** | **str** | The end date where the system will be in read only | [optional] 
-**obj_branding** | **object** | A Custom Branding Object | [optional] 
+**obj_branding** | [**CustomBrandingResponse**](CustomBrandingResponse.md) |  | [optional] 
 
 ## Example
 

diff --git a/docs/SystemconfigurationResponseCompound.md b/docs/SystemconfigurationResponseCompound.md
@@ -22,7 +22,7 @@ Name | Type | Description | Notes
 **b_systemconfiguration_sspr** | **bool** | Whether if we allow SSPR | 
 **dt_systemconfiguration_readonlyexpirationstart** | **str** | The start date where the system will be in read only | [optional] 
 **dt_systemconfiguration_readonlyexpirationend** | **str** | The end date where the system will be in read only | [optional] 
-**obj_branding** | **object** | A Custom Branding Object | [optional] 
+**obj_branding** | [**CustomBrandingResponse**](CustomBrandingResponse.md) |  | [optional] 
 
 ## Example
 

diff --git a/eZmaxApi/models/discussion_response.py b/eZmaxApi/models/discussion_response.py
@@ -21,6 +21,7 @@
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
+from eZmaxApi.models.custom_discussionconfiguration_response import CustomDiscussionconfigurationResponse
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -34,7 +35,7 @@ class DiscussionResponse(BaseModel):
     dt_discussion_lastread: Optional[StrictStr] = Field(default=None, description="The date the Discussion was last read", alias="dtDiscussionLastread")
     i_discussionmessage_count: StrictInt = Field(description="The count of Attachment.", alias="iDiscussionmessageCount")
     i_discussionmessage_countunread: StrictInt = Field(description="The count of Attachment.", alias="iDiscussionmessageCountunread")
-    obj_discussionconfiguration: Optional[object] = Field(default=None, description="A Custom Discussionconfiguration Object", alias="objDiscussionconfiguration")
+    obj_discussionconfiguration: Optional[CustomDiscussionconfigurationResponse] = Field(default=None, alias="objDiscussionconfiguration")
     __properties: ClassVar[List[str]] = ["pkiDiscussionID", "sDiscussionDescription", "bDiscussionClosed", "dtDiscussionLastread", "iDiscussionmessageCount", "iDiscussionmessageCountunread", "objDiscussionconfiguration"]
 
     @field_validator('s_discussion_description')
@@ -83,6 +84,9 @@ def to_dict(self) -> Dict[str, Any]:
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of obj_discussionconfiguration
+        if self.obj_discussionconfiguration:
+            _dict['objDiscussionconfiguration'] = self.obj_discussionconfiguration.to_dict()
         return _dict
 
     @classmethod
@@ -101,7 +105,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "dtDiscussionLastread": obj.get("dtDiscussionLastread"),
             "iDiscussionmessageCount": obj.get("iDiscussionmessageCount"),
             "iDiscussionmessageCountunread": obj.get("iDiscussionmessageCountunread"),
-            "objDiscussionconfiguration": obj.get("objDiscussionconfiguration")
+            "objDiscussionconfiguration": CustomDiscussionconfigurationResponse.from_dict(obj["objDiscussionconfiguration"]) if obj.get("objDiscussionconfiguration") is not None else None
         })
         return _obj
 

diff --git a/eZmaxApi/models/discussion_response_compound.py b/eZmaxApi/models/discussion_response_compound.py
@@ -21,9 +21,9 @@
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
+from eZmaxApi.models.custom_discussionconfiguration_response import CustomDiscussionconfigurationResponse
 from eZmaxApi.models.discussionmembership_response_compound import DiscussionmembershipResponseCompound
 from eZmaxApi.models.discussionmessage_response_compound import DiscussionmessageResponseCompound
-from eZmaxApi.models.object import object
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -37,7 +37,7 @@ class DiscussionResponseCompound(BaseModel):
     dt_discussion_lastread: Optional[StrictStr] = Field(default=None, description="The date the Discussion was last read", alias="dtDiscussionLastread")
     i_discussionmessage_count: StrictInt = Field(description="The count of Attachment.", alias="iDiscussionmessageCount")
     i_discussionmessage_countunread: StrictInt = Field(description="The count of Attachment.", alias="iDiscussionmessageCountunread")
-    obj_discussionconfiguration: Optional[object] = Field(default=None, description="A Custom Discussionconfiguration Object", alias="objDiscussionconfiguration")
+    obj_discussionconfiguration: Optional[CustomDiscussionconfigurationResponse] = Field(default=None, alias="objDiscussionconfiguration")
     a_obj_discussionmembership: List[DiscussionmembershipResponseCompound] = Field(alias="a_objDiscussionmembership")
     a_obj_discussionmessage: List[DiscussionmessageResponseCompound] = Field(alias="a_objDiscussionmessage")
     __properties: ClassVar[List[str]] = ["pkiDiscussionID", "sDiscussionDescription", "bDiscussionClosed", "dtDiscussionLastread", "iDiscussionmessageCount", "iDiscussionmessageCountunread", "objDiscussionconfiguration", "a_objDiscussionmembership", "a_objDiscussionmessage"]
@@ -88,6 +88,9 @@ def to_dict(self) -> Dict[str, Any]:
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of obj_discussionconfiguration
+        if self.obj_discussionconfiguration:
+            _dict['objDiscussionconfiguration'] = self.obj_discussionconfiguration.to_dict()
         # override the default output from pydantic by calling `to_dict()` of each item in a_obj_discussionmembership (list)
         _items = []
         if self.a_obj_discussionmembership:
@@ -120,7 +123,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "dtDiscussionLastread": obj.get("dtDiscussionLastread"),
             "iDiscussionmessageCount": obj.get("iDiscussionmessageCount"),
             "iDiscussionmessageCountunread": obj.get("iDiscussionmessageCountunread"),
-            "objDiscussionconfiguration": obj.get("objDiscussionconfiguration"),
+            "objDiscussionconfiguration": CustomDiscussionconfigurationResponse.from_dict(obj["objDiscussionconfiguration"]) if obj.get("objDiscussionconfiguration") is not None else None,
             "a_objDiscussionmembership": [DiscussionmembershipResponseCompound.from_dict(_item) for _item in obj["a_objDiscussionmembership"]] if obj.get("a_objDiscussionmembership") is not None else None,
             "a_objDiscussionmessage": [DiscussionmessageResponseCompound.from_dict(_item) for _item in obj["a_objDiscussionmessage"]] if obj.get("a_objDiscussionmessage") is not None else None
         })

diff --git a/eZmaxApi/models/ezsignfolder_get_object_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_object_v1_response_m_payload.py
@@ -22,11 +22,11 @@
 from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
 from eZmaxApi.models.common_audit import CommonAudit
+from eZmaxApi.models.custom_ezsignfoldertype_response import CustomEzsignfoldertypeResponse
 from eZmaxApi.models.custom_timezone_with_code_response import CustomTimezoneWithCodeResponse
 from eZmaxApi.models.field_e_ezsignfolder_completion import FieldEEzsignfolderCompletion
 from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency
 from eZmaxApi.models.field_e_ezsignfolder_step import FieldEEzsignfolderStep
-from eZmaxApi.models.object import object
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -36,7 +36,7 @@ class EzsignfolderGetObjectV1ResponseMPayload(BaseModel):
     """ # noqa: E501
     pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="pkiEzsignfolderID")
     fki_ezsignfoldertype_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID")
-    obj_ezsignfoldertype: Optional[object] = Field(default=None, description="A Custom Ezsignfoldertype Object", alias="objEzsignfoldertype")
+    obj_ezsignfoldertype: Optional[CustomEzsignfoldertypeResponse] = Field(default=None, alias="objEzsignfoldertype")
     fki_timezone_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Timezone", alias="fkiTimezoneID")
     e_ezsignfolder_completion: FieldEEzsignfolderCompletion = Field(alias="eEzsignfolderCompletion")
     s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(default=None, alias="sEzsignfoldertypeNameX")
@@ -119,6 +119,9 @@ def to_dict(self) -> Dict[str, Any]:
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldertype
+        if self.obj_ezsignfoldertype:
+            _dict['objEzsignfoldertype'] = self.obj_ezsignfoldertype.to_dict()
         # override the default output from pydantic by calling `to_dict()` of obj_audit
         if self.obj_audit:
             _dict['objAudit'] = self.obj_audit.to_dict()
@@ -139,7 +142,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         _obj = cls.model_validate({
             "pkiEzsignfolderID": obj.get("pkiEzsignfolderID"),
             "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"),
-            "objEzsignfoldertype": obj.get("objEzsignfoldertype"),
+            "objEzsignfoldertype": CustomEzsignfoldertypeResponse.from_dict(obj["objEzsignfoldertype"]) if obj.get("objEzsignfoldertype") is not None else None,
             "fkiTimezoneID": obj.get("fkiTimezoneID"),
             "eEzsignfolderCompletion": obj.get("eEzsignfolderCompletion"),
             "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"),

diff --git a/eZmaxApi/models/ezsignfolder_response.py b/eZmaxApi/models/ezsignfolder_response.py
@@ -22,6 +22,7 @@
 from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
 from eZmaxApi.models.common_audit import CommonAudit
+from eZmaxApi.models.custom_ezsignfoldertype_response import CustomEzsignfoldertypeResponse
 from eZmaxApi.models.field_e_ezsignfolder_completion import FieldEEzsignfolderCompletion
 from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency
 from eZmaxApi.models.field_e_ezsignfolder_step import FieldEEzsignfolderStep
@@ -34,7 +35,7 @@ class EzsignfolderResponse(BaseModel):
     """ # noqa: E501
     pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="pkiEzsignfolderID")
     fki_ezsignfoldertype_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID")
-    obj_ezsignfoldertype: Optional[object] = Field(default=None, description="A Custom Ezsignfoldertype Object", alias="objEzsignfoldertype")
+    obj_ezsignfoldertype: Optional[CustomEzsignfoldertypeResponse] = Field(default=None, alias="objEzsignfoldertype")
     fki_timezone_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Timezone", alias="fkiTimezoneID")
     e_ezsignfolder_completion: FieldEEzsignfolderCompletion = Field(alias="eEzsignfolderCompletion")
     s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(default=None, alias="sEzsignfoldertypeNameX")
@@ -116,6 +117,9 @@ def to_dict(self) -> Dict[str, Any]:
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldertype
+        if self.obj_ezsignfoldertype:
+            _dict['objEzsignfoldertype'] = self.obj_ezsignfoldertype.to_dict()
         # override the default output from pydantic by calling `to_dict()` of obj_audit
         if self.obj_audit:
             _dict['objAudit'] = self.obj_audit.to_dict()
@@ -133,7 +137,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         _obj = cls.model_validate({
             "pkiEzsignfolderID": obj.get("pkiEzsignfolderID"),
             "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"),
-            "objEzsignfoldertype": obj.get("objEzsignfoldertype"),
+            "objEzsignfoldertype": CustomEzsignfoldertypeResponse.from_dict(obj["objEzsignfoldertype"]) if obj.get("objEzsignfoldertype") is not None else None,
             "fkiTimezoneID": obj.get("fkiTimezoneID"),
             "eEzsignfolderCompletion": obj.get("eEzsignfolderCompletion"),
             "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"),