You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**email** | **String** | Email of the CC participant of the agreement | [optional]
8
-
**label** | **String** | Label of the CC list as returned in workflow description | [optional]
9
7
**visiblePages** | **List<String>** | When you enable limited document visibility (documentVisibilityEnabled), you can specify which file (fileInfo) should be made visible to which specific participant set.<br>Specify one or more label values of a fileInfos element.<br>Each signer participant sets must contain at least one required signature field in at least one visible file included in this API call; if not a page with a signature field is automatically appended for any missing participant sets. If there is a possibility that one or more participant sets do not have a required signature field in the files included in the API call, all signer participant sets should include a special index value of '0' to make this automatically appended signature page visible to the signer. Not doing so may result in an error. For all other roles, you may omit this value to exclude this page. | [optional]
8
+
**label** | **String** | Label of the CC list as returned in workflow description | [optional]
9
+
**email** | **String** | Email of the CC participant of the agreement | [optional]
**groupId** | **String** | The unique identifier of the group to which the agreement belongs to. If not provided during agreement creation, primary group of the creator will be used | [optional]
8
+
**locale** | **String** | The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender | [optional]
9
+
**type** | [**TypeEnum**](#TypeEnum) | The kind of agreement | [optional]
10
+
**vaultingInfo** | [**VaultingInfo**](VaultingInfo.md) | Vaulting properties that allows Adobe Sign to securely store documents with a vault provider | [optional]
11
+
**securityOption** | [**SecurityOption**](SecurityOption.md) | Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation. | [optional]
12
+
**postSignOption** | [**PostSignOption**](PostSignOption.md) | URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation. | [optional]
7
13
**ccs** | [**List<AgreementCcInfo>**](AgreementCcInfo.md) | A list of one or more CCs that will be copied in the agreement transaction. The CCs will each receive an email at the beginning of the transaction and also when the final document is signed. The email addresses will also receive a copy of the document, attached as a PDF file. Should not be provided in offline agreement creation. | [optional]
8
-
**createdDate** | [**Date**](Date.md) | Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional]
9
-
**deviceInfo** | [**OfflineDeviceInfo**](OfflineDeviceInfo.md) | Device info of the offline device. It should only be provided in case of offline agreement creation. | [optional]
10
14
**documentVisibilityEnabled** | **Boolean** | If set to true, enable limited document visibility. Should not be provided in offline agreement creation. | [optional]
11
-
**emailOption** | [**EmailOption**](EmailOption.md) | Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement. | [optional]
12
-
**expirationTime** | [**Date**](Date.md) | Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. | [optional]
13
-
**externalId** | [**ExternalId**](ExternalId.md) | An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation. | [optional]
14
-
**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified | [optional]
15
-
**firstReminderDelay** | **Integer** | Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation. | [optional]
16
-
**formFieldLayerTemplates** | [**List<FileInfo>**](FileInfo.md) | Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified | [optional]
15
+
**isDocumentRetentionApplied** | **Boolean** | Is document retention applied for this resource. If provided in POST or PUT, it will simply be ignored. | [optional]
16
+
**hasSignerIdentityReport** | **Boolean** | True if agreement has signer identity report available. If provided in POST or PUT, it will simply be ignored. | [optional]
17
+
**lastEventDate** | [**Date**](Date.md) | The date of the last event that occurred for this agreement. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional]
18
+
**senderEmail** | **String** | Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored | [optional]
17
19
**id** | **String** | The unique identifier of the agreement.If provided in POST, it will simply be ignored | [optional]
18
-
**locale** | **String** | The locale associated with this agreement - specifies the language for the signing page and emails, for example en_US or fr_FR. If none specified, defaults to the language configured for the agreement sender | [optional]
20
+
**state** | [**StateEnum**](#StateEnum) | The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID | [optional]
19
21
**mergeFieldInfo** | [**List<MergefieldInfo>**](MergefieldInfo.md) | Optional default values for fields to merge into the document. The values will be presented to the signers for editable fields; for read-only fields the provided values will not be editable during the signing process. Merging data into fields is currently not supported when used with libraryDocumentId or libraryDocumentName. Only file and url are currently supported | [optional]
22
+
**firstReminderDelay** | **Integer** | Integer which specifies the delay in hours before sending the first reminder.<br>This is an optional field. The minimum value allowed is 1 hour and the maximum value can’t be more than the difference of agreement creation and expiry time of the agreement in hours.<br>If this is not specified but the reminder frequency is specified, then the first reminder will be sent based on frequency.<br>i.e. if the reminder is created with frequency specified as daily, the firstReminderDelay will be 24 hours. Should not be provided in offline agreement creation. | [optional]
23
+
**emailOption** | [**EmailOption**](EmailOption.md) | Email configurations for the agreement. Should not be provided in offline agreement creation or when updating a non draft agreement. | [optional]
24
+
**signatureType** | [**SignatureTypeEnum**](#SignatureTypeEnum) | Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system | [optional]
25
+
**externalId** | [**ExternalId**](ExternalId.md) | An arbitrary value from your system, which can be specified at sending time and then later returned or queried. Should not be provided in offline agreement creation. | [optional]
20
26
**message** | **String** | An optional message to the participants, describing what is being sent or why their signature is required | [optional]
21
-
**name** | **String** | The name of the agreement that will be used to identify it, in emails, website and other places | [optional]
22
-
**participantSetsInfo** | [**List<ParticipantSetInfo>**](ParticipantSetInfo.md) | A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc ), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document | [optional]
23
-
**postSignOption** | [**PostSignOption**](PostSignOption.md) | URL and associated properties for the success page the user will be taken to after completing the signing process. Should not be provided in offline agreement creation. | [optional]
27
+
**deviceInfo** | [**OfflineDeviceInfo**](OfflineDeviceInfo.md) | Device info of the offline device. It should only be provided in case of offline agreement creation. | [optional]
28
+
**parentId** | **String** | The parent id of a megaSign child *OR* the originating id of a widget agreement instance | [optional]
24
29
**reminderFrequency** | [**ReminderFrequencyEnum**](#ReminderFrequencyEnum) | Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used. Should not be provided in offline agreement creation. If provided in PUT as a different value than the current one, an error will be thrown. | [optional]
25
-
**securityOption** | [**SecurityOption**](SecurityOption.md) | Optional secondary security parameters for the agreement. Should not be provided in offline agreement creation. | [optional]
26
-
**senderEmail** | **String** | Email of agreement sender. Only provided in GET. Can not be provided in POST/PUT request. If provided in POST/PUT, it will be ignored | [optional]
27
-
**signatureType** | [**SignatureTypeEnum**](#SignatureTypeEnum) | Specifies the type of signature you would like to request - written or e-signature. The possible values are <br> ESIGN : Agreement needs to be signed electronically <br>, WRITTEN : Agreement will be signed using handwritten signature and signed document will be uploaded into the system | [optional]
28
-
**state** | [**StateEnum**](#StateEnum) | The state in which the agreement should land. The state field can only be provided in POST calls, will never get returned in GET /agreements/{ID} and will be ignored if provided in PUT /agreements/{ID} call. The eventual status of the agreement can be obtained from GET /agreements/ID | [optional]
29
-
**status** | [**StatusEnum**](#StatusEnum) | This is a server generated attribute which provides the detailed status of an agreement. | [optional]
30
-
**vaultingInfo** | [**VaultingInfo**](VaultingInfo.md) | Vaulting properties that allows Adobe Sign to securely store documents with a vault provider | [optional]
30
+
**createdDate** | [**Date**](Date.md) | Date when agreement was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional]
31
+
**participantSetsInfo** | [**List<ParticipantSetInfo>**](ParticipantSetInfo.md) | A list of one or more participant set. A participant set may have one or more participant. If any member of the participant set takes the action that has been assigned to the set(Sign/Approve/Acknowledge etc), the action is considered as the action taken by whole participation set. For regular (non-MegaSign) documents, there is no limit on the number of electronic signatures in a single document. Written signatures are limited to four per document | [optional]
32
+
**hasFormFieldData** | **Boolean** | True if form field data is present. If provided in POST or PUT, it will simply be ignored. | [optional]
33
+
**expirationTime** | [**Date**](Date.md) | Time after which Agreement expires and needs to be signed before it. Format should be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time. Should not be provided in offline agreement creation. | [optional]
34
+
**formFieldLayerTemplates** | [**List<FileInfo>**](FileInfo.md) | Specifies the form field layer template or source of form fields to apply on the files in this transaction. If specified, the FileInfo for this parameter must refer to a form field layer template via libraryDocumentId or libraryDocumentName, or if specified via transientDocumentId or documentURL, it must be of a supported file type. Note: Only one of the four parameters in every FileInfo object must be specified | [optional]
35
+
**name** | **String** | The name of the agreement that will be used to identify it, in emails, website and other places | [optional]
36
+
**fileInfos** | [**List<FileInfo>**](FileInfo.md) | A list of one or more files (or references to files) that will be sent out for signature. If more than one file is provided, they will be combined into one PDF before being sent out. Note: Only one of the four parameters in every FileInfo object must be specified | [optional]
31
37
**workflowId** | **String** | The identifier of custom workflow which defines the routing path of an agreement. Should not be provided in offline agreement creation. | [optional]
38
+
**status** | [**StatusEnum**](#StatusEnum) | This is a server generated attribute which provides the detailed status of an agreement. | [optional]
0 commit comments