Look for details in API documentation's changelog

Author: Api (Codebuild)

README.md

@@ -2,7 +2,7 @@
 
 eZmax API Definition (Full)
 - API version: 1.2.1
-  - Build date: 2025-01-15T21:36:57.992386529Z[Etc/UTC]
+  - Build date: 2025-01-16T17:00:54.231192679Z[Etc/UTC]
   - Generator version: 7.10.0
 
 This API expose all the functionnalities for the eZmax and eZsign applications.

api/openapi.yaml

@@ -27350,20 +27350,25 @@ components:
       - eAttachmentDocumenttype
       type: object
     Custom-Branding-Response:
-      allOf:
-      - properties:
-          iBrandingColor:
-            $ref: '#/components/schemas/Field-iBrandingColor'
-          sBrandingLogointerfaceurl:
-            $ref: '#/components/schemas/Computed-sBrandingLogointerfaceurl'
-        required:
-        - iBrandingColor
-        - sBrandingLogointerfaceurl
-        type: object
       description: A Custom Branding Object
       example:
         iBrandingColor: 15658734
         sBrandingLogointerfaceurl: http://www.example.com/logo.jpg
+      properties:
+        iBrandingColor:
+          description: The primary color. This is a RGB color converted into integer
+          example: 15658734
+          maximum: 16777215
+          minimum: 0
+          type: integer
+        sBrandingLogointerfaceurl:
+          description: The url of the picture used as logo in the Branding
+          example: http://www.example.com/logo.jpg
+          pattern: "^(https|http):\\/\\/[^\\s\\/$.?#].[^\\s]*$"
+          type: string
+      required:
+      - iBrandingColor
+      - sBrandingLogointerfaceurl
       type: object
     Custom-CommunicationListElement-Response:
       description: A Communication List Element
@@ -27893,32 +27898,43 @@ components:
       - sCreditcardtransactionResponseterminalmessage
       type: object
     Custom-Discussionconfiguration-Response:
-      allOf:
-      - properties:
-          bDiscussionconfigurationCompletehistorywhenadded:
-            $ref: '#/components/schemas/Computed-bDiscussionconfigurationCompletehistorywhenadded'
-          bDiscussionconfigurationCreateallowed:
-            $ref: '#/components/schemas/Computed-bDiscussionconfigurationCreateallowed'
-          bDiscussionconfigurationDeleteallowed:
-            $ref: '#/components/schemas/Computed-bDiscussionconfigurationDeleteallowed'
-          bDiscussionconfigurationDeletediscussionmessageallowed:
-            $ref: '#/components/schemas/Computed-bDiscussionconfigurationDeletediscussionmessageallowed'
-          bDiscussionconfigurationEditdiscussionmessageallowed:
-            $ref: '#/components/schemas/Computed-bDiscussionconfigurationEditdiscussionmessageallowed'
-        required:
-        - bDiscussionconfigurationCompletehistorywhenadded
-        - bDiscussionconfigurationCreateallowed
-        - bDiscussionconfigurationDeleteallowed
-        - bDiscussionconfigurationDeletediscussionmessageallowed
-        - bDiscussionconfigurationEditdiscussionmessageallowed
-        type: object
       description: A Custom Discussionconfiguration Object
       example:
         bDiscussionconfigurationCreateallowed: true
         bDiscussionconfigurationDeletediscussionmessageallowed: true
         bDiscussionconfigurationDeleteallowed: true
         bDiscussionconfigurationEditdiscussionmessageallowed: true
         bDiscussionconfigurationCompletehistorywhenadded: true
+      properties:
+        bDiscussionconfigurationCompletehistorywhenadded:
+          description: If the added Discussionmembership will have access to the entire
+            history or not
+          example: true
+          type: boolean
+        bDiscussionconfigurationCreateallowed:
+          description: If the the creation of the Discussion is allowed or not
+          example: true
+          type: boolean
+        bDiscussionconfigurationDeleteallowed:
+          description: If the the destruction of the Discussion is allowed or not
+          example: true
+          type: boolean
+        bDiscussionconfigurationDeletediscussionmessageallowed:
+          description: If the the destruction of the Discussionmessage is allowed
+            or not
+          example: true
+          type: boolean
+        bDiscussionconfigurationEditdiscussionmessageallowed:
+          description: If the the creation of the Discussionmessage is allowed or
+            not
+          example: true
+          type: boolean
+      required:
+      - bDiscussionconfigurationCompletehistorywhenadded
+      - bDiscussionconfigurationCreateallowed
+      - bDiscussionconfigurationDeleteallowed
+      - bDiscussionconfigurationDeletediscussionmessageallowed
+      - bDiscussionconfigurationEditdiscussionmessageallowed
       type: object
     Custom-Dnsrecord-Response:
       allOf:
@@ -28481,45 +28497,6 @@ components:
       - sContactLastname
       type: object
     Custom-Ezsignfoldertype-Response:
-      allOf:
-      - properties:
-          pkiEzsignfoldertypeID:
-            $ref: '#/components/schemas/Field-pkiEzsignfoldertypeID'
-          fkiFontIDAnnotation:
-            $ref: '#/components/schemas/Field-pkiFontID'
-          fkiFontIDFormfield:
-            $ref: '#/components/schemas/Field-pkiFontID'
-          fkiFontIDSignature:
-            $ref: '#/components/schemas/Field-pkiFontID'
-          sEzsignfoldertypeNameX:
-            $ref: '#/components/schemas/Field-sEzsignfoldertypeNameX'
-          bEzsignfoldertypeSendproofezsignsigner:
-            $ref: '#/components/schemas/Field-bEzsignfoldertypeSendproofezsignsigner'
-          bEzsignfoldertypeAllowdownloadattachmentezsignsigner:
-            $ref: '#/components/schemas/Field-bEzsignfoldertypeAllowdownloadattachmentezsignsigner'
-          bEzsignfoldertypeAllowdownloadproofezsignsigner:
-            $ref: '#/components/schemas/Field-bEzsignfoldertypeAllowdownloadproofezsignsigner'
-          bEzsignfoldertypeAutomaticsignature:
-            $ref: '#/components/schemas/Field-bEzsignfoldertypeAutomaticsignature'
-          bEzsignfoldertypeDelegate:
-            $ref: '#/components/schemas/Field-bEzsignfoldertypeDelegate'
-          bEzsignfoldertypeDiscussion:
-            $ref: '#/components/schemas/Field-bEzsignfoldertypeDiscussion'
-          bEzsignfoldertypeReassignezsignsigner:
-            $ref: '#/components/schemas/Field-bEzsignfoldertypeReassignezsignsigner'
-          bEzsignfoldertypeReassignuser:
-            $ref: '#/components/schemas/Field-bEzsignfoldertypeReassignuser'
-          bEzsignfoldertypeReassigngroup:
-            $ref: '#/components/schemas/Field-bEzsignfoldertypeReassigngroup'
-          iEzsignfoldertypeDeadlinedays:
-            $ref: '#/components/schemas/Field-iEzsignfoldertypeDeadlinedays'
-          iEzsignfoldertypeFontsizeannotation:
-            $ref: '#/components/schemas/Field-iEzsignfoldertypeFontsizeannotation'
-          iEzsignfoldertypeFontsizeformfield:
-            $ref: '#/components/schemas/Field-iEzsignfoldertypeFontsizeformfield'
-        required:
-        - pkiEzsignfoldertypeID
-        type: object
       description: A Custom Ezsignfoldertype Object
       example:
         sEzsignfoldertypeNameX: Default
@@ -28539,6 +28516,93 @@ components:
         bEzsignfoldertypeAutomaticsignature: false
         fkiFontIDAnnotation: 1
         bEzsignfoldertypeAllowdownloadattachmentezsignsigner: false
+      properties:
+        pkiEzsignfoldertypeID:
+          description: The unique ID of the Ezsignfoldertype.
+          example: 5
+          maximum: 65535
+          minimum: 0
+          type: integer
+        fkiFontIDAnnotation:
+          description: The unique ID of the Font
+          example: 1
+          minimum: 0
+          type: integer
+        fkiFontIDFormfield:
+          description: The unique ID of the Font
+          example: 1
+          minimum: 0
+          type: integer
+        fkiFontIDSignature:
+          description: The unique ID of the Font
+          example: 1
+          minimum: 0
+          type: integer
+        sEzsignfoldertypeNameX:
+          description: The name of the Ezsignfoldertype in the language of the requester
+          example: Default
+          type: string
+        bEzsignfoldertypeSendproofezsignsigner:
+          description: Whether we send the proof in the email to Ezsignsigner
+          example: false
+          type: boolean
+        bEzsignfoldertypeAllowdownloadattachmentezsignsigner:
+          description: Whether we allow the Ezsigndocument to be downloaded by an
+            Ezsignsigner
+          example: false
+          type: boolean
+        bEzsignfoldertypeAllowdownloadproofezsignsigner:
+          description: Whether we allow the proof to be downloaded by an Ezsignsigner
+          example: false
+          type: boolean
+        bEzsignfoldertypeAutomaticsignature:
+          description: Whether we allow the automatic signature by an User
+          example: false
+          type: boolean
+        bEzsignfoldertypeDelegate:
+          description: Wheter if delegation of signature is allowed to another user
+            or not
+          example: true
+          type: boolean
+        bEzsignfoldertypeDiscussion:
+          description: Wheter if creating a new Discussion is allowed or not
+          example: true
+          type: boolean
+        bEzsignfoldertypeReassignezsignsigner:
+          description: Wheter if Reassignment of signature is allowed by a signatory
+            to another signatory or not
+          example: true
+          type: boolean
+        bEzsignfoldertypeReassignuser:
+          description: Wheter if Reassignment of signature is allowed by a user to
+            a signatory or another user or not
+          example: true
+          type: boolean
+        bEzsignfoldertypeReassigngroup:
+          description: Wheter if Reassignment of signatures of the groups to which
+            the user belongs is authorized by a user to himself
+          example: true
+          type: boolean
+        iEzsignfoldertypeDeadlinedays:
+          description: The number of days to get all Ezsignsignatures
+          example: 5
+          maximum: 60
+          minimum: 1
+          type: integer
+        iEzsignfoldertypeFontsizeannotation:
+          description: Font size for annotations
+          example: 10
+          maximum: 255
+          minimum: 1
+          type: integer
+        iEzsignfoldertypeFontsizeformfield:
+          description: Font size for form fields
+          example: 12
+          maximum: 255
+          minimum: 1
+          type: integer
+      required:
+      - pkiEzsignfoldertypeID
       type: object
     Custom-Ezsignformfield-Request:
       allOf:

docs/DiscussionResponse.md

@@ -14,7 +14,7 @@ A Discussion Object
 |**dtDiscussionLastread** | **String** | The date the Discussion was last read |  [optional] |
 |**iDiscussionmessageCount** | **Integer** | The count of Attachment. |  |
 |**iDiscussionmessageCountunread** | **Integer** | The count of Attachment. |  |
-|**objDiscussionconfiguration** | [**Object**](Object.md) | A Custom Discussionconfiguration Object |  [optional] |
+|**objDiscussionconfiguration** | [**CustomDiscussionconfigurationResponse**](CustomDiscussionconfigurationResponse.md) |  |  [optional] |
 
 
 

docs/DiscussionResponseCompound.md

@@ -14,7 +14,7 @@ A Discussion Object
 |**dtDiscussionLastread** | **String** | The date the Discussion was last read |  [optional] |
 |**iDiscussionmessageCount** | **Integer** | The count of Attachment. |  |
 |**iDiscussionmessageCountunread** | **Integer** | The count of Attachment. |  |
-|**objDiscussionconfiguration** | [**Object**](Object.md) | A Custom Discussionconfiguration Object |  [optional] |
+|**objDiscussionconfiguration** | [**CustomDiscussionconfigurationResponse**](CustomDiscussionconfigurationResponse.md) |  |  [optional] |
 |**aObjDiscussionmembership** | [**List<DiscussionmembershipResponseCompound>**](DiscussionmembershipResponseCompound.md) |  |  |
 |**aObjDiscussionmessage** | [**List<DiscussionmessageResponseCompound>**](DiscussionmessageResponseCompound.md) |  |  |
 

docs/EzsignfolderGetObjectV1ResponseMPayload.md

@@ -10,7 +10,7 @@ Payload for GET /1/object/ezsignfolder/{pkiEzsignfolderID}
 |------------ | ------------- | ------------- | -------------|
 |**pkiEzsignfolderID** | **Integer** | The unique ID of the Ezsignfolder |  |
 |**fkiEzsignfoldertypeID** | **Integer** | The unique ID of the Ezsignfoldertype. |  [optional] |
-|**objEzsignfoldertype** | [**Object**](Object.md) | A Custom Ezsignfoldertype Object |  [optional] |
+|**objEzsignfoldertype** | [**CustomEzsignfoldertypeResponse**](CustomEzsignfoldertypeResponse.md) |  |  [optional] |
 |**fkiTimezoneID** | **Integer** | The unique ID of the Timezone |  [optional] |
 |**eEzsignfolderCompletion** | **FieldEEzsignfolderCompletion** |  |  |
 |**sEzsignfoldertypeNameX** | **String** |  |  [optional] |

docs/EzsignfolderResponse.md

@@ -10,7 +10,7 @@ An Ezsignfolder Object
 |------------ | ------------- | ------------- | -------------|
 |**pkiEzsignfolderID** | **Integer** | The unique ID of the Ezsignfolder |  |
 |**fkiEzsignfoldertypeID** | **Integer** | The unique ID of the Ezsignfoldertype. |  [optional] |
-|**objEzsignfoldertype** | [**Object**](Object.md) | A Custom Ezsignfoldertype Object |  [optional] |
+|**objEzsignfoldertype** | [**CustomEzsignfoldertypeResponse**](CustomEzsignfoldertypeResponse.md) |  |  [optional] |
 |**fkiTimezoneID** | **Integer** | The unique ID of the Timezone |  [optional] |
 |**eEzsignfolderCompletion** | **FieldEEzsignfolderCompletion** |  |  |
 |**sEzsignfoldertypeNameX** | **String** |  |  [optional] |

docs/EzsignfolderResponseCompound.md

@@ -10,7 +10,7 @@ An Ezsignfolder Object and children to create a complete structure
 |------------ | ------------- | ------------- | -------------|
 |**pkiEzsignfolderID** | **Integer** | The unique ID of the Ezsignfolder |  |
 |**fkiEzsignfoldertypeID** | **Integer** | The unique ID of the Ezsignfoldertype. |  [optional] |
-|**objEzsignfoldertype** | [**Object**](Object.md) | A Custom Ezsignfoldertype Object |  [optional] |
+|**objEzsignfoldertype** | [**CustomEzsignfoldertypeResponse**](CustomEzsignfoldertypeResponse.md) |  |  [optional] |
 |**fkiTimezoneID** | **Integer** | The unique ID of the Timezone |  [optional] |
 |**eEzsignfolderCompletion** | **FieldEEzsignfolderCompletion** |  |  |
 |**sEzsignfoldertypeNameX** | **String** |  |  [optional] |

docs/EzsignfolderResponseCompoundV3.md

@@ -10,7 +10,7 @@ An Ezsignfolder Object and children to create a complete structure
 |------------ | ------------- | ------------- | -------------|
 |**pkiEzsignfolderID** | **Integer** | The unique ID of the Ezsignfolder |  |
 |**fkiEzsignfoldertypeID** | **Integer** | The unique ID of the Ezsignfoldertype. |  [optional] |
-|**objEzsignfoldertype** | [**Object**](Object.md) | A Custom Ezsignfoldertype Object |  [optional] |
+|**objEzsignfoldertype** | [**CustomEzsignfoldertypeResponse**](CustomEzsignfoldertypeResponse.md) |  |  [optional] |
 |**fkiTimezoneID** | **Integer** | The unique ID of the Timezone |  [optional] |
 |**eEzsignfolderCompletion** | **FieldEEzsignfolderCompletion** |  |  |
 |**eEzsignfolderDocumentdependency** | **FieldEEzsignfolderDocumentdependency** |  |  [optional] |

docs/EzsignfolderResponseV3.md

@@ -10,7 +10,7 @@ An Ezsignfolder Object
 |------------ | ------------- | ------------- | -------------|
 |**pkiEzsignfolderID** | **Integer** | The unique ID of the Ezsignfolder |  |
 |**fkiEzsignfoldertypeID** | **Integer** | The unique ID of the Ezsignfoldertype. |  [optional] |
-|**objEzsignfoldertype** | [**Object**](Object.md) | A Custom Ezsignfoldertype Object |  [optional] |
+|**objEzsignfoldertype** | [**CustomEzsignfoldertypeResponse**](CustomEzsignfoldertypeResponse.md) |  |  [optional] |
 |**fkiTimezoneID** | **Integer** | The unique ID of the Timezone |  [optional] |
 |**eEzsignfolderCompletion** | **FieldEEzsignfolderCompletion** |  |  |
 |**eEzsignfolderDocumentdependency** | **FieldEEzsignfolderDocumentdependency** |  |  [optional] |

docs/EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1ResponseMPayload.md

@@ -8,7 +8,7 @@ Payload for POST /1/object/ezsigntemplatepublic/getEzsigntemplatepublicDetails
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**objBranding** | [**Object**](Object.md) | A Custom Branding Object |  [optional] |
+|**objBranding** | [**CustomBrandingResponse**](CustomBrandingResponse.md) |  |  [optional] |
 |**fkiUserlogintypeID** | **Integer** | 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 \"In-Person\" and there won'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 \"In-Person\" 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'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**|      |  |
 |**aSEzsigntemplatesignerDescription** | **List<String>** |  |  |